Interface: ParsedDoc

Defined in: packages/core/src/grammar.ts:74

The structured content extracted from one doc-comment block.

Properties

accessibility?

optional accessibility?: string;

Defined in: packages/core/src/grammar.ts:92

@a11y/@accessibility — accessibility guidance.

---

animations

animations: Map<string, string>;

Defined in: packages/core/src/grammar.ts:108

@keyframes/@animation descriptions, keyed by animation name.

---

className?

optional className?: string;

Defined in: packages/core/src/grammar.ts:80

@class — an explicit base class selector (otherwise inferred from the CSS).

---

component?

optional component?: string;

Defined in: packages/core/src/grammar.ts:76

@component/@utility/@rule/@declaration/@name — the record name. Marks a record boundary.

---

conditions

conditions: DocCondition[];

Defined in: packages/core/src/grammar.ts:112

@container/@supports/@media/@responsive authored conditions.

---

cssProperties

cssProperties: DocCssProperty[];

Defined in: packages/core/src/grammar.ts:100

@cssproperty declarations.

---

cssStates

cssStates: Map<string, string>;

Defined in: packages/core/src/grammar.ts:102

@cssstate descriptions, keyed by state name.

---

customBlocks

customBlocks: Map<string, string[]>;

Defined in: packages/core/src/grammar.ts:124

Content of registered custom (block) tags, keyed by tag name without its @.

---

demo?

optional demo?: string;

Defined in: packages/core/src/grammar.ts:120

@demo <spec>.

---

deprecated?

optional deprecated?: string;

Defined in: packages/core/src/grammar.ts:118

The <replacement> argument from a @deprecated tag.

---

examples

examples: string[];

Defined in: packages/core/src/grammar.ts:114

@example blocks.

---

functions

functions: Map<string, string>;

Defined in: packages/core/src/grammar.ts:106

@function descriptions, keyed by function name (e.g. --negate).

---

group?

optional group?: string;

Defined in: packages/core/src/grammar.ts:90

@group/@category — a documentation group.

---

kind?

optional kind?: CssRecordKind;

Defined in: packages/core/src/grammar.ts:78

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:110

@layer descriptions, keyed by layer name.

---

modifiers

modifiers: Map<string, DocModifier>;

Defined in: packages/core/src/grammar.ts:96

@modifier prose, keyed by the modifier class without its dot (e.g. -color-secondary).

---

parts

parts: Map<string, string>;

Defined in: packages/core/src/grammar.ts:98

@part/@csspart descriptions, keyed by the part name without its dot (e.g. item).

---

privateRemarks?

optional privateRemarks?: string;

Defined in: packages/core/src/grammar.ts:86

@privateRemarks — internal-only prose.

---

releaseStage?

optional releaseStage?: CssReleaseStage;

Defined in: packages/core/src/grammar.ts:94

The release stage from a modifier flag tag (@alpha/@beta/…).

---

remarks?

optional remarks?: string;

Defined in: packages/core/src/grammar.ts:84

@remarks — extended prose.

---

see

see: string[];

Defined in: packages/core/src/grammar.ts:122

@see <ref> entries.

---

since?

optional since?: string;

Defined in: packages/core/src/grammar.ts:88

@since — version introduced.

---

slots

slots: Map<string, string>;

Defined in: packages/core/src/grammar.ts:104

@slot descriptions, keyed by slot name (empty string for the default slot).

---

structure?

optional structure?: StructureNode[];

Defined in: packages/core/src/grammar.ts:116

@structure — the raw (indented) HTML-tree body, parsed into nodes by parseStructure.

---

summary?

optional summary?: string;

Defined in: packages/core/src/grammar.ts:82

@summary — one-line intro.