jsdoc.node.txt

                                  ┏━━━━━━━━━━━┓
                                  ┃   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.4

                                  ┌────────────┐
                                  │   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