UNPKG

2.04 kBJavaScriptView Raw
1"use strict";
2Object.defineProperty(exports, "__esModule", { value: true });
3exports.TSDocTagDefinition = exports.TSDocTagSyntaxKind = void 0;
4var StringChecks_1 = require("../parser/StringChecks");
5var Standardization_1 = require("../details/Standardization");
6/**
7 * Determines the type of syntax for a TSDocTagDefinition
8 */
9var TSDocTagSyntaxKind;
10(function (TSDocTagSyntaxKind) {
11 /**
12 * The tag is intended to be an inline tag. For example: `{@link}`.
13 */
14 TSDocTagSyntaxKind[TSDocTagSyntaxKind["InlineTag"] = 0] = "InlineTag";
15 /**
16 * The tag is intended to be a block tag that starts a new documentation
17 * section. For example: `@remarks`
18 */
19 TSDocTagSyntaxKind[TSDocTagSyntaxKind["BlockTag"] = 1] = "BlockTag";
20 /**
21 * The tag is intended to be a modifier tag whose presence indicates
22 * an aspect of the associated API item. For example: `@internal`
23 */
24 TSDocTagSyntaxKind[TSDocTagSyntaxKind["ModifierTag"] = 2] = "ModifierTag";
25})(TSDocTagSyntaxKind = exports.TSDocTagSyntaxKind || (exports.TSDocTagSyntaxKind = {}));
26/**
27 * Defines a TSDoc tag that will be understood by the TSDocParser.
28 */
29var TSDocTagDefinition = /** @class */ (function () {
30 function TSDocTagDefinition(parameters) {
31 StringChecks_1.StringChecks.validateTSDocTagName(parameters.tagName);
32 this.tagName = parameters.tagName;
33 this.tagNameWithUpperCase = parameters.tagName.toUpperCase();
34 this.syntaxKind = parameters.syntaxKind;
35 this.standardization =
36 parameters.standardization || Standardization_1.Standardization.None;
37 this.allowMultiple = !!parameters.allowMultiple;
38 }
39 /**
40 * Throws an exception if `tagName` is not a valid TSDoc tag name.
41 */
42 TSDocTagDefinition.validateTSDocTagName = function (tagName) {
43 StringChecks_1.StringChecks.validateTSDocTagName(tagName);
44 };
45 return TSDocTagDefinition;
46}());
47exports.TSDocTagDefinition = TSDocTagDefinition;
48//# sourceMappingURL=TSDocTagDefinition.js.map
\No newline at end of file