@mui/internal-docs-infra
Version:
MUI Infra - internal documentation creation tools.
14 lines • 746 B
text/typescript
/**
* Extracts text content from a JSDoc description array.
*
* typescript-api-extractor returns a description as an array of JSDoc nodes when
* the comment contains `{@link}` tags: plain-text nodes carry a `text` property,
* while link nodes carry the referenced symbol in `name.escapedText`. Link nodes
* are turned into markdown via {@link renderJSDocLink}, gated on `documentedNames`.
*/
export declare function extractJSDocText(nodes: unknown[], documentedNames?: Set<string>): string;
/**
* Checks if an array looks like JSDoc description nodes from typescript-api-extractor.
* These have properties like 'pos', 'end', 'kind', 'text' from the TypeScript AST.
*/
export declare function isJSDocNodeArray(value: unknown[]): boolean;