UNPKG

673 BTypeScriptView Raw
1import { IDocNodeParameters, DocNode, DocSection } from '@microsoft/tsdoc';
2/**
3 * Constructor parameters for {@link DocNoteBox}.
4 */
5export interface IDocNoteBoxParameters extends IDocNodeParameters {
6}
7/**
8 * Represents a note box, which is typically displayed as a bordered box containing informational text.
9 */
10export declare class DocNoteBox extends DocNode {
11 readonly content: DocSection;
12 constructor(parameters: IDocNoteBoxParameters, sectionChildNodes?: ReadonlyArray<DocNode>);
13 /** @override */
14 get kind(): string;
15 /** @override */
16 protected onGetChildNodes(): ReadonlyArray<DocNode | undefined>;
17}
18//# sourceMappingURL=DocNoteBox.d.ts.map
\No newline at end of file