typedoc 0.28.14 → 0.28.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/lib/cli.js +2 -1
- package/dist/lib/converter/comments/index.d.ts +3 -2
- package/dist/lib/converter/comments/index.js +69 -18
- package/dist/lib/converter/comments/parser.js +45 -21
- package/dist/lib/converter/comments/textParser.d.ts +13 -9
- package/dist/lib/converter/comments/textParser.js +21 -16
- package/dist/lib/converter/converter.js +1 -0
- package/dist/lib/converter/factories/signature.d.ts +1 -0
- package/dist/lib/converter/factories/signature.js +13 -0
- package/dist/lib/converter/jsdoc.d.ts +1 -1
- package/dist/lib/converter/jsdoc.js +33 -2
- package/dist/lib/converter/plugins/CommentPlugin.js +13 -0
- package/dist/lib/converter/plugins/ImplementsPlugin.d.ts +1 -0
- package/dist/lib/converter/plugins/ImplementsPlugin.js +23 -4
- package/dist/lib/converter/plugins/IncludePlugin.js +4 -0
- package/dist/lib/converter/plugins/SourcePlugin.js +3 -3
- package/dist/lib/converter/symbols.js +9 -22
- package/dist/lib/converter/utils/repository.js +3 -0
- package/dist/lib/internationalization/locales/en.cjs +1 -0
- package/dist/lib/internationalization/locales/en.d.cts +1 -0
- package/dist/lib/models/Comment.d.ts +1 -1
- package/dist/lib/models/Comment.js +1 -1
- package/dist/lib/models/DeclarationReflection.d.ts +7 -0
- package/dist/lib/models/DeclarationReflection.js +9 -0
- package/dist/lib/output/events.d.ts +2 -0
- package/dist/lib/output/events.js +1 -0
- package/dist/lib/output/plugins/JavascriptIndexPlugin.js +1 -1
- package/dist/lib/output/themes/MarkedPlugin.js +15 -8
- package/dist/lib/output/themes/default/partials/icon.js +1 -1
- package/dist/lib/output/themes/default/partials/member.js +1 -0
- package/dist/lib/output/themes/default/partials/moduleReflection.js +1 -0
- package/dist/lib/output/themes/default/partials/navigation.js +1 -1
- package/dist/lib/serialization/schema.d.ts +1 -1
- package/dist/lib/utils/entry-point.js +1 -1
- package/dist/lib/utils/options/declaration.d.ts +4 -0
- package/dist/lib/utils/options/sources/typedoc.js +1 -0
- package/dist/lib/utils/options/tsdoc-defaults.d.ts +2 -2
- package/dist/lib/utils/options/tsdoc-defaults.js +1 -1
- package/dist/lib/utils-common/jsx.elements.d.ts +1 -0
- package/dist/lib/utils-common/logger.d.ts +12 -1
- package/dist/lib/utils-common/logger.js +9 -0
- package/dist/lib/utils-common/set.d.ts +1 -0
- package/dist/lib/utils-common/set.js +7 -0
- package/dist/lib/validation/documentation.js +2 -2
- package/dist/lib/validation/exports.js +2 -2
- package/dist/lib/validation/links.js +7 -7
- package/package.json +16 -14
- package/static/style.css +3 -3
- package/tsdoc.json +0 -4
- package/typedoc-config.schema.json +941 -0
|
@@ -0,0 +1,941 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft-07/schema",
|
|
3
|
+
"title": "JSON Schema for typedoc.json",
|
|
4
|
+
"type": "object",
|
|
5
|
+
"properties": {
|
|
6
|
+
"options": {
|
|
7
|
+
"description": "Specify a json option file that should be loaded. If not specified TypeDoc will look for 'typedoc.json' in the current directory",
|
|
8
|
+
"type": "string"
|
|
9
|
+
},
|
|
10
|
+
"tsconfig": {
|
|
11
|
+
"description": "Specify a TypeScript config file that should be loaded. If not specified TypeDoc will look for 'tsconfig.json' in the current directory",
|
|
12
|
+
"type": "string"
|
|
13
|
+
},
|
|
14
|
+
"compilerOptions": {
|
|
15
|
+
"description": "Selectively override the TypeScript compiler options used by TypeDoc",
|
|
16
|
+
"type": "object",
|
|
17
|
+
"markedOptions": "object"
|
|
18
|
+
},
|
|
19
|
+
"lang": {
|
|
20
|
+
"description": "Sets the language to be used in generation and in TypeDoc's messages",
|
|
21
|
+
"type": "string",
|
|
22
|
+
"default": "en"
|
|
23
|
+
},
|
|
24
|
+
"locales": {
|
|
25
|
+
"description": "Add translations for a specified locale. This option is primarily intended to be used as a stopgap while waiting for official locale support to be added to TypeDoc",
|
|
26
|
+
"default": {}
|
|
27
|
+
},
|
|
28
|
+
"packageOptions": {
|
|
29
|
+
"description": "Set options which will be set within each package when entryPointStrategy is set to packages",
|
|
30
|
+
"default": {}
|
|
31
|
+
},
|
|
32
|
+
"entryPoints": {
|
|
33
|
+
"description": "The entry points of your documentation",
|
|
34
|
+
"type": "array",
|
|
35
|
+
"items": {
|
|
36
|
+
"type": "string"
|
|
37
|
+
},
|
|
38
|
+
"default": []
|
|
39
|
+
},
|
|
40
|
+
"entryPointStrategy": {
|
|
41
|
+
"description": "The strategy to be used to convert entry points into documentation modules",
|
|
42
|
+
"enum": [
|
|
43
|
+
"resolve",
|
|
44
|
+
"expand",
|
|
45
|
+
"packages",
|
|
46
|
+
"merge"
|
|
47
|
+
],
|
|
48
|
+
"default": "resolve"
|
|
49
|
+
},
|
|
50
|
+
"alwaysCreateEntryPointModule": {
|
|
51
|
+
"description": "When set, TypeDoc will always create a `Module` for entry points, even if only one is provided",
|
|
52
|
+
"type": "boolean",
|
|
53
|
+
"default": false
|
|
54
|
+
},
|
|
55
|
+
"projectDocuments": {
|
|
56
|
+
"description": "Documents which should be added as children to the root of the generated documentation. Supports globs to match multiple files",
|
|
57
|
+
"type": "array",
|
|
58
|
+
"items": {
|
|
59
|
+
"type": "string"
|
|
60
|
+
},
|
|
61
|
+
"default": []
|
|
62
|
+
},
|
|
63
|
+
"exclude": {
|
|
64
|
+
"description": "Define patterns to be excluded when expanding a directory that was specified as an entry point",
|
|
65
|
+
"type": "array",
|
|
66
|
+
"items": {
|
|
67
|
+
"type": "string"
|
|
68
|
+
},
|
|
69
|
+
"default": []
|
|
70
|
+
},
|
|
71
|
+
"externalPattern": {
|
|
72
|
+
"description": "Define patterns for files that should be considered being external",
|
|
73
|
+
"type": "array",
|
|
74
|
+
"items": {
|
|
75
|
+
"type": "string"
|
|
76
|
+
},
|
|
77
|
+
"default": [
|
|
78
|
+
"**/node_modules/**"
|
|
79
|
+
]
|
|
80
|
+
},
|
|
81
|
+
"excludeExternals": {
|
|
82
|
+
"description": "Prevent externally resolved symbols from being documented",
|
|
83
|
+
"type": "boolean",
|
|
84
|
+
"default": false
|
|
85
|
+
},
|
|
86
|
+
"excludeNotDocumented": {
|
|
87
|
+
"description": "Prevent symbols that are not explicitly documented from appearing in the results",
|
|
88
|
+
"type": "boolean",
|
|
89
|
+
"default": false
|
|
90
|
+
},
|
|
91
|
+
"excludeNotDocumentedKinds": {
|
|
92
|
+
"description": "Specify the type of reflections that can be removed by excludeNotDocumented",
|
|
93
|
+
"type": "array",
|
|
94
|
+
"items": {
|
|
95
|
+
"type": "string"
|
|
96
|
+
},
|
|
97
|
+
"default": [
|
|
98
|
+
"Module",
|
|
99
|
+
"Namespace",
|
|
100
|
+
"Enum",
|
|
101
|
+
"Variable",
|
|
102
|
+
"Function",
|
|
103
|
+
"Class",
|
|
104
|
+
"Interface",
|
|
105
|
+
"Constructor",
|
|
106
|
+
"Property",
|
|
107
|
+
"Method",
|
|
108
|
+
"CallSignature",
|
|
109
|
+
"IndexSignature",
|
|
110
|
+
"ConstructorSignature",
|
|
111
|
+
"Accessor",
|
|
112
|
+
"GetSignature",
|
|
113
|
+
"SetSignature",
|
|
114
|
+
"TypeAlias",
|
|
115
|
+
"Reference"
|
|
116
|
+
]
|
|
117
|
+
},
|
|
118
|
+
"excludeInternal": {
|
|
119
|
+
"description": "Prevent symbols that are marked with @internal from being documented",
|
|
120
|
+
"type": "boolean",
|
|
121
|
+
"default": false
|
|
122
|
+
},
|
|
123
|
+
"excludeCategories": {
|
|
124
|
+
"description": "Exclude symbols within this category from the documentation",
|
|
125
|
+
"type": "array",
|
|
126
|
+
"items": {
|
|
127
|
+
"type": "string"
|
|
128
|
+
},
|
|
129
|
+
"default": []
|
|
130
|
+
},
|
|
131
|
+
"excludePrivate": {
|
|
132
|
+
"description": "Ignore members marked with the private keyword and #private class fields, defaults to true.",
|
|
133
|
+
"type": "boolean",
|
|
134
|
+
"default": true
|
|
135
|
+
},
|
|
136
|
+
"excludePrivateClassFields": {
|
|
137
|
+
"description": "Ignore #private class fields, defaults to true.",
|
|
138
|
+
"type": "boolean",
|
|
139
|
+
"default": true
|
|
140
|
+
},
|
|
141
|
+
"excludeProtected": {
|
|
142
|
+
"description": "Ignore protected variables and methods",
|
|
143
|
+
"type": "boolean",
|
|
144
|
+
"default": false
|
|
145
|
+
},
|
|
146
|
+
"excludeReferences": {
|
|
147
|
+
"description": "If a symbol is exported multiple times, ignore all but the first export",
|
|
148
|
+
"type": "boolean",
|
|
149
|
+
"default": false
|
|
150
|
+
},
|
|
151
|
+
"externalSymbolLinkMappings": {
|
|
152
|
+
"description": "Define custom links for symbols not included in the documentation",
|
|
153
|
+
"default": {}
|
|
154
|
+
},
|
|
155
|
+
"readme": {
|
|
156
|
+
"description": "Path to the readme file that should be displayed on the index page. Pass `none` to disable the index page and start the documentation on the globals page",
|
|
157
|
+
"type": "string",
|
|
158
|
+
"default": ""
|
|
159
|
+
},
|
|
160
|
+
"basePath": {
|
|
161
|
+
"description": "Specifies a path which links may be resolved relative to.",
|
|
162
|
+
"type": "string",
|
|
163
|
+
"default": ""
|
|
164
|
+
},
|
|
165
|
+
"outputs": {
|
|
166
|
+
"description": "Specify the location the documentation for the default output should be written to. The default output type may be changed by plugins."
|
|
167
|
+
},
|
|
168
|
+
"out": {
|
|
169
|
+
"description": "Specify the location the documentation for the default output should be written to. The default output type may be changed by plugins.",
|
|
170
|
+
"type": "string",
|
|
171
|
+
"default": "./docs"
|
|
172
|
+
},
|
|
173
|
+
"html": {
|
|
174
|
+
"description": "Specify the location where html documentation should be written to.",
|
|
175
|
+
"type": "string",
|
|
176
|
+
"default": ""
|
|
177
|
+
},
|
|
178
|
+
"json": {
|
|
179
|
+
"description": "Specify the location and filename a JSON file describing the project is written to",
|
|
180
|
+
"type": "string",
|
|
181
|
+
"default": ""
|
|
182
|
+
},
|
|
183
|
+
"pretty": {
|
|
184
|
+
"description": "Specify whether the output JSON should be formatted with tabs",
|
|
185
|
+
"type": "boolean",
|
|
186
|
+
"default": true
|
|
187
|
+
},
|
|
188
|
+
"emit": {
|
|
189
|
+
"description": "Specify what TypeDoc should emit, 'docs', 'both', or 'none'",
|
|
190
|
+
"enum": [
|
|
191
|
+
"both",
|
|
192
|
+
"docs",
|
|
193
|
+
"none"
|
|
194
|
+
],
|
|
195
|
+
"default": "docs"
|
|
196
|
+
},
|
|
197
|
+
"theme": {
|
|
198
|
+
"description": "Specify the theme name to render the documentation with",
|
|
199
|
+
"type": "string",
|
|
200
|
+
"default": "default"
|
|
201
|
+
},
|
|
202
|
+
"router": {
|
|
203
|
+
"description": "Specify the router name to use to determine file names in the documentation",
|
|
204
|
+
"type": "string",
|
|
205
|
+
"default": "kind"
|
|
206
|
+
},
|
|
207
|
+
"lightHighlightTheme": {
|
|
208
|
+
"description": "Specify the code highlighting theme in light mode",
|
|
209
|
+
"type": "string",
|
|
210
|
+
"default": "light-plus"
|
|
211
|
+
},
|
|
212
|
+
"darkHighlightTheme": {
|
|
213
|
+
"description": "Specify the code highlighting theme in dark mode",
|
|
214
|
+
"type": "string",
|
|
215
|
+
"default": "dark-plus"
|
|
216
|
+
},
|
|
217
|
+
"highlightLanguages": {
|
|
218
|
+
"description": "Specify the languages which will be loaded to highlight code when rendering",
|
|
219
|
+
"type": "array",
|
|
220
|
+
"items": {
|
|
221
|
+
"type": "string"
|
|
222
|
+
},
|
|
223
|
+
"default": [
|
|
224
|
+
"bash",
|
|
225
|
+
"console",
|
|
226
|
+
"css",
|
|
227
|
+
"html",
|
|
228
|
+
"javascript",
|
|
229
|
+
"json",
|
|
230
|
+
"jsonc",
|
|
231
|
+
"json5",
|
|
232
|
+
"yaml",
|
|
233
|
+
"tsx",
|
|
234
|
+
"typescript"
|
|
235
|
+
]
|
|
236
|
+
},
|
|
237
|
+
"ignoredHighlightLanguages": {
|
|
238
|
+
"description": "Specify languages which will be accepted as valid highlight languages, but will not be highlighted at runtime",
|
|
239
|
+
"type": "array",
|
|
240
|
+
"items": {
|
|
241
|
+
"type": "string"
|
|
242
|
+
},
|
|
243
|
+
"default": []
|
|
244
|
+
},
|
|
245
|
+
"typePrintWidth": {
|
|
246
|
+
"description": "Width at which to wrap code to a new line when rendering a type",
|
|
247
|
+
"type": "number",
|
|
248
|
+
"default": 80
|
|
249
|
+
},
|
|
250
|
+
"customCss": {
|
|
251
|
+
"description": "Path to a custom CSS file to for the theme to import",
|
|
252
|
+
"type": "string",
|
|
253
|
+
"default": ""
|
|
254
|
+
},
|
|
255
|
+
"customJs": {
|
|
256
|
+
"description": "Path to a custom JS file to import",
|
|
257
|
+
"type": "string",
|
|
258
|
+
"default": ""
|
|
259
|
+
},
|
|
260
|
+
"markdownItOptions": {
|
|
261
|
+
"description": "Specify the options passed to markdown-it, the Markdown parser used by TypeDoc",
|
|
262
|
+
"default": {
|
|
263
|
+
"html": true,
|
|
264
|
+
"linkify": true
|
|
265
|
+
}
|
|
266
|
+
},
|
|
267
|
+
"markdownItLoader": {
|
|
268
|
+
"description": "Specify a callback to be called when loading the markdown-it instance. Will be passed the instance of the parser which TypeDoc will use"
|
|
269
|
+
},
|
|
270
|
+
"maxTypeConversionDepth": {
|
|
271
|
+
"description": "Set the maximum depth of types to be converted",
|
|
272
|
+
"type": "number",
|
|
273
|
+
"default": 10
|
|
274
|
+
},
|
|
275
|
+
"name": {
|
|
276
|
+
"description": "Set the name of the project that will be used in the header of the template",
|
|
277
|
+
"type": "string",
|
|
278
|
+
"default": ""
|
|
279
|
+
},
|
|
280
|
+
"includeVersion": {
|
|
281
|
+
"description": "Add the package version to the project name",
|
|
282
|
+
"type": "boolean",
|
|
283
|
+
"default": false
|
|
284
|
+
},
|
|
285
|
+
"disableSources": {
|
|
286
|
+
"description": "Disable setting the source of a reflection when documenting it",
|
|
287
|
+
"type": "boolean",
|
|
288
|
+
"default": false
|
|
289
|
+
},
|
|
290
|
+
"sourceLinkTemplate": {
|
|
291
|
+
"description": "Specify a link template to be used when generating source urls. If not set, will be automatically created using the git remote. Supports {path}, {line}, {gitRevision} placeholders",
|
|
292
|
+
"type": "string",
|
|
293
|
+
"default": ""
|
|
294
|
+
},
|
|
295
|
+
"gitRevision": {
|
|
296
|
+
"description": "Use specified revision instead of the last revision for linking to GitHub/Bitbucket source files. Has no effect if disableSources is set",
|
|
297
|
+
"type": "string",
|
|
298
|
+
"default": ""
|
|
299
|
+
},
|
|
300
|
+
"gitRemote": {
|
|
301
|
+
"description": "Use the specified remote for linking to GitHub/Bitbucket source files. Has no effect if disableGit or disableSources is set",
|
|
302
|
+
"type": "string",
|
|
303
|
+
"default": "origin"
|
|
304
|
+
},
|
|
305
|
+
"disableGit": {
|
|
306
|
+
"description": "Assume that all can be linked to with the sourceLinkTemplate, sourceLinkTemplate must be set if this is enabled. {path} will be rooted at basePath",
|
|
307
|
+
"type": "boolean",
|
|
308
|
+
"default": false
|
|
309
|
+
},
|
|
310
|
+
"displayBasePath": {
|
|
311
|
+
"description": "Specifies the base path to be used when displaying file paths. If not specified, basePath is used.",
|
|
312
|
+
"type": "string",
|
|
313
|
+
"default": ""
|
|
314
|
+
},
|
|
315
|
+
"cname": {
|
|
316
|
+
"description": "Set the CNAME file text, it's useful for custom domains on GitHub Pages",
|
|
317
|
+
"type": "string",
|
|
318
|
+
"default": ""
|
|
319
|
+
},
|
|
320
|
+
"favicon": {
|
|
321
|
+
"description": "Path to favicon to include as the site icon",
|
|
322
|
+
"type": "string",
|
|
323
|
+
"default": ""
|
|
324
|
+
},
|
|
325
|
+
"sourceLinkExternal": {
|
|
326
|
+
"description": "Specifies that source links should be treated as external links to be opened in a new tab",
|
|
327
|
+
"type": "boolean",
|
|
328
|
+
"default": false
|
|
329
|
+
},
|
|
330
|
+
"markdownLinkExternal": {
|
|
331
|
+
"description": "Specifies that http[s]:// links in comments and markdown files should be treated as external links to be opened in a new tab",
|
|
332
|
+
"type": "boolean",
|
|
333
|
+
"default": true
|
|
334
|
+
},
|
|
335
|
+
"githubPages": {
|
|
336
|
+
"description": "Generate a .nojekyll file to prevent 404 errors in GitHub Pages. Defaults to `true`",
|
|
337
|
+
"type": "boolean",
|
|
338
|
+
"default": true
|
|
339
|
+
},
|
|
340
|
+
"hostedBaseUrl": {
|
|
341
|
+
"description": "Specify a base URL to be used in generating a sitemap.xml in our output folder and canonical links. If not specified, no sitemap will be generated",
|
|
342
|
+
"type": "string",
|
|
343
|
+
"default": ""
|
|
344
|
+
},
|
|
345
|
+
"useHostedBaseUrlForAbsoluteLinks": {
|
|
346
|
+
"description": "If set, TypeDoc will produce absolute links to pages on your site using the hostedBaseUrl option",
|
|
347
|
+
"type": "boolean",
|
|
348
|
+
"default": false
|
|
349
|
+
},
|
|
350
|
+
"hideGenerator": {
|
|
351
|
+
"description": "Do not print the TypeDoc link at the end of the page",
|
|
352
|
+
"type": "boolean",
|
|
353
|
+
"default": false
|
|
354
|
+
},
|
|
355
|
+
"customFooterHtml": {
|
|
356
|
+
"description": "Custom footer after the TypeDoc link",
|
|
357
|
+
"type": "string",
|
|
358
|
+
"default": ""
|
|
359
|
+
},
|
|
360
|
+
"customFooterHtmlDisableWrapper": {
|
|
361
|
+
"description": "If set, disables the wrapper element for customFooterHtml",
|
|
362
|
+
"type": "boolean",
|
|
363
|
+
"default": false
|
|
364
|
+
},
|
|
365
|
+
"cacheBust": {
|
|
366
|
+
"description": "Include the generation time in links to static assets",
|
|
367
|
+
"type": "boolean",
|
|
368
|
+
"default": false
|
|
369
|
+
},
|
|
370
|
+
"searchInComments": {
|
|
371
|
+
"description": "If set, the search index will also include comments. This will greatly increase the size of the search index",
|
|
372
|
+
"type": "boolean",
|
|
373
|
+
"default": false
|
|
374
|
+
},
|
|
375
|
+
"searchInDocuments": {
|
|
376
|
+
"description": "If set, the search index will also include documents. This will greatly increase the size of the search index",
|
|
377
|
+
"type": "boolean",
|
|
378
|
+
"default": false
|
|
379
|
+
},
|
|
380
|
+
"cleanOutputDir": {
|
|
381
|
+
"description": "If set, TypeDoc will remove the output directory before writing output",
|
|
382
|
+
"type": "boolean",
|
|
383
|
+
"default": true
|
|
384
|
+
},
|
|
385
|
+
"titleLink": {
|
|
386
|
+
"description": "Set the link the title in the header points to. Defaults to the documentation homepage",
|
|
387
|
+
"type": "string",
|
|
388
|
+
"default": ""
|
|
389
|
+
},
|
|
390
|
+
"navigationLinks": {
|
|
391
|
+
"description": "Defines links to be included in the header",
|
|
392
|
+
"default": {}
|
|
393
|
+
},
|
|
394
|
+
"sidebarLinks": {
|
|
395
|
+
"description": "Defines links to be included in the sidebar",
|
|
396
|
+
"default": {}
|
|
397
|
+
},
|
|
398
|
+
"navigationLeaves": {
|
|
399
|
+
"description": "Branches of the navigation tree which should not be expanded",
|
|
400
|
+
"type": "array",
|
|
401
|
+
"items": {
|
|
402
|
+
"type": "string"
|
|
403
|
+
},
|
|
404
|
+
"default": []
|
|
405
|
+
},
|
|
406
|
+
"navigation": {
|
|
407
|
+
"description": "Determines how the navigation sidebar is organized",
|
|
408
|
+
"anyOf": [
|
|
409
|
+
{
|
|
410
|
+
"type": "boolean"
|
|
411
|
+
},
|
|
412
|
+
{
|
|
413
|
+
"type": "object",
|
|
414
|
+
"properties": {
|
|
415
|
+
"includeCategories": {
|
|
416
|
+
"type": "boolean"
|
|
417
|
+
},
|
|
418
|
+
"includeGroups": {
|
|
419
|
+
"type": "boolean"
|
|
420
|
+
},
|
|
421
|
+
"includeFolders": {
|
|
422
|
+
"type": "boolean"
|
|
423
|
+
},
|
|
424
|
+
"compactFolders": {
|
|
425
|
+
"type": "boolean"
|
|
426
|
+
},
|
|
427
|
+
"excludeReferences": {
|
|
428
|
+
"type": "boolean"
|
|
429
|
+
}
|
|
430
|
+
},
|
|
431
|
+
"additionalProperties": false
|
|
432
|
+
}
|
|
433
|
+
]
|
|
434
|
+
},
|
|
435
|
+
"headings": {
|
|
436
|
+
"description": "Determines which optional headings are rendered",
|
|
437
|
+
"anyOf": [
|
|
438
|
+
{
|
|
439
|
+
"type": "boolean"
|
|
440
|
+
},
|
|
441
|
+
{
|
|
442
|
+
"type": "object",
|
|
443
|
+
"properties": {
|
|
444
|
+
"readme": {
|
|
445
|
+
"type": "boolean"
|
|
446
|
+
},
|
|
447
|
+
"document": {
|
|
448
|
+
"type": "boolean"
|
|
449
|
+
}
|
|
450
|
+
},
|
|
451
|
+
"additionalProperties": false
|
|
452
|
+
}
|
|
453
|
+
]
|
|
454
|
+
},
|
|
455
|
+
"sluggerConfiguration": {
|
|
456
|
+
"description": "Determines how anchors within rendered HTML are determined.",
|
|
457
|
+
"anyOf": [
|
|
458
|
+
{
|
|
459
|
+
"type": "boolean"
|
|
460
|
+
},
|
|
461
|
+
{
|
|
462
|
+
"type": "object",
|
|
463
|
+
"properties": {
|
|
464
|
+
"lowercase": {
|
|
465
|
+
"type": "boolean"
|
|
466
|
+
}
|
|
467
|
+
},
|
|
468
|
+
"additionalProperties": false
|
|
469
|
+
}
|
|
470
|
+
]
|
|
471
|
+
},
|
|
472
|
+
"includeHierarchySummary": {
|
|
473
|
+
"description": "If set, a reflections hierarchy summary will be rendered to a summary page. Defaults to `true`",
|
|
474
|
+
"type": "boolean",
|
|
475
|
+
"default": true
|
|
476
|
+
},
|
|
477
|
+
"visibilityFilters": {
|
|
478
|
+
"description": "Specify the default visibility for builtin filters and additional filters according to modifier tags",
|
|
479
|
+
"default": {
|
|
480
|
+
"protected": false,
|
|
481
|
+
"private": false,
|
|
482
|
+
"inherited": true,
|
|
483
|
+
"external": false
|
|
484
|
+
},
|
|
485
|
+
"type": "object",
|
|
486
|
+
"properties": {
|
|
487
|
+
"protected": {
|
|
488
|
+
"type": "boolean"
|
|
489
|
+
},
|
|
490
|
+
"private": {
|
|
491
|
+
"type": "boolean"
|
|
492
|
+
},
|
|
493
|
+
"inherited": {
|
|
494
|
+
"type": "boolean"
|
|
495
|
+
},
|
|
496
|
+
"external": {
|
|
497
|
+
"type": "boolean"
|
|
498
|
+
}
|
|
499
|
+
},
|
|
500
|
+
"patternProperties": {
|
|
501
|
+
"^@": {
|
|
502
|
+
"type": "boolean"
|
|
503
|
+
}
|
|
504
|
+
},
|
|
505
|
+
"additionalProperties": false
|
|
506
|
+
},
|
|
507
|
+
"searchCategoryBoosts": {
|
|
508
|
+
"description": "Configure search to give a relevance boost to selected categories",
|
|
509
|
+
"default": {}
|
|
510
|
+
},
|
|
511
|
+
"searchGroupBoosts": {
|
|
512
|
+
"description": "Configure search to give a relevance boost to selected kinds (eg \"class\")",
|
|
513
|
+
"default": {}
|
|
514
|
+
},
|
|
515
|
+
"useFirstParagraphOfCommentAsSummary": {
|
|
516
|
+
"description": "If set and no @summary tag is specified, TypeDoc will use the first paragraph of comments as the short summary in the module/namespace view",
|
|
517
|
+
"type": "boolean",
|
|
518
|
+
"default": false
|
|
519
|
+
},
|
|
520
|
+
"jsDocCompatibility": {
|
|
521
|
+
"description": "Sets compatibility options for comment parsing that increase similarity with JSDoc comments",
|
|
522
|
+
"anyOf": [
|
|
523
|
+
{
|
|
524
|
+
"type": "boolean"
|
|
525
|
+
},
|
|
526
|
+
{
|
|
527
|
+
"type": "object",
|
|
528
|
+
"properties": {
|
|
529
|
+
"defaultTag": {
|
|
530
|
+
"type": "boolean"
|
|
531
|
+
},
|
|
532
|
+
"exampleTag": {
|
|
533
|
+
"type": "boolean"
|
|
534
|
+
},
|
|
535
|
+
"inheritDocTag": {
|
|
536
|
+
"type": "boolean"
|
|
537
|
+
},
|
|
538
|
+
"ignoreUnescapedBraces": {
|
|
539
|
+
"type": "boolean"
|
|
540
|
+
}
|
|
541
|
+
},
|
|
542
|
+
"additionalProperties": false
|
|
543
|
+
}
|
|
544
|
+
]
|
|
545
|
+
},
|
|
546
|
+
"suppressCommentWarningsInDeclarationFiles": {
|
|
547
|
+
"description": "Prevents warnings due to unspecified tags from being reported in comments within .d.ts files.",
|
|
548
|
+
"type": "boolean",
|
|
549
|
+
"default": true
|
|
550
|
+
},
|
|
551
|
+
"commentStyle": {
|
|
552
|
+
"description": "Determines how TypeDoc searches for comments",
|
|
553
|
+
"enum": [
|
|
554
|
+
"jsdoc",
|
|
555
|
+
"block",
|
|
556
|
+
"line",
|
|
557
|
+
"all"
|
|
558
|
+
],
|
|
559
|
+
"default": "jsdoc"
|
|
560
|
+
},
|
|
561
|
+
"useTsLinkResolution": {
|
|
562
|
+
"description": "Use TypeScript's link resolution when determining where @link tags point. This only applies to JSDoc style comments",
|
|
563
|
+
"type": "boolean",
|
|
564
|
+
"default": true
|
|
565
|
+
},
|
|
566
|
+
"preserveLinkText": {
|
|
567
|
+
"description": "If set, @link tags without link text will use the text content as the link. If not set, will use the target reflection name",
|
|
568
|
+
"type": "boolean",
|
|
569
|
+
"default": true
|
|
570
|
+
},
|
|
571
|
+
"blockTags": {
|
|
572
|
+
"description": "Block tags which TypeDoc should recognize when parsing comments",
|
|
573
|
+
"type": "array",
|
|
574
|
+
"items": {
|
|
575
|
+
"type": "string"
|
|
576
|
+
},
|
|
577
|
+
"default": [
|
|
578
|
+
"@defaultValue",
|
|
579
|
+
"@deprecated",
|
|
580
|
+
"@example",
|
|
581
|
+
"@jsx",
|
|
582
|
+
"@param",
|
|
583
|
+
"@privateRemarks",
|
|
584
|
+
"@remarks",
|
|
585
|
+
"@returns",
|
|
586
|
+
"@see",
|
|
587
|
+
"@throws",
|
|
588
|
+
"@typeParam",
|
|
589
|
+
"@author",
|
|
590
|
+
"@callback",
|
|
591
|
+
"@category",
|
|
592
|
+
"@categoryDescription",
|
|
593
|
+
"@default",
|
|
594
|
+
"@document",
|
|
595
|
+
"@extends",
|
|
596
|
+
"@augments",
|
|
597
|
+
"@yields",
|
|
598
|
+
"@group",
|
|
599
|
+
"@groupDescription",
|
|
600
|
+
"@import",
|
|
601
|
+
"@inheritDoc",
|
|
602
|
+
"@license",
|
|
603
|
+
"@module",
|
|
604
|
+
"@mergeModuleWith",
|
|
605
|
+
"@prop",
|
|
606
|
+
"@property",
|
|
607
|
+
"@return",
|
|
608
|
+
"@satisfies",
|
|
609
|
+
"@since",
|
|
610
|
+
"@sortStrategy",
|
|
611
|
+
"@template",
|
|
612
|
+
"@this",
|
|
613
|
+
"@type",
|
|
614
|
+
"@typedef",
|
|
615
|
+
"@summary",
|
|
616
|
+
"@preventInline",
|
|
617
|
+
"@inlineType",
|
|
618
|
+
"@preventExpand",
|
|
619
|
+
"@expandType"
|
|
620
|
+
]
|
|
621
|
+
},
|
|
622
|
+
"inlineTags": {
|
|
623
|
+
"description": "Inline tags which TypeDoc should recognize when parsing comments",
|
|
624
|
+
"type": "array",
|
|
625
|
+
"items": {
|
|
626
|
+
"type": "string"
|
|
627
|
+
},
|
|
628
|
+
"default": [
|
|
629
|
+
"@link",
|
|
630
|
+
"@inheritDoc",
|
|
631
|
+
"@label",
|
|
632
|
+
"@linkcode",
|
|
633
|
+
"@linkplain",
|
|
634
|
+
"@include",
|
|
635
|
+
"@includeCode"
|
|
636
|
+
]
|
|
637
|
+
},
|
|
638
|
+
"modifierTags": {
|
|
639
|
+
"description": "Modifier tags which TypeDoc should recognize when parsing comments",
|
|
640
|
+
"type": "array",
|
|
641
|
+
"items": {
|
|
642
|
+
"type": "string"
|
|
643
|
+
},
|
|
644
|
+
"default": [
|
|
645
|
+
"@alpha",
|
|
646
|
+
"@beta",
|
|
647
|
+
"@eventProperty",
|
|
648
|
+
"@experimental",
|
|
649
|
+
"@internal",
|
|
650
|
+
"@override",
|
|
651
|
+
"@packageDocumentation",
|
|
652
|
+
"@public",
|
|
653
|
+
"@readonly",
|
|
654
|
+
"@sealed",
|
|
655
|
+
"@virtual",
|
|
656
|
+
"@abstract",
|
|
657
|
+
"@class",
|
|
658
|
+
"@disableGroups",
|
|
659
|
+
"@enum",
|
|
660
|
+
"@event",
|
|
661
|
+
"@expand",
|
|
662
|
+
"@hidden",
|
|
663
|
+
"@hideCategories",
|
|
664
|
+
"@hideconstructor",
|
|
665
|
+
"@hideGroups",
|
|
666
|
+
"@ignore",
|
|
667
|
+
"@inline",
|
|
668
|
+
"@interface",
|
|
669
|
+
"@namespace",
|
|
670
|
+
"@function",
|
|
671
|
+
"@overload",
|
|
672
|
+
"@private",
|
|
673
|
+
"@protected",
|
|
674
|
+
"@showCategories",
|
|
675
|
+
"@showGroups",
|
|
676
|
+
"@useDeclaredType",
|
|
677
|
+
"@primaryExport"
|
|
678
|
+
]
|
|
679
|
+
},
|
|
680
|
+
"excludeTags": {
|
|
681
|
+
"description": "Remove the listed block/modifier tags from doc comments",
|
|
682
|
+
"type": "array",
|
|
683
|
+
"items": {
|
|
684
|
+
"type": "string"
|
|
685
|
+
},
|
|
686
|
+
"default": [
|
|
687
|
+
"@override",
|
|
688
|
+
"@virtual",
|
|
689
|
+
"@privateRemarks",
|
|
690
|
+
"@satisfies",
|
|
691
|
+
"@overload",
|
|
692
|
+
"@inline",
|
|
693
|
+
"@inlineType"
|
|
694
|
+
]
|
|
695
|
+
},
|
|
696
|
+
"notRenderedTags": {
|
|
697
|
+
"description": "Tags which will be preserved in doc comments, but not rendered when creating output",
|
|
698
|
+
"type": "array",
|
|
699
|
+
"items": {
|
|
700
|
+
"type": "string"
|
|
701
|
+
},
|
|
702
|
+
"default": [
|
|
703
|
+
"@showCategories",
|
|
704
|
+
"@showGroups",
|
|
705
|
+
"@hideCategories",
|
|
706
|
+
"@hideGroups",
|
|
707
|
+
"@disableGroups",
|
|
708
|
+
"@expand",
|
|
709
|
+
"@preventExpand",
|
|
710
|
+
"@expandType",
|
|
711
|
+
"@summary",
|
|
712
|
+
"@group",
|
|
713
|
+
"@groupDescription",
|
|
714
|
+
"@category",
|
|
715
|
+
"@categoryDescription"
|
|
716
|
+
]
|
|
717
|
+
},
|
|
718
|
+
"cascadedModifierTags": {
|
|
719
|
+
"description": "Modifier tags which should be copied to all children of the parent reflection",
|
|
720
|
+
"type": "array",
|
|
721
|
+
"items": {
|
|
722
|
+
"type": "string"
|
|
723
|
+
},
|
|
724
|
+
"default": [
|
|
725
|
+
"@alpha",
|
|
726
|
+
"@beta",
|
|
727
|
+
"@experimental"
|
|
728
|
+
]
|
|
729
|
+
},
|
|
730
|
+
"preservedTypeAnnotationTags": {
|
|
731
|
+
"description": "Block tags whose type annotations should be preserved in the output.",
|
|
732
|
+
"type": "array",
|
|
733
|
+
"items": {
|
|
734
|
+
"type": "string"
|
|
735
|
+
},
|
|
736
|
+
"default": []
|
|
737
|
+
},
|
|
738
|
+
"categorizeByGroup": {
|
|
739
|
+
"description": "Specify whether categorization will be done at the group level",
|
|
740
|
+
"type": "boolean",
|
|
741
|
+
"default": false
|
|
742
|
+
},
|
|
743
|
+
"groupReferencesByType": {
|
|
744
|
+
"description": "If set, references will be grouped with the type they refer to rather than in a 'References' group",
|
|
745
|
+
"type": "boolean",
|
|
746
|
+
"default": false
|
|
747
|
+
},
|
|
748
|
+
"defaultCategory": {
|
|
749
|
+
"description": "Specify the default category for reflections without a category",
|
|
750
|
+
"type": "string",
|
|
751
|
+
"default": "Other"
|
|
752
|
+
},
|
|
753
|
+
"categoryOrder": {
|
|
754
|
+
"description": "Specify the order in which categories appear. * indicates the relative order for categories not in the list",
|
|
755
|
+
"type": "array",
|
|
756
|
+
"items": {
|
|
757
|
+
"type": "string"
|
|
758
|
+
},
|
|
759
|
+
"default": []
|
|
760
|
+
},
|
|
761
|
+
"groupOrder": {
|
|
762
|
+
"description": "Specify the order in which groups appear. * indicates the relative order for groups not in the list",
|
|
763
|
+
"type": "array",
|
|
764
|
+
"items": {
|
|
765
|
+
"type": "string"
|
|
766
|
+
},
|
|
767
|
+
"default": []
|
|
768
|
+
},
|
|
769
|
+
"sort": {
|
|
770
|
+
"description": "Specify the sort strategy for documented values",
|
|
771
|
+
"type": "array",
|
|
772
|
+
"items": {
|
|
773
|
+
"enum": [
|
|
774
|
+
"source-order",
|
|
775
|
+
"alphabetical",
|
|
776
|
+
"alphabetical-ignoring-documents",
|
|
777
|
+
"enum-value-ascending",
|
|
778
|
+
"enum-value-descending",
|
|
779
|
+
"enum-member-source-order",
|
|
780
|
+
"static-first",
|
|
781
|
+
"instance-first",
|
|
782
|
+
"visibility",
|
|
783
|
+
"required-first",
|
|
784
|
+
"kind",
|
|
785
|
+
"external-last",
|
|
786
|
+
"documents-first",
|
|
787
|
+
"documents-last"
|
|
788
|
+
]
|
|
789
|
+
},
|
|
790
|
+
"default": [
|
|
791
|
+
"kind",
|
|
792
|
+
"instance-first",
|
|
793
|
+
"alphabetical-ignoring-documents"
|
|
794
|
+
]
|
|
795
|
+
},
|
|
796
|
+
"sortEntryPoints": {
|
|
797
|
+
"description": "If set, entry points will be subject to the same sorting rules as other reflections",
|
|
798
|
+
"type": "boolean",
|
|
799
|
+
"default": true
|
|
800
|
+
},
|
|
801
|
+
"kindSortOrder": {
|
|
802
|
+
"description": "Specify the sort order for reflections when 'kind' is specified",
|
|
803
|
+
"type": "array",
|
|
804
|
+
"items": {
|
|
805
|
+
"type": "string"
|
|
806
|
+
},
|
|
807
|
+
"default": []
|
|
808
|
+
},
|
|
809
|
+
"watch": {
|
|
810
|
+
"description": "Watch files for changes and rebuild docs on change",
|
|
811
|
+
"type": "boolean",
|
|
812
|
+
"default": false
|
|
813
|
+
},
|
|
814
|
+
"preserveWatchOutput": {
|
|
815
|
+
"description": "If set, TypeDoc will not clear the screen between compilation runs",
|
|
816
|
+
"type": "boolean",
|
|
817
|
+
"default": false
|
|
818
|
+
},
|
|
819
|
+
"skipErrorChecking": {
|
|
820
|
+
"description": "Do not run TypeScript's type checking before generating docs",
|
|
821
|
+
"type": "boolean",
|
|
822
|
+
"default": false
|
|
823
|
+
},
|
|
824
|
+
"showConfig": {
|
|
825
|
+
"description": "Print the resolved configuration and exit",
|
|
826
|
+
"type": "boolean",
|
|
827
|
+
"default": false
|
|
828
|
+
},
|
|
829
|
+
"plugin": {
|
|
830
|
+
"description": "Specify the npm plugins that should be loaded. Omit to load all installed plugins",
|
|
831
|
+
"type": "array",
|
|
832
|
+
"items": {
|
|
833
|
+
"type": "string"
|
|
834
|
+
},
|
|
835
|
+
"default": []
|
|
836
|
+
},
|
|
837
|
+
"logLevel": {
|
|
838
|
+
"description": "Specify what level of logging should be used",
|
|
839
|
+
"enum": [
|
|
840
|
+
"Verbose",
|
|
841
|
+
"Info",
|
|
842
|
+
"Warn",
|
|
843
|
+
"Error",
|
|
844
|
+
"None"
|
|
845
|
+
],
|
|
846
|
+
"default": "Info"
|
|
847
|
+
},
|
|
848
|
+
"treatWarningsAsErrors": {
|
|
849
|
+
"description": "If set, all warnings will be treated as errors",
|
|
850
|
+
"type": "boolean",
|
|
851
|
+
"default": false
|
|
852
|
+
},
|
|
853
|
+
"treatValidationWarningsAsErrors": {
|
|
854
|
+
"description": "If set, warnings emitted during validation will be treated as errors. This option cannot be used to disable treatWarningsAsErrors for validation warnings",
|
|
855
|
+
"type": "boolean",
|
|
856
|
+
"default": false
|
|
857
|
+
},
|
|
858
|
+
"intentionallyNotExported": {
|
|
859
|
+
"description": "A list of types which should not produce 'referenced but not documented' warnings",
|
|
860
|
+
"type": "array",
|
|
861
|
+
"items": {
|
|
862
|
+
"type": "string"
|
|
863
|
+
},
|
|
864
|
+
"default": []
|
|
865
|
+
},
|
|
866
|
+
"requiredToBeDocumented": {
|
|
867
|
+
"description": "A list of reflection kinds that must be documented",
|
|
868
|
+
"type": "array",
|
|
869
|
+
"items": {
|
|
870
|
+
"type": "string"
|
|
871
|
+
},
|
|
872
|
+
"default": [
|
|
873
|
+
"Enum",
|
|
874
|
+
"EnumMember",
|
|
875
|
+
"Variable",
|
|
876
|
+
"Function",
|
|
877
|
+
"Class",
|
|
878
|
+
"Interface",
|
|
879
|
+
"Property",
|
|
880
|
+
"Method",
|
|
881
|
+
"Accessor",
|
|
882
|
+
"TypeAlias"
|
|
883
|
+
]
|
|
884
|
+
},
|
|
885
|
+
"packagesRequiringDocumentation": {
|
|
886
|
+
"description": "A list of packages that must be documented",
|
|
887
|
+
"type": "array",
|
|
888
|
+
"items": {
|
|
889
|
+
"type": "string"
|
|
890
|
+
},
|
|
891
|
+
"default": []
|
|
892
|
+
},
|
|
893
|
+
"intentionallyNotDocumented": {
|
|
894
|
+
"description": "A list of full reflection names which should not produce warnings about not being documented",
|
|
895
|
+
"type": "array",
|
|
896
|
+
"items": {
|
|
897
|
+
"type": "string"
|
|
898
|
+
},
|
|
899
|
+
"default": []
|
|
900
|
+
},
|
|
901
|
+
"validation": {
|
|
902
|
+
"description": "Specify which validation steps TypeDoc should perform on your generated documentation",
|
|
903
|
+
"anyOf": [
|
|
904
|
+
{
|
|
905
|
+
"type": "boolean"
|
|
906
|
+
},
|
|
907
|
+
{
|
|
908
|
+
"type": "object",
|
|
909
|
+
"properties": {
|
|
910
|
+
"notExported": {
|
|
911
|
+
"type": "boolean"
|
|
912
|
+
},
|
|
913
|
+
"invalidLink": {
|
|
914
|
+
"type": "boolean"
|
|
915
|
+
},
|
|
916
|
+
"invalidPath": {
|
|
917
|
+
"type": "boolean"
|
|
918
|
+
},
|
|
919
|
+
"rewrittenLink": {
|
|
920
|
+
"type": "boolean"
|
|
921
|
+
},
|
|
922
|
+
"notDocumented": {
|
|
923
|
+
"type": "boolean"
|
|
924
|
+
},
|
|
925
|
+
"unusedMergeModuleWith": {
|
|
926
|
+
"type": "boolean"
|
|
927
|
+
}
|
|
928
|
+
},
|
|
929
|
+
"additionalProperties": false
|
|
930
|
+
}
|
|
931
|
+
]
|
|
932
|
+
},
|
|
933
|
+
"extends": {
|
|
934
|
+
"type": "array",
|
|
935
|
+
"items": {
|
|
936
|
+
"type": "string"
|
|
937
|
+
}
|
|
938
|
+
}
|
|
939
|
+
},
|
|
940
|
+
"allowTrailingCommas": true
|
|
941
|
+
}
|