/** * Distinguishes different types of Token objects. */ export declare enum TokenKind { /** * A token representing a newline -> "\n" or "\r\n" */ Newline = 0, /** * A token representing one or more spaces and/or tabs (but not newlines). */ Spaces = 1, /** * A token representing one or more ASCII letters, numbers, and/or underscores. */ AsciiWord = 2, /** * The slash character `/` */ Slash = 3, /** * The star character `*`. */ Star = 4, /** * The backslash character `\`. Can be used to escape characters. */ Backslash = 5, /** * The double-quote character `"`. Double quotes can be used to * surround unusual characters (similar to escaping them). */ DoubleQuote = 6, /** * The tilde character `~`. Can be used to reference inner members in links. */ Tilde = 7, /** * The at-sign character `@`. */ AtSign = 8, /** * The left curly bracket character `{`. */ LeftCurlyBracket = 9, /** * The right curly bracket character `}`. */ RightCurlyBracket = 10, /** * The backtick character. Can be used to include code snippets. */ Backtick = 11, /** * The period character `.`. Can be used to reference static members. */ Period = 12, /** * The colon character `:`. Can be used to reference external symbols. */ Colon = 13, /** * The pipe character `|`. Can be used to define the link text. */ Pipe = 14, /** * The pound character `#`. Can be used to define instance members in links. */ PoundSymbol = 15, /** * The right square bracket character `]`. Can be used when defining * the default value. */ RightSquareBracket = 16, /** * The left square bracket character `[`. Can be used when defining * the default value. */ LeftSquareBracket = 17, /** * The equal character `=`. Can be used when defining the default value. */ Equal = 18, /** * The hyphen character `-`. Can be used to separate the name from the description. */ Hyphen = 19, /** * A token representing any other character not present in the above tokens. */ Other = 20 } /** * A sequence of characters that are treated as a unit as it cannot be further * broken down. */ export declare class Token { /** * The kind of token */ private readonly _kind; /** * Whether this token can be merged with continuous tokens of the same kind */ private readonly _multiple; /** * The starting index into the associated text. */ private readonly _start; /** * The doc comment "line" number that this Token was extracted from. */ private readonly _line; /** * The sequence of characters in the source code * that matched the pattern associated with the token. */ private _lexeme; /** * The (non-inclusive) ending index into the associated text. */ private _end; constructor(kind: TokenKind, lexeme: string, multiple: boolean, line: number, start: number, end: number); get kind(): TokenKind; get start(): number; get end(): number; get line(): number; get length(): number; get multiple(): boolean; merge(token: Token): void; toString(): string; } //# sourceMappingURL=token.d.ts.map