UNPKG

3.4 kBTypeScriptView Raw
1import { ParserContext } from './ParserContext';
2/**
3 * The main parser for TSDoc comments.
4 */
5export declare class NodeParser {
6 private readonly _parserContext;
7 private readonly _configuration;
8 private _currentSection;
9 constructor(parserContext: ParserContext);
10 parse(): void;
11 private _performValidationChecks;
12 private _validateTagDefinition;
13 private _pushAccumulatedPlainText;
14 private _parseAndPushBlock;
15 private _addBlockToDocComment;
16 /**
17 * Used by `_parseParamBlock()`, this parses a JSDoc expression remainder like `string}` or `="]"]` from
18 * an input like `@param {string} [x="]"] - the X value`. It detects nested balanced pairs of delimiters
19 * and escaped string literals.
20 */
21 private _tryParseJSDocTypeOrValueRest;
22 /**
23 * Used by `_parseParamBlock()`, this parses a JSDoc expression like `{string}` from
24 * an input like `@param {string} x - the X value`.
25 */
26 private _tryParseUnsupportedJSDocType;
27 /**
28 * Used by `_parseParamBlock()`, this parses a JSDoc expression remainder like `=[]]` from
29 * an input like `@param {string} [x=[]] - the X value`.
30 */
31 private _tryParseJSDocOptionalNameRest;
32 private _parseParamBlock;
33 private _pushNode;
34 private _parseBackslashEscape;
35 private _parseBlockTag;
36 private _parseInlineTag;
37 private _parseInheritDocTag;
38 private _parseLinkTag;
39 private _parseLinkTagUrlDestination;
40 private _parseLinkTagCodeDestination;
41 private _parseDeclarationReference;
42 private _parseMemberReference;
43 private _parseMemberSymbol;
44 private _parseMemberIdentifier;
45 private _parseMemberSelector;
46 private _parseHtmlStartTag;
47 private _parseHtmlAttribute;
48 private _parseHtmlString;
49 private _parseHtmlEndTag;
50 /**
51 * Parses an HTML name such as an element name or attribute name.
52 */
53 private _parseHtmlName;
54 private _parseFencedCode;
55 private _parseCodeSpan;
56 private _tryReadSpacingAndNewlines;
57 /**
58 * Read the next token, and report it as a DocErrorText node.
59 */
60 private _createError;
61 /**
62 * Rewind to the specified marker, read the next token, and report it as a DocErrorText node.
63 */
64 private _backtrackAndCreateError;
65 /**
66 * Rewind to the errorStartMarker, read the tokens up to and including errorInclusiveEndMarker,
67 * and report it as a DocErrorText node.
68 */
69 private _backtrackAndCreateErrorRange;
70 /**
71 * Rewind to the specified marker, read the next token, and report it as a DocErrorText node
72 * whose location is based on an IFailure.
73 */
74 private _backtrackAndCreateErrorForFailure;
75 /**
76 * Rewind to the errorStartMarker, read the tokens up to and including errorInclusiveEndMarker,
77 * and report it as a DocErrorText node whose location is based on an IFailure.
78 */
79 private _backtrackAndCreateErrorRangeForFailure;
80 /**
81 * Creates an IFailure whose TokenSequence is a single token. If a marker is not specified,
82 * then it is the current token.
83 */
84 private _createFailureForToken;
85 /**
86 * Creates an IFailure whose TokenSequence starts from the specified marker and
87 * encompasses all tokens read since then. If none were read, then the next token used.
88 */
89 private _createFailureForTokensSince;
90}
91//# sourceMappingURL=NodeParser.d.ts.map
\No newline at end of file