/** * Unique identifiers for messages reported by the TSDoc parser. * * @remarks * * These strings are possible values for the {@link ParserMessage.messageId} property. * These identifiers can be used to suppress or configure the reporting of individual messages. * They are also useful when searching for help about a particular error. * * @public */ export declare enum TSDocMessageId { /** * File not found * @remarks * Reported by the `@microsoft/tsdoc-config` package when it failed to find a `tsdoc.json` file. */ ConfigFileNotFound = "tsdoc-config-file-not-found", /** * Error parsing JSON input: ___ * @remarks * Reported by the `@microsoft/tsdoc-config` package when the `tsdoc.json` file has invalid JSON syntax. */ ConfigInvalidJson = "tsdoc-config-invalid-json", /** * Unsupported JSON "$schema" value * @remarks * Reported by the `@microsoft/tsdoc-config` package when the file format is not supported. */ ConfigFileUnsupportedSchema = "tsdoc-config-unsupported-schema", /** * Error loading config file: ___ * @remarks * Reported by the `@microsoft/tsdoc-config` package when the config file doesn't conform to its schema. */ ConfigFileSchemaError = "tsdoc-config-schema-error", /** * Circular reference encountered for "extends" field of "___" * @remarks * Reported by the `@microsoft/tsdoc-config` package when the "extends" field creates a chain of references * that causes a file to indirectly extend itself. */ ConfigFileCyclicExtends = "tsdoc-config-cyclic-extends", /** * Unable to resolve "extends" reference to "___" * @remarks * Reported by the `@microsoft/tsdoc-config` package when module resolution fails for the "extends" field. */ ConfigFileUnresolvedExtends = "tsdoc-config-unresolved-extends", /** * The "supportForTags" field refers to an undefined tag "___". * @remarks * Reported by the `@microsoft/tsdoc-config` package when loading the tsdoc.json config file. */ ConfigFileUndefinedTag = "tsdoc-config-undefined-tag", /** * The "tagDefinitions" field specifies more than one tag with the name "___". * @remarks * Reported by the `@microsoft/tsdoc-config` package when loading the tsdoc.json config file. */ ConfigFileDuplicateTagName = "tsdoc-config-duplicate-tag-name", /** * A TSDoc tag name must start with a letter and contain only letters and numbers. * @remarks * Reported by the `@microsoft/tsdoc-config` package when loading the tsdoc.json config file. */ ConfigFileInvalidTagName = "tsdoc-config-invalid-tag-name", /** * Expecting a `/**` comment. * Unexpected end of input. */ CommentNotFound = "tsdoc-comment-not-found", /** * Expecting a leading `/**` */ CommentOpeningDelimiterSyntax = "tsdoc-comment-missing-opening-delimiter", /** * Unexpected end of input. */ CommentMissingClosingDelimiter = "tsdoc-comment-missing-closing-delimiter", /** * A doc comment cannot have more than one `@inheritDoc` tag */ ExtraInheritDocTag = "tsdoc-extra-inheritdoc-tag", /** * The `}` character should be escaped using a backslash to avoid confusion with a TSDoc inline tag. */ EscapeRightBrace = "tsdoc-escape-right-brace", /** * The `>` character should be escaped using a backslash to avoid confusion with an HTML tag. */ EscapeGreaterThan = "tsdoc-escape-greater-than", /** * The ___ block must include a deprecation message, e.g. describing the recommended alternative. */ MissingDeprecationMessage = "tsdoc-missing-deprecation-message", /** * A ___ block must not be used, because that content is provided by the `@inheritDoc` tag. */ InheritDocIncompatibleTag = "tsdoc-inheritdoc-incompatible-tag", /** * The summary section must not have any content, because that content is provided by the `@inheritDoc` tag. */ InheritDocIncompatibleSummary = "tsdoc-inheritdoc-incompatible-summary", /** * The TSDoc tag ___ is an inline tag; it must be enclosed in `{ }` braces. */ InlineTagMissingBraces = "tsdoc-inline-tag-missing-braces", /** * The TSDoc tag ___ is not an inline tag; it must not be enclosed in `{ }` braces. */ TagShouldNotHaveBraces = "tsdoc-tag-should-not-have-braces", /** * The TSDoc tag ___ is not supported by this tool. */ UnsupportedTag = "tsdoc-unsupported-tag", /** * The TSDoc tag ___ is not defined in this configuration. */ UndefinedTag = "tsdoc-undefined-tag", /** * The `@param` block should not include a JSDoc-style `{type}`. */ ParamTagWithInvalidType = "tsdoc-param-tag-with-invalid-type", /** * The `@param` block should not include a JSDoc-style optional name; it must not be enclosed in `[ ]` brackets. */ ParamTagWithInvalidOptionalName = "tsdoc-param-tag-with-invalid-optional-name", /** * The `@param` block should be followed by a parameter name. */ ParamTagWithInvalidName = "tsdoc-param-tag-with-invalid-name", /** * The `@param` block should be followed by a parameter name and then a hyphen. */ ParamTagMissingHyphen = "tsdoc-param-tag-missing-hyphen", /** * A backslash must precede another character that is being escaped. OR * A backslash can only be used to escape a punctuation character. */ UnnecessaryBackslash = "tsdoc-unnecessary-backslash", /** * Expecting a TSDoc tag starting with `@`. OR * Expecting a TSDoc tag starting with `{`. */ MissingTag = "tsdoc-missing-tag", /** * The `@` character looks like part of a TSDoc tag; use a backslash to escape it. */ AtSignInWord = "tsdoc-at-sign-in-word", /** * Expecting a TSDoc tag name after `@`; if it is not a tag, use a backslash to escape this character. */ AtSignWithoutTagName = "tsdoc-at-sign-without-tag-name", /** * Expecting a TSDoc tag starting with `{@`. OR * Expecting a TSDoc inline tag name after the `{@` characters. */ MalformedInlineTag = "tsdoc-malformed-inline-tag", /** * The token ___ looks like a TSDoc tag but contains an invalid character ___; if it is not a tag, * use a backslash to escape the `@`. */ CharactersAfterBlockTag = "tsdoc-characters-after-block-tag", /** * A TSDoc tag name must start with a letter and contain only letters and numbers. */ MalformedTagName = "tsdoc-malformed-tag-name", /** * The character ___ cannot appear after the TSDoc tag name; expecting a space. */ CharactersAfterInlineTag = "tsdoc-characters-after-inline-tag", /** * The TSDoc inline tag name is missing its closing `}`. */ InlineTagMissingRightBrace = "tsdoc-inline-tag-missing-right-brace", /** * The `{` character must be escaped with a backslash when used inside a TSDoc inline tag. */ InlineTagUnescapedBrace = "tsdoc-inline-tag-unescaped-brace", /** * Unexpected character after declaration reference. */ InheritDocTagSyntax = "tsdoc-inheritdoc-tag-syntax", /** * The `@link` tag content is missing. */ LinkTagEmpty = "tsdoc-link-tag-empty", /** * The ___ character may not be used in the link text without escaping it. */ LinkTagUnescapedText = "tsdoc-link-tag-unescaped-text", /** * Unexpected character after link destination. */ LinkTagDestinationSyntax = "tsdoc-link-tag-destination-syntax", /** * The URL cannot be empty. OR * An `@link` URL must begin with a scheme comprised only of letters and numbers followed by `://`. OR * An `@link` URL must have at least one character after `://`. */ LinkTagInvalidUrl = "tsdoc-link-tag-invalid-url", /** * The declaration reference appears to contain a package name or import path, but it is missing the `#` delimiter. */ ReferenceMissingHash = "tsdoc-reference-missing-hash", /** * The hash character must be preceded by a package name or import path. */ ReferenceHashSyntax = "tsdoc-reference-hash-syntax", /** * The package name cannot be an empty string. OR * The package name ___ is not a valid package name. */ ReferenceMalformedPackageName = "tsdoc-reference-malformed-package-name", /** * An import path must not contain `//`. OR * An import path must not end with `/`. OR * An import path must not start with `/` unless prefixed by a package name. */ ReferenceMalformedImportPath = "tsdoc-reference-malformed-import-path", /** * Expecting a declaration reference. */ MissingReference = "tsdoc-missing-reference", /** * Expecting a period before the next component of a declaration reference */ ReferenceMissingDot = "tsdoc-reference-missing-dot", /** * Syntax error in declaration reference: the member selector must be enclosed in parentheses. */ ReferenceSelectorMissingParens = "tsdoc-reference-selector-missing-parens", /** * Expecting a colon after the identifier because the expression is in parentheses. */ ReferenceMissingColon = "tsdoc-reference-missing-colon", /** * Expecting a matching right parenthesis. */ ReferenceMissingRightParen = "tsdoc-reference-missing-right-paren", /** * Missing declaration reference in symbol reference */ ReferenceSymbolSyntax = "tsdoc-reference-symbol-syntax", /** * Missing closing square bracket for symbol reference */ ReferenceMissingRightBracket = "tsdoc-reference-missing-right-bracket", /** * Unexpected end of input inside quoted member identifier. */ ReferenceMissingQuote = "tsdoc-reference-missing-quote", /** * The quoted identifier cannot be empty. */ ReferenceEmptyIdentifier = "tsdoc-reference-empty-identifier", /** * Syntax error in declaration reference: expecting a member identifier. */ ReferenceMissingIdentifier = "tsdoc-reference-missing-identifier", /** * The identifier cannot be an empty string. OR * The identifier cannot non-word characters. OR * The identifier must not start with a number. OR * The identifier ___ must be quoted because it is a TSDoc system selector name. */ ReferenceUnquotedIdentifier = "tsdoc-reference-unquoted-identifier", /** * Expecting a selector label after the colon. */ ReferenceMissingLabel = "tsdoc-reference-missing-label", /** * The selector cannot be an empty string. OR * If the selector begins with a number, it must be a positive integer value. OR * A label selector must be comprised of upper case letters, numbers, and underscores * and must not start with a number. OR * The selector ___ is not a recognized TSDoc system selector name. */ ReferenceSelectorSyntax = "tsdoc-reference-selector-syntax", /** * Expecting an attribute or `>` or `/>`. */ HtmlTagMissingGreaterThan = "tsdoc-html-tag-missing-greater-than", /** * Expecting `=` after HTML attribute name. */ HtmlTagMissingEquals = "tsdoc-html-tag-missing-equals", /** * Expecting an HTML string starting with a single-quote or double-quote character. */ HtmlTagMissingString = "tsdoc-html-tag-missing-string", /** * The HTML string is missing its closing quote. */ HtmlStringMissingQuote = "tsdoc-html-string-missing-quote", /** * The next character after a closing quote must be spacing or punctuation. */ TextAfterHtmlString = "tsdoc-text-after-html-string", /** * Expecting an HTML tag starting with `; //# sourceMappingURL=TSDocMessageId.d.ts.map