| 1 | import { TextRange } from './TextRange';
|
| 2 | import type { Token } from './Token';
|
| 3 | import { DocComment } from '../nodes';
|
| 4 | import type { TSDocConfiguration } from '../configuration/TSDocConfiguration';
|
| 5 | import { ParserMessageLog } from './ParserMessageLog';
|
| 6 | /**
|
| 7 | * An internal data structure that tracks all the state being built up by the various
|
| 8 | * parser stages.
|
| 9 | */
|
| 10 | export declare class ParserContext {
|
| 11 | /**
|
| 12 | * The configuration that was provided for the TSDocParser.
|
| 13 | */
|
| 14 | readonly configuration: TSDocConfiguration;
|
| 15 | /**
|
| 16 | * The `sourceRange` indicates the start and end of the original input that was parsed.
|
| 17 | */
|
| 18 | readonly sourceRange: TextRange;
|
| 19 | /**
|
| 20 | * The text range starting from the opening `/**` and ending with
|
| 21 | * the closing `*\/` delimiter.
|
| 22 | */
|
| 23 | commentRange: TextRange;
|
| 24 | /**
|
| 25 | * The text ranges corresponding to the lines of content inside the comment.
|
| 26 | */
|
| 27 | lines: TextRange[];
|
| 28 | /**
|
| 29 | * A complete list of all tokens that were extracted from the input lines.
|
| 30 | */
|
| 31 | tokens: Token[];
|
| 32 | /**
|
| 33 | * The parsed doc comment object. This is the primary output of the parser.
|
| 34 | */
|
| 35 | readonly docComment: DocComment;
|
| 36 | /**
|
| 37 | * A queryable log that reports warnings and error messages that occurred during parsing.
|
| 38 | */
|
| 39 | readonly log: ParserMessageLog;
|
| 40 | constructor(configuration: TSDocConfiguration, sourceRange: TextRange);
|
| 41 | }
|
| 42 | //# sourceMappingURL=ParserContext.d.ts.map |
| \ | No newline at end of file |