Interface: ParseOptions
Defined in: packages/core/src/model.ts:196
Options for parseCssDocs.
Properties
configuration?
ts
optional configuration?: CssDocConfiguration;Defined in: packages/core/src/model.ts:208
The tag configuration (standard + custom tags, and which are supported). Defaults to a fresh CssDocConfiguration with every standard tag enabled — i.e. the full built-in vocabulary. Supply one (e.g. from @cssdoc/config) to register custom tags or disable standard ones.
isRecordBoundary?
ts
optional isRecordBoundary?: (commentText) => string | undefined;Defined in: packages/core/src/model.ts:202
How records are delimited. By default a new record begins at any doc comment (/** … */) that carries an @component or @name tag, which is the recommended, framework-agnostic convention. Supply a custom test to split on something else (e.g. a per-component header comment).
Parameters
commentText
string
Returns
string | undefined