OnWorks favicon

jsdoc - Online in the Cloud

Run jsdoc in OnWorks free hosting provider over Ubuntu Online, Fedora Online, Windows online emulator or MAC OS online emulator

This is the command jsdoc that can be run in the OnWorks free hosting provider using one of our multiple free online workstations such as Ubuntu Online, Fedora Online, Windows online emulator or MAC OS online emulator



jsdoc - automatic generator for HTML documentation of Javascript sources


jsdoc {-d=<PATH> | --directory=<PATH>} [options] <SRC_DIR_OR_FILE> ...

jsdoc [{-h | --help}]


This manual page documents briefly the jsdoc command.

jsdoc is application, written in JavaScript, for automatically generating
template-formatted, multi-page HTML (or XML, JSON, or any other text-based) documentation
from commented JavaScript source code.


The program follows the usual GNU command line syntax, with long options starting with two
dashes (`-'). A summary of options is included below. For a complete description, see the
info(1) files.

-a, --allfunction
Include all functions, even undocumented ones.

-c, --conf
Load a configuration file.

-d=<PATH>, --directory=<PATH>
Output to this directory (required parameter).

-D="myVar:My value", --define="myVar:My value"
Multiple. Define a variable, available in JsDoc as JSDOC.opt.D.myVar.

-e=<ENCODING>, --encoding=<ENCODING>
Use this encoding to read and write files.

-E="REGEX", --exclude="REGEX"
Multiple. Exclude files based on the supplied regex.

-h, --help
Show this message and exit.

-m, --multiples
Don't warn about symbols being documented more than once.

-n, --nocode
Ignore all code, only document comments with @name tags.

-o=<PATH>, --out=<PATH>
Print log messages to a file (defaults to stdout).

-p, --private
Include symbols tagged as private, underscored and inner symbols.

-q, --quiet
Do not output any messages, not even warnings.

-r=<DEPTH>, --recurse=<DEPTH>
Descend into src directories.

-s, --suppress
Suppress source code output.

-S, --securemodules
Use Secure Modules mode to parse source code.

-t=<PATH>, --template=<PATH>
Use this template to format the output.

-T, --test
Run all unit tests and exit.

-u, --unique
Force file names to be unique, but not based on symbol names.

-v, --verbose
Provide verbose feedback about what is happening.

-x=<EXT>[,EXT]..., --ext=<EXT>[,EXT]...
Scan source files with the given extension/s (defaults to js).

Use jsdoc online using onworks.net services