1 | /**
|
2 | * This file defines the TSDoc custom tags for use with API Extractor.
|
3 | *
|
4 | * If your project has a custom tsdoc.json file, then it should use the "extends" field to
|
5 | * inherit the definitions from this file. For example:
|
6 | *
|
7 | * ```
|
8 | * {
|
9 | * "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
10 | * "extends": [ "@microsoft/api-extractor/extends/tsdoc-config.json" ],
|
11 | * . . .
|
12 | * }
|
13 | * ```
|
14 | *
|
15 | * For details about this config file, please see: https://tsdoc.org/pages/packages/tsdoc-config/
|
16 | */
|
17 | {
|
18 | "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
19 |
|
20 | /**
|
21 | * The "AEDoc" custom tags:
|
22 | */
|
23 | "tagDefinitions": [
|
24 | {
|
25 | "tagName": "@betaDocumentation",
|
26 | "syntaxKind": "modifier"
|
27 | },
|
28 | {
|
29 | "tagName": "@internalRemarks",
|
30 | "syntaxKind": "block"
|
31 | },
|
32 | {
|
33 | "tagName": "@preapproved",
|
34 | "syntaxKind": "modifier"
|
35 | }
|
36 | ],
|
37 |
|
38 | /**
|
39 | * TSDoc tags implemented by API Extractor:
|
40 | */
|
41 | "supportForTags": {
|
42 | "@alpha": true,
|
43 | "@beta": true,
|
44 | "@defaultValue": true,
|
45 | "@decorator": true,
|
46 | "@deprecated": true,
|
47 | "@eventProperty": true,
|
48 | "@example": true,
|
49 | "@experimental": true,
|
50 | "@inheritDoc": true,
|
51 | "@internal": true,
|
52 | "@label": true,
|
53 | "@link": true,
|
54 | "@override": true,
|
55 | "@packageDocumentation": true,
|
56 | "@param": true,
|
57 | "@privateRemarks": true,
|
58 | "@public": true,
|
59 | "@readonly": true,
|
60 | "@remarks": true,
|
61 | "@returns": true,
|
62 | "@sealed": true,
|
63 | "@see": true,
|
64 | "@throws": true,
|
65 | "@typeParam": true,
|
66 | "@virtual": true,
|
67 |
|
68 | "@betaDocumentation": true,
|
69 | "@internalRemarks": true,
|
70 | "@preapproved": true
|
71 | }
|
72 | }
|