JS-Doc

JavaDoc for JavaScript

JS-Doc is a simple, easy documentation generator for any javascript projects. All commenting above functions/variables/constants to be included should be in JavaDoc format (example below).

Syntax

In the files you include with the --files argument, use the following comment syntax:

/**
_markdown formatted_ description for following variable/function
@property <-- that's bolded
*/
var myVar='Hello, World!';

This will yield

## myVar  
`var myVar='Hello, World!'`  
_markdown formatted_ description for following variable/function

**property** <-- that's bolded

Usage

from -h

  -h, --help           Show this help message and exit.
  -v, --version        Show program's version number and exit.
  -o file, --out file  set output file
  -p path, --pkg path  path to package.json
  --files [f [f ...]]  files to document
  --html               generate html instead of markdown
  -c file, --css file  path to css file (default: github css)