@microsoft/api-documenter
Version:
Read JSON files from api-extractor, generate documentation pages
18 lines • 678 B
TypeScript
import { type IDocNodeParameters, DocNode, DocSection } from '@microsoft/tsdoc';
/**
* Constructor parameters for {@link DocNoteBox}.
*/
export interface IDocNoteBoxParameters extends IDocNodeParameters {
}
/**
* Represents a note box, which is typically displayed as a bordered box containing informational text.
*/
export declare class DocNoteBox extends DocNode {
readonly content: DocSection;
constructor(parameters: IDocNoteBoxParameters, sectionChildNodes?: ReadonlyArray<DocNode>);
/** @override */
get kind(): string;
/** @override */
protected onGetChildNodes(): ReadonlyArray<DocNode | undefined>;
}
//# sourceMappingURL=DocNoteBox.d.ts.map