-
Notifications
You must be signed in to change notification settings - Fork 16
/
typedoc.node.txt
207 lines (153 loc) · 11.4 KB
/
typedoc.node.txt
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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
TYPEDOC
ALTERNATIVES ==> #See also documentation of generators from code comments (JSDoc)
VERSION ==> #0.22.0-beta.6
/=+===============================+=\
/ : : \
)==: TAGS :==(
\ :_______________________________: /
\=+===============================+=/
TAGS ==> #Most tags are infered, i.e. only support the following JSDoc tags:
# @param VAR [- COMMENT]
# @returns COMMENT
# @event
# @ignore
# @link[code|plain]
#And TypeScript:
# @template [{TYPE3}] T,... [- COMMENT]
#With additional:
# @typeparam VAR [- COMMENT] (<T> generic)
# @preferred (when several NAMESPACEs in different files, which one to pick)
# @hidden: hide overloads
# @inheritDoc
#Other @TAG are shown as is.
```[LANG]
... #Instead of @example
``` #This works with VSCode (it does syntax highlighting)
TYPE #Not used since infered.
INFERENCE ==> #Guesses:
# - @type
# - @constant|readonly|default
# - @file:
# - top-level comment is used as @file
# - must be followed by another block comment
# - can use @packageDocumentation too
# - @private|protected|public|access
# - @namespace|memberof|member|property
# - @inner|instance|static
# - @enum
# - @function|param|returns
# - @async|generator|yields
# - @constructs|class|interface|augments|implements
/=+===============================+=\
/ : : \
)==: LINKS :==(
\ :_______________________________: /
\=+===============================+=/
[[VARR]] #Instead of VAR, to use in COMMENTs
[[includes:FILENAME]] #In TAGs comments, include text content of INCLUDE_DIR/FILENAME
--includes INCLUDE_DIR #
media://FILENAME #In TAGs comments, include image|video content of MEDIA_DIR/FILENAME
--media MEDIA_DIR #
--gitRevision #Which Git COMMIT to use in GitHub links (def: "latest")
--gitRemote #Def: 'origin'
--listInvalidSymbolLinks #Show dead links
/=+===============================+=\
/ : : \
)==: CONFIG :==(
\ :_______________________________: /
\=+===============================+=/
CONF #Is either:
# - --options CONF.json
# - TSCONF.typedocOptions OBJ
# - ./typedoc.json
# - CLI flags
CONF.extends #'PATH' to JSON file to merge
--tsconfig CONF #TypeScript TSCONF file (def: ./tsconfig.json)
TSC OPTIONS ==> #Any tsc option can be used
--ignoreCompilerErrors #Do not stop on tsc errors
/=+===============================+=\
/ : : \
)==: CLI :==(
\ :_______________________________: /
\=+===============================+=/
typedoc FILE... #Generate documentation.
#Also runs tsc
#Document all variables, exported or not.
#Document imported files, excluding node modules.
/=+===============================+=\
/ : : \
)==: PROGRAMMATIC :==(
\ :_______________________________: /
\=+===============================+=/
TYPEDOC.*(...) #Programmatic usage. Document only if needed
GULP-TYPEDOC(CONF_OBJ) ##Gulp plugin (3.0.0)
/=+===============================+=\
/ : : \
)==: FILE SELECTION :==(
\ :_______________________________: /
\=+===============================+=/
--includeDeclarations #Do not exclude *.d.ts
--exclude 'GLOB' #Exclude files|dirs. Can use '!GLOB'
--excludeNotExported #Exclude non-exported VARs
--excludeNotDocumented #Exclude non-documented VARs
--excludeProtected|Private #Exclude @protected|private VARs
--excludeTags 'TAG'_ARR #Exclude specific TAGs
--excludeExternals #Exclude external files, i.e. not specified in input FILE...
#There's a plugin typedoc-plugin-internal-external to allow overriding using
#@internal|external, but that's not useful
--excludeInternal #Exclude statements preceded with /** @internal */
--externalPattern 'GLOB' #What "external files" means
--packages DIR #When using monorepos (def: guessed)
/=+===============================+=\
/ : : \
)==: MODULES :==(
\ :_______________________________: /
\=+===============================+=/
--mode STR #Either:
# - 'modules' (def): separate each file
# - 'file': flatten into a single file
--entryPoint 'VAR' #Main VAR (def: global)
@category CATEGORY #Put codes into different groups
--categorizeByGroup #
--defaultCategory CATEGORY #Def: 'other'
--categoryOrder CATEGORY,... #Def: alphabetical. CATEGORY can be '*' for "others"
@module MODULE ##Can be used to organize files into MODULEs
##Only with typedoc-plugin-external-module-name (4.0.6)
##The MODULE entry point should include @preferred and the module description.
##The comment block should start with @packageDocumentation @module not the description.
/=+===============================+=\
/ : : \
)==: OUTPUT :==(
\ :_______________________________: /
\=+===============================+=/
--out DIR #HTML output (def: './docs')
--disableOutputCheck #Do not check|clean output DIR
--json FILE.json #JSON output
--pretty #Indent JSON
--logger STR #Either 'console' (def) or 'none' (silent)
--treatWarningsAsErrors #Def: false
--watch #
--preserveWatchOutput #
--emit #
--name #Project name (def: PACKAGE.name)
--includeVersion #Include project version
--readme PATH.md #Add README to main page (def: guessed)
--toc PATH.md #Add table of contents.
--theme 'MODULE' #HTML theme. Available:
# - 'default' (def, preferred): HTML
# - 'minimal': HTML
## - 'markdown':
## - typedoc-plugin-markdown (3.11.7)
--highlightTheme STR #Code theme using highlight
--platform STR ##Markdown hosting platform 'docusaurus|gitbook|vuepress|bitbucket'
##Only with --theme markdown
--hideSources ##Do not link to source files
##Only with --theme markdown
--disableSources #Do not show link to sources
--hideGenerator #Do not print "generatd by TypeDoc" footer
--gaID STR #Google Analytics tracking ID
--gaSite STR #Google Analytics site name
--plugin 'MODULE' #Automatically guessed if in node_modules/**, i.e. do not need to specify
TYPEDOC-PLUGIN-LOCALIZATION ==> #l10n plugin. Document only if needed