rushstack/apps/api-extractor/extends/tsdoc-base.json at main · microsoft/rushstack · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
/**
 * This file defines the TSDoc custom tags for use with API Extractor.
 *
 * If your project has a custom tsdoc.json file, then it should use the "extends" field to
 * inherit the definitions from this file.  For example:
 *
 * ```
 * {
 *   "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
 *   "extends": [ "@microsoft/api-extractor/extends/tsdoc-config.json" ],
 *   . . .
 * }
 * ```
 *
 * For details about this config file, please see: https://tsdoc.org/pages/packages/tsdoc-config/
 */
{
  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",

  /**
   * The "AEDoc" custom tags:
   */
  "tagDefinitions": [
    {
      "tagName": "@betaDocumentation",
      "syntaxKind": "modifier"
    },
    {
      "tagName": "@internalRemarks",
      "syntaxKind": "block"
    },
    {
      "tagName": "@preapproved",
      "syntaxKind": "modifier"
    }
  ],

  /**
   * TSDoc tags implemented by API Extractor:
   */
  "supportForTags": {
    "@alpha": true,
    "@beta": true,
    "@defaultValue": true,
    "@decorator": true,
    "@deprecated": true,
    "@eventProperty": true,
    "@example": true,
    "@experimental": true,
    "@inheritDoc": true,
    "@internal": true,
    "@label": true,
    "@link": true,
    "@override": true,
    "@packageDocumentation": true,
    "@param": true,
    "@privateRemarks": true,
    "@public": true,
    "@readonly": true,
    "@remarks": true,
    "@returns": true,
    "@sealed": true,
    "@see": true,
    "@throws": true,
    "@typeParam": true,
    "@virtual": true,

    "@betaDocumentation": true,
    "@internalRemarks": true,
    "@preapproved": true
  }
}