UNPKG

typedoc

Version:

Create api documentation for TypeScript projects.

typedoc.org

TypeStrong/TypeDoc

101 lines (100 loc) • 2.39 kB
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
import * as TagDefaults from "./tsdoc-defaults.js"; /** * Default values for TypeDoc options. This object should not be modified. * * @privateRemarks * These are declared here, rather than within the option declaration, so that * they can be exposed as a part of the public API. The unfortunate type declaration * is to control the type which appears in the generated documentation. */ export const OptionDefaults = { excludeNotDocumentedKinds: [ "Module", "Namespace", "Enum", // Not including enum member here by default "Variable", "Function", "Class", "Interface", "Constructor", "Property", "Method", "CallSignature", "IndexSignature", "ConstructorSignature", "Accessor", "GetSignature", "SetSignature", "TypeAlias", "Reference", ], excludeTags: [ "@override", "@virtual", "@privateRemarks", "@satisfies", "@overload", "@inline", ], blockTags: TagDefaults.blockTags, inlineTags: TagDefaults.inlineTags, modifierTags: TagDefaults.modifierTags, cascadedModifierTags: ["@alpha", "@beta", "@experimental"], notRenderedTags: [ "@showCategories", "@showGroups", "@hideCategories", "@hideGroups", "@expand", "@summary", "@group", "@groupDescription", "@category", "@categoryDescription", ], highlightLanguages: [ "bash", "console", "css", "html", "javascript", "json", "jsonc", "json5", "yaml", "tsx", "typescript", ], sort: ["kind", "instance-first", "alphabetical-ignoring-documents"], kindSortOrder: [ "Document", "Project", "Module", "Namespace", "Enum", "EnumMember", "Class", "Interface", "TypeAlias", "Constructor", "Property", "Variable", "Function", "Accessor", "Method", "Reference", ], requiredToBeDocumented: [ "Enum", "EnumMember", "Variable", "Function", "Class", "Interface", "Property", "Method", "Accessor", "TypeAlias", ], };