Interface: DocModifier

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

The prose a @modifier tag contributes: a description and/or an inline deprecation replacement note.

Properties

deprecated?

optional deprecated?: string;

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

Free-text replacement guidance from an inline deprecated tag on the modifier line.

---

deprecatedCanonical?

optional deprecatedCanonical?: string;

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

The canonical modifier this one deprecates, from a {@link -canonical} in the deprecation note (e.g. @deprecated {@link -color-danger}). Stored without its leading dot, matching the AST-derived deprecated.canonical, so an authored alias and a generated one resolve to the same reference.

---

deprecatedFlag?

optional deprecatedFlag?: boolean;

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

Set when the modifier carries a bare @deprecated (no note and no canonical link).

---

description?

optional description?: string;

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