node-webcodecs/typedoc.json at main · caseymanos/node-webcodecs · 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
{
  "$schema": "https://typedoc.org/schema.json",
  "entryPoints": ["./src"],
  "entryPointStrategy": "expand",
  "out": "./docs/api-reference",
  "plugin": ["typedoc-plugin-markdown"],
  "readme": "none",
  "hideGenerator": true,
  "excludePrivate": true,
  "excludeProtected": true,
  "excludeInternal": true,
  "sort": ["source-order"],
  "gitRevision": "master",
  "name": "node-webcodecs API Reference",
  "includeVersion": true,
  "outputFileStrategy": "modules",
  "flattenOutputFiles": false,
  "fileExtension": ".mdx",
  "excludeExternals": true,
  "excludeNotDocumented": false,
  "validation": {
    "notExported": false,
    "invalidLink": true,
    "notDocumented": false
  },
  "commentStyle": "jsdoc",
  "blockTags": [
    "@example",
    "@see",
    "@param",
    "@returns",
    "@throws",
    "@deprecated",
    "@default",
    "@remarks"
  ],
  "modifierTags": [
    "@public",
    "@private",
    "@protected",
    "@internal",
    "@readonly"
  ]
}