| 1 | import { DocNode } from '../nodes';
|
| 2 | /**
|
| 3 | * Renders a DocNode tree as plain text, without any rich text formatting or markup.
|
| 4 | */
|
| 5 | export declare class PlainTextEmitter {
|
| 6 | /**
|
| 7 | * Returns true if the specified node contains any text content.
|
| 8 | *
|
| 9 | * @remarks
|
| 10 | * A documentation tool can use this test to report warnings when a developer neglected to write a code comment
|
| 11 | * for a declaration.
|
| 12 | *
|
| 13 | * @param node - this node and all its children will be considered
|
| 14 | * @param requiredCharacters - The test returns true if at least this many non-spacing characters are found.
|
| 15 | * The default value is 1.
|
| 16 | */
|
| 17 | static hasAnyTextContent(node: DocNode, requiredCharacters?: number): boolean;
|
| 18 | /**
|
| 19 | * Returns true if the specified collection of nodes contains any text content.
|
| 20 | *
|
| 21 | * @remarks
|
| 22 | * A documentation tool can use this test to report warnings when a developer neglected to write a code comment
|
| 23 | * for a declaration.
|
| 24 | *
|
| 25 | * @param nodes - the collection of nodes to be tested
|
| 26 | * @param requiredCharacters - The test returns true if at least this many non-spacing characters are found.
|
| 27 | * The default value is 1.
|
| 28 | */
|
| 29 | static hasAnyTextContent(nodes: ReadonlyArray<DocNode>, requiredCharacters?: number): boolean;
|
| 30 | private static _scanTextContent;
|
| 31 | private static _countNonSpaceCharacters;
|
| 32 | }
|
| 33 | //# sourceMappingURL=PlainTextEmitter.d.ts.map |
| \ | No newline at end of file |