-
Notifications
You must be signed in to change notification settings - Fork 16
/
jsdoc.node.txt
122 lines (91 loc) · 6.95 KB
/
jsdoc.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
JSDOC
ALTERNATIVES ==> # - jsdoc: original one, most well known, not maintained well, tags are re-used by many projects
# - documentation.js (preferred): nice output, re-use jsdoc tags, linter
# - esdoc: similar jsdoc tags (use most, add few), use TypeScript TYPEs, not well maintained
# - dox: use jsdoc tags, Markdown only, not maintained
#See also documentation of generators from code itself (typedoc)
TYPES AND TAGS ==> #See JSDoc tags documentation
VERSION ==> #4.0.2
/=+===============================+=\
/ : : \
)==: CONFIG :==(
\ :_______________________________: /
\=+===============================+=/
CONF #Uses:
# - -c|--configure CONF_FILE.json
# - ./conf.json
/=+===============================+=\
/ : : \
)==: FILE SELECTION :==(
\ :_______________________________: /
\=+===============================+=/
jsdoc FILE... #Generates HTML documentation with:
# - content based on /** */ comments
# - non-documented members are not shown
# - links to source code
# - README.md content, parsed to HTML
# - package.json information
CONF.source #Source FILE|DIR... to document
CONF.source.include|exclude #'PATH'_ARR
CONF.source.includePattern #'REGEXP' (def: *.js[doc])
CONF.source.excludePattern #'REGEXP' (def: _*)
-r|--recurse
CONF.opts.recurse #BOOL (def: false). Allow FILE|DIR... instead of FILE...
CONF.recurseDepth #NUM
-R|--readme
CONF.opts.readme #'PATH' to project's README (def: any from source FILE|DIR...)
-P|--package
CONF.opts.package #'PATH' to project's package.json (def: any from source FILE|DIR...)
-d|--destination DIR2
CONF.opts.destination #Output 'DIR2' (def: '.'). Can be 'console'
-X|--explain
CONF.opts.explain #BOOL (def: false). Output in JSON to stdout instead
/=+===============================+=\
/ : : \
)==: PARSING :==(
\ :_______________________________: /
\=+===============================+=/
-l|--lenient
CONF.opts.lenient #BOOL (def: false). Don't exit on errors
--pedantic
CONF.opts.pendantic #BOOL (def: false). Treat warnings as errors
CONF.tags.allowUnknownTags #BOOL (def: true). do not throw on @unknown_tag
-e|--encoding STR
CONF.opts.encoding #STR (def: 'utf8')
CONF.sourceType #'module' (def) or 'script'
/=+===============================+=\
/ : : \
)==: TEMPLATES :==(
\ :_______________________________: /
\=+===============================+=/
-t|--template #HTML template, using DIR/publish.js
CONF.opts.template 'DIR' #Built-in ones:
# - 'default'
# - 'silent'
## - docdash (see online doc)
CONF.templates.default #CONFT. Configuration for the default template
CONFT.outputSourceFiles #BOOL (def: true). Show|link to source files.
CONFT.staticFiles #OBJ. Same shape as CONF.source.
#Source files to copy to output directory (e.g. images).
CONFT.includeDate #BOOL (def: true). Show current date in footer
CONFT.includeLongnameInNav #If false (def), shorten names in navigation bar.
CONFT.layoutFile #'PATH' to custom HTML layout
CONF.plugins #'MODULE|PATH'_ARR
'plugins/markdown' #PLUGIN bundled with jsdoc. Allows Markdown in COMMENTs
#Uses marked parser
CONF.markdown.tags #STR_ARR. Additional tags to parse Markdown->HTML, beyond "author|description|classdesc|param|property|returns|throws|see"
CONF.markdown.excludeTags #STR_ARR. Inverse
CONF.markdown.hardwrap #BOOL (def: false)
CONF.markdown.idInHeadings #BOOL (def: false). Add HTML id attributes based on COMMENTs
/=+===============================+=\
/ : : \
)==: LINKS :==(
\ :_______________________________: /
\=+===============================+=/
CONF.templates.monospaceLinks #BOOL (def: false): imply @linkcode for VAR|URL
CONF.templates.cleverLinks #BOOL (def: false): imply @linkcode for VAR
--private
CONF.opts.private #BOOL (def: false). Whether to show @private
-a|--access STR|all #Only show the corresponding visibility