1 | ;
|
2 | Object.defineProperty(exports, "__esModule", { value: true });
|
3 | exports.Standardization = void 0;
|
4 | /**
|
5 | * Used to group the {@link StandardTags} definitions according to the level of support
|
6 | * expected from documentation tools that implement the standard.
|
7 | */
|
8 | var Standardization;
|
9 | (function (Standardization) {
|
10 | /**
|
11 | * TSDoc tags in the "Core" standardization group are considered essential.
|
12 | * Their meaning is standardized, and every documentation tool is expected
|
13 | * to recognize them. The TSDoc parser library typically provides dedicated APIs
|
14 | * for accessing these tags.
|
15 | */
|
16 | Standardization["Core"] = "Core";
|
17 | /**
|
18 | * TSDoc tags in the "Extended" standardization group are optional. Documentation tools
|
19 | * may or may not support them. If they do, the syntax and semantics should conform to
|
20 | * the TSDoc standard definitions.
|
21 | */
|
22 | Standardization["Extended"] = "Extended";
|
23 | /**
|
24 | * TSDoc tags in the "Discretionary" standardization group are optional. Although the
|
25 | * syntax is specified, the semantics for these tags are implementation-specific
|
26 | * (and sometimes difficult to describe completely without referring to a specific
|
27 | * implementation). Discretionary tags are included in the TSDoc standard to ensure that
|
28 | * if two different popular tools use the same tag name, developers can expect the syntax
|
29 | * to be the same, and the semantics to be somewhat similar.
|
30 | */
|
31 | Standardization["Discretionary"] = "Discretionary";
|
32 | /**
|
33 | * The tag is not part of the TSDoc standard. All used-defined tags are assigned to this group.
|
34 | */
|
35 | Standardization["None"] = "None";
|
36 | })(Standardization = exports.Standardization || (exports.Standardization = {}));
|
37 | //# sourceMappingURL=Standardization.js.map |
\ | No newline at end of file |