The custom element tag name to document.
Optional output configuration (DocGenOptions).
The TSDoc configuration used for parsing and rendering documentation.
ReadonlytagThe TSDoc parser used for parsing documentation comments.
StaticCUSTOM_TSDoc tag definition for demo blocks. This custom block tag allows marking code sections as demos in the documentation.
StaticWEB_TSDoc tag definitions for the web-component documentation tags
(@slot, @csspart, @cssprop, @fires). Registering them as block
tags keeps their text out of the summary section — their content is
rendered in the API reference tables from the manifest instead.
The component module src used in the generated page (configurable via options).
Produces a complete documentation page for a component: the TSDoc summary
and @demo blocks combined with a full API reference (attributes,
properties, events, slots, CSS parts and CSS custom properties) derived
from the Custom Elements Manifest.
Path to the TypeScript source file to document
Optionaldeclaration: CustomElementDeclarationOptional pre-built manifest declaration; pass it when one is already available (e.g. when documenting a whole library) to avoid re-running the manifest analysis for this file
A complete HTML document as a string
Builds the Custom Elements Manifest declaration for a source file, preferring the one whose tag name matches this generator's tag.
Path to the TypeScript source file
The matching declaration, or undefined if none is found
Parses a TypeScript source file to extract its documentation.
The path to the TypeScript source file to parse
A Promise that resolves to a ParserContext containing the parsed documentation
Renders a parsed documentation context to a standalone HTML doc page.
The page includes the summary description, any @demo blocks (shown both
live and as source), and documented @param attributes.
The parsed documentation context to render
Optionaldeclaration: CustomElementDeclarationA complete HTML document as a string
A class for parsing and rendering TSDoc documentation comments. Provides functionality to parse TypeScript source files and extract their documentation, as well as render the documentation in a formatted way.