UNPKG

1.19 kBTypeScriptView Raw
1import { DocNode, DocNodeKind } from './DocNode';
2import { DocNodeContainer, IDocNodeContainerParameters, IDocNodeContainerParsedParameters } from './DocNodeContainer';
3/**
4 * Constructor parameters for {@link DocSection}.
5 */
6export interface IDocSectionParameters extends IDocNodeContainerParameters {
7}
8/**
9 * Constructor parameters for {@link DocSection}.
10 */
11export interface IDocSectionParsedParameters extends IDocNodeContainerParsedParameters {
12}
13/**
14 * Represents a general block of rich text.
15 */
16export declare class DocSection extends DocNodeContainer {
17 /**
18 * Don't call this directly. Instead use {@link TSDocParser}
19 * @internal
20 */
21 constructor(parameters: IDocSectionParameters | IDocSectionParsedParameters, childNodes?: ReadonlyArray<DocNode>);
22 /** @override */
23 get kind(): DocNodeKind | string;
24 /**
25 * If the last item in DocSection.nodes is not a DocParagraph, a new paragraph
26 * is started. Either way, the provided docNode will be appended to the paragraph.
27 */
28 appendNodeInParagraph(docNode: DocNode): void;
29 appendNodesInParagraph(docNodes: ReadonlyArray<DocNode>): void;
30}
31//# sourceMappingURL=DocSection.d.ts.map
\No newline at end of file