Interface: ParsedDoc
Defined in: packages/core/src/grammar.ts:126
The structured content extracted from one doc-comment block.
Properties
accessibility?
accessibility?: string;Defined in: packages/core/src/grammar.ts:151
@a11y/@accessibility — accessibility guidance.
animations
animations: Map<string, string>;Defined in: packages/core/src/grammar.ts:197
@keyframes/@animation descriptions, keyed by animation name.
annotations
annotations: Map<number, string>;Defined in: packages/core/src/grammar.ts:220
Parsed @annotations legend rows, keyed by numeric reference index.
className?
className?: string;Defined in: packages/core/src/grammar.ts:132
@selector / @class — an explicit base CSS selector (any valid simple selector; otherwise inferred from the CSS).
compat
compat: string[];Defined in: packages/core/src/grammar.ts:226
@compat browser-support / feature-compatibility notes.
component?
component?: string;Defined in: packages/core/src/grammar.ts:128
A record-opening tag's canonical name. Marks a record boundary.
conditions
conditions: DocCondition[];Defined in: packages/core/src/grammar.ts:201
@container/@supports/@media/@responsive authored conditions.
cssParts
cssParts: Map<string, string>;Defined in: packages/core/src/grammar.ts:174
@csspart descriptions (shadow-DOM ::part()), keyed by the bare part name (e.g. header).
cssProperties
cssProperties: DocCssProperty[];Defined in: packages/core/src/grammar.ts:187
@cssproperty declarations.
cssStates
cssStates: Map<string, string>;Defined in: packages/core/src/grammar.ts:189
@cssstate descriptions, keyed by state name.
customBlocks
customBlocks: Map<string, string[]>;Defined in: packages/core/src/grammar.ts:238
Content of registered custom (block) tags, keyed by tag name without its @.
decorators
decorators: DocDecorators;Defined in: packages/core/src/grammar.ts:224
Record-level object-model decorators.
demo?
demo?: string;Defined in: packages/core/src/grammar.ts:214
@demo <spec>.
deprecated?
deprecated?: string;Defined in: packages/core/src/grammar.ts:212
The <replacement> argument from a @deprecated tag.
elements
elements: Map<string, string[]>;Defined in: packages/core/src/grammar.ts:193
Raw @element declarations keyed by profile ("" for default), in author order.
exampleLabels?
exampleLabels?: Record<number, readonly string[]>;Defined in: packages/core/src/grammar.ts:204
examples
examples: string[];Defined in: packages/core/src/grammar.ts:203
@example blocks.
fullSelector?
fullSelector?: string;Defined in: packages/core/src/grammar.ts:139
The full, untruncated @selector text as authored, before className truncates it to its leading token (e.g. .pfx-list > li stays whole here even though className becomes .pfx-list). Lets callers detect when an authored @selector names a descendant compound rather than a plain base selector, without changing what className resolves to elsewhere.
functions
functions: Map<string, string>;Defined in: packages/core/src/grammar.ts:195
@function descriptions, keyed by function name (e.g. --negate).
global?
global?: boolean;Defined in: packages/core/src/grammar.ts:236
Set by a record-level @global tag — modifiers of this record apply to any other component/layout/rule/declaration.
group?
group?: string;Defined in: packages/core/src/grammar.ts:149
@group/@category — a documentation group.
kind?
kind?: CssRecordKind;Defined in: packages/core/src/grammar.ts:130
The record kind chosen by the opening tag (@rule is a compatibility alias for @component).
layers
layers: Map<string, string>;Defined in: packages/core/src/grammar.ts:199
@layer descriptions, keyed by layer name.
memberEntries
memberEntries: object[];Defined in: packages/core/src/grammar.ts:234
Repeatable @member <name> [private] declarations on the parent record.
name
name: string;private
private: boolean;memberOf?
memberOf?: object;Defined in: packages/core/src/grammar.ts:230
@memberOf <component> [private], when authored.
component
component: string;private
private: boolean;members?
members?: string[];Defined in: packages/core/src/grammar.ts:232
@members <name>, <name>, … — the inverse direction, when authored.
modifiers
modifiers: Map<string, DocModifier>;Defined in: packages/core/src/grammar.ts:157
@modifier prose, keyed by the derived modifier name (e.g. -color-secondary, data-variant="ghost").
modifierSelectors
modifierSelectors: Map<string, string>;Defined in: packages/core/src/grammar.ts:162
The original CSS selector for each @modifier, keyed by the derived name. Set only for non-class modifiers (attribute, ID, :host). Class modifiers omit the entry.
parts
parts: Map<string, string>;Defined in: packages/core/src/grammar.ts:164
@part descriptions, keyed by the derived part name (e.g. item, data-layout).
partSelectors
partSelectors: Map<string, string>;Defined in: packages/core/src/grammar.ts:170
The original CSS selector for each @part, keyed by the derived name. Set only for non-class parts (attribute, ID, :host). Class parts omit the entry; callers reconstruct the selector as .${name} when absent.
privateRemarks?
privateRemarks?: string;Defined in: packages/core/src/grammar.ts:145
@privateRemarks — internal-only prose.
pseudoElements
pseudoElements: Map<string, string>;Defined in: packages/core/src/grammar.ts:176
@pseudo descriptions (native pseudo-elements), keyed by the bare name (e.g. before).
refs
refs: number[];Defined in: packages/core/src/grammar.ts:222
Parsed @ref values in author order.
related
related: CssRelated[];Defined in: packages/core/src/grammar.ts:228
@related component cross-references.
releaseStage?
releaseStage?: CssReleaseStage;Defined in: packages/core/src/grammar.ts:153
Release maturity from @stage or a legacy maturity flag tag.
remarks?
remarks?: string;Defined in: packages/core/src/grammar.ts:143
@remarks — extended prose.
see
see: string[];Defined in: packages/core/src/grammar.ts:216
@see <ref> entries.
since?
since?: string;Defined in: packages/core/src/grammar.ts:147
@since — version introduced.
slots
slots: Map<string, string>;Defined in: packages/core/src/grammar.ts:191
@slot descriptions, keyed by slot name (empty string for the default slot).
structure?
structure?: StructureNode[];Defined in: packages/core/src/grammar.ts:206
@structure — the nested-CSS body, parsed into a selector tree by parseStructure.
structureDescription?
structureDescription?: string;Defined in: packages/core/src/grammar.ts:210
An optional prose description leading the @structure body.
structureVariants?
structureVariants?: StructureVariant[];Defined in: packages/core/src/grammar.ts:208
Alternative DOM shapes from top-level @variant blocks in @structure, when authored.
summary?
summary?: string;Defined in: packages/core/src/grammar.ts:141
@summary — one-line intro.
todos
todos: string[];Defined in: packages/core/src/grammar.ts:185
@todo notes (internal development notes).
tokens
tokens: Map<string, string>;Defined in: packages/core/src/grammar.ts:172
@tokens descriptions, keyed by custom-property name (e.g. --color-primary).
usage?
usage?: string;Defined in: packages/core/src/grammar.ts:218
@usage prose — how to include the stylesheet / use the component.
visibility?
visibility?: CssVisibility;Defined in: packages/core/src/grammar.ts:155
Audience visibility from @visibility or a legacy visibility flag tag.
wrappers
wrappers: Map<string, string>;Defined in: packages/core/src/grammar.ts:178
@wrapper descriptions, keyed by the derived selector name (e.g. badge-wrapper, data-slot).
wrapperSelectors
wrapperSelectors: Map<string, string>;Defined in: packages/core/src/grammar.ts:183
The original CSS selector for each @wrapper, keyed by the derived name. Set only for non-class wrappers (attribute, ID, :host). Class wrappers omit the entry.