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