Class: CssDocTagDefinition

Defined in: packages/core/src/configuration.ts:40

One tag in the vocabulary: its name, kind, and how it may be used.

Constructors

Constructor

new CssDocTagDefinition(options): CssDocTagDefinition;

Defined in: packages/core/src/configuration.ts:51

Parameters

options

CssDocTagDefinitionOptions

Returns

CssDocTagDefinition

Properties

aliasFor?

readonly optional aliasFor?: string;

Defined in: packages/core/src/configuration.ts:49

The canonical tag name (without @) this aliases, if any; otherwise its own name.

---

allowMultiple

readonly allowMultiple: boolean;

Defined in: packages/core/src/configuration.ts:46

---

recordKind?

readonly optional recordKind?: CssRecordKind;

Defined in: packages/core/src/configuration.ts:47

---

syntaxKind

readonly syntaxKind: CssDocSyntaxKind;

Defined in: packages/core/src/configuration.ts:45

---

tagName

readonly tagName: string;

Defined in: packages/core/src/configuration.ts:42

The normalized tag name, always with a leading @ (e.g. @modifier).

---

tagNameWithoutAt

readonly tagNameWithoutAt: string;

Defined in: packages/core/src/configuration.ts:44

The tag name without its leading @ (e.g. modifier).

Accessors

canonicalName

Get Signature

get canonicalName(): string;

Defined in: packages/core/src/configuration.ts:65

The tag this definition resolves to when handled — its alias target, or itself.

Returns

string