Function: parseDocComment()

function parseDocComment(raw, configuration?): ParsedDoc;

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

Parse a doc-comment's INNER text (already stripped of /* */ framing, or a raw block — both are handled) into a ParsedDoc. The configuration decides which tags are active and which custom tags to capture; unknown or unsupported tags are ignored, so the grammar degrades gracefully.

Parameters

raw

string

The comment text (with or without /** … */ framing).

configuration?

CssDocConfiguration = ...

The active tag configuration (defaults to the full standard vocabulary).

Returns

ParsedDoc

The structured tags.