UNPKG

1.1 kBTypeScriptView Raw
1import { DocSection, DocNode } from '../nodes';
2/**
3 * The ParagraphSplitter is a secondary stage that runs after the NodeParser has constructed
4 * the DocComment. It splits DocParagraph nodes into multiple paragraphs by looking for
5 * paragraph delimiters. Following CommonMark conventions, paragraphs are delimited by
6 * one or more blank lines. (These lines end with SoftBreak nodes.) The blank lines are
7 * not discarded. Instead, they are attached to the preceding paragraph. If the DocParagraph
8 * starts with blank lines, they are preserved to avoid creating a paragraph containing only
9 * whitespace.
10 */
11export declare class ParagraphSplitter {
12 private static readonly _whitespaceRegExp;
13 /**
14 * Split all paragraphs belonging to the provided subtree.
15 */
16 static splitParagraphs(node: DocNode): void;
17 /**
18 * Split all paragraphs belonging to the provided DocSection.
19 */
20 static splitParagraphsForSection(docSection: DocSection): void;
21 private static _splitParagraph;
22 private static _isWhitespace;
23}
24//# sourceMappingURL=ParagraphSplitter.d.ts.map
\No newline at end of file