Interface: ParsedDoc
Defined in: packages/core/src/grammar.ts:119
The structured content extracted from one doc-comment block.
Properties
accessibility?
optional accessibility?: string;Defined in: packages/core/src/grammar.ts:137
@a11y/@accessibility — accessibility guidance.
animations
animations: Map<string, string>;Defined in: packages/core/src/grammar.ts:181
@keyframes/@animation descriptions, keyed by animation name.
annotations
annotations: Map<number, string>;Defined in: packages/core/src/grammar.ts:203
Parsed @annotations legend rows, keyed by numeric reference index.
className?
optional className?: string;Defined in: packages/core/src/grammar.ts:125
@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:209
@compat browser-support / feature-compatibility notes.
component?
optional component?: string;Defined in: packages/core/src/grammar.ts:121
@component/@utility/@rule/@declaration/@name — the record name. Marks a record boundary.
conditions
conditions: DocCondition[];Defined in: packages/core/src/grammar.ts:185
@container/@supports/@media/@responsive authored conditions.
cssParts
cssParts: Map<string, string>;Defined in: packages/core/src/grammar.ts:158
@csspart descriptions (shadow-DOM ::part()), keyed by the bare part name (e.g. header).
cssProperties
cssProperties: DocCssProperty[];Defined in: packages/core/src/grammar.ts:171
@cssproperty declarations.
cssStates
cssStates: Map<string, string>;Defined in: packages/core/src/grammar.ts:173
@cssstate descriptions, keyed by state name.
customBlocks
customBlocks: Map<string, string[]>;Defined in: packages/core/src/grammar.ts:221
Content of registered custom (block) tags, keyed by tag name without its @.
decorators
decorators: DocDecorators;Defined in: packages/core/src/grammar.ts:207
Record-level object-model decorators.
demo?
optional demo?: string;Defined in: packages/core/src/grammar.ts:197
@demo <spec>.
deprecated?
optional deprecated?: string;Defined in: packages/core/src/grammar.ts:195
The <replacement> argument from a @deprecated tag.
elements
elements: Map<string, string[]>;Defined in: packages/core/src/grammar.ts:177
Raw @element declarations keyed by profile ("" for default), in author order.
examples
examples: string[];Defined in: packages/core/src/grammar.ts:187
@example blocks.
functions
functions: Map<string, string>;Defined in: packages/core/src/grammar.ts:179
@function descriptions, keyed by function name (e.g. --negate).
global?
optional global?: boolean;Defined in: packages/core/src/grammar.ts:219
Set by a record-level @global tag — modifiers of this record apply to any other component/layout/rule/declaration.
group?
optional group?: string;Defined in: packages/core/src/grammar.ts:135
@group/@category — a documentation group.
kind?
optional kind?: CssRecordKind;Defined in: packages/core/src/grammar.ts:123
The record kind chosen by the opening tag (component unless @utility/@rule/@declaration).
layers
layers: Map<string, string>;Defined in: packages/core/src/grammar.ts:183
@layer descriptions, keyed by layer name.
memberEntries
memberEntries: object[];Defined in: packages/core/src/grammar.ts:217
Repeatable @member <name> [private] declarations on the parent record.
name
name: string;private
private: boolean;memberOf?
optional memberOf?: object;Defined in: packages/core/src/grammar.ts:213
@memberOf <component> [private], when authored.
component
component: string;private
private: boolean;members?
optional members?: string[];Defined in: packages/core/src/grammar.ts:215
@members <name>, <name>, … — the inverse direction, when authored.
modifiers
modifiers: Map<string, DocModifier>;Defined in: packages/core/src/grammar.ts:141
@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:146
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:148
@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:154
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?
optional privateRemarks?: string;Defined in: packages/core/src/grammar.ts:131
@privateRemarks — internal-only prose.
pseudoElements
pseudoElements: Map<string, string>;Defined in: packages/core/src/grammar.ts:160
@pseudo descriptions (native pseudo-elements), keyed by the bare name (e.g. before).
refs
refs: number[];Defined in: packages/core/src/grammar.ts:205
Parsed @ref values in author order.
related
related: CssRelated[];Defined in: packages/core/src/grammar.ts:211
@related component cross-references.
releaseStage?
optional releaseStage?: CssReleaseStage;Defined in: packages/core/src/grammar.ts:139
The release stage from a modifier flag tag (@alpha/@beta/…).
remarks?
optional remarks?: string;Defined in: packages/core/src/grammar.ts:129
@remarks — extended prose.
see
see: string[];Defined in: packages/core/src/grammar.ts:199
@see <ref> entries.
since?
optional since?: string;Defined in: packages/core/src/grammar.ts:133
@since — version introduced.
slots
slots: Map<string, string>;Defined in: packages/core/src/grammar.ts:175
@slot descriptions, keyed by slot name (empty string for the default slot).
structure?
optional structure?: StructureNode[];Defined in: packages/core/src/grammar.ts:189
@structure — the nested-CSS body, parsed into a selector tree by parseStructure.
structureDescription?
optional structureDescription?: string;Defined in: packages/core/src/grammar.ts:193
An optional prose description leading the @structure body.
structureVariants?
optional structureVariants?: StructureVariant[];Defined in: packages/core/src/grammar.ts:191
Alternative DOM shapes from top-level @variant blocks in @structure, when authored.
summary?
optional summary?: string;Defined in: packages/core/src/grammar.ts:127
@summary — one-line intro.
todos
todos: string[];Defined in: packages/core/src/grammar.ts:169
@todo notes (internal development notes).
tokens
tokens: Map<string, string>;Defined in: packages/core/src/grammar.ts:156
@tokens descriptions, keyed by custom-property name (e.g. --color-primary).
usage?
optional usage?: string;Defined in: packages/core/src/grammar.ts:201
@usage prose — how to include the stylesheet / use the component.
wrappers
wrappers: Map<string, string>;Defined in: packages/core/src/grammar.ts:162
@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:167
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.