<commit_before>
         
   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.0-dev.12


                                             /=+===============================+=\
                                            /  :                               :  \
                                            )==:            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

-u|--tutorials 'TUT_DIR'      #'TUT_DIR' (def: '.') used with @tutorial
CONF.opts.tutorials           #Can use TUT_DIR/TUTORIAL.json to specify:
                              #  - title STR: display name (def: TUTORIAL)
                              #  - children 'TUTORIAL2'_ARR: sub-tutorials
                              #Can use {@link} and {@tutorial} inside TUTORIAL.html|md

--private
CONF.opts.private             #BOOL (def: false). Whether to show @private
-a|--access STR|all           #Only show the corresponding visibility<commit_msg>no commit message<commit_after>
         
   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.0-dev.13


                                             /=+===============================+=\
                                            /  :                               :  \
                                            )==:            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
{'fraction_non_alphanumeric': 0.18317911682840593, 'fraction_numerical': 0.0012788685774467764, 'mean_word_length': 1.189033426642516, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 11, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 138, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1465216', 'n_tokens_mistral': 4911, 'n_tokens_neox': 4770, 'n_words': 744}