Dox

Dox parses JavaScript code, extracting code comments and assembling them into a documentation page created using Markdown and JSDoc tags.

The generated documentation page is contained in one file, with no external JS or CSS files.

Dox comes as an easy to use executable, as well as a single deployment file.

Dox was built to be used from the Node.js CLI only.

What is new in this release:

• Added:
• Support for @description tag
• Context match for returned closure
• Tags without descriptions now have an HTML property containing a markdown parse of the tag's contents
• Fixes:
• More agnostic to code style when parsing contexts (eg, no longer ignores functions without spaces between function name and parenthesis)
• No longer incorrectly tries to parse strings inside comments, causing large chunks of a file to be ignored.
• No longer parses double slash in a string literal as being a comment start.

What is new in version 0.7.1:

• Added:
• Support for @description tag
• Context match for returned closure
• Tags without descriptions now have an HTML property containing a markdown parse of the tag's contents
• Fixes:
• More agnostic to code style when parsing contexts (eg, no longer ignores functions without spaces between function name and parenthesis)
• No longer incorrectly tries to parse strings inside comments, causing large chunks of a file to be ignored.
• No longer parses double slash in a string literal as being a comment start.

What is new in version 0.5.1:

• Fixed:
• */* breaks parsing

What is new in version 0.4.6:

• Do not wrap @example contents with Markdown.

What is new in version 0.4.4:

• Added support for variable names containing "$".

What is new in version 0.4.2:

• Prevent error when using --api & comments have no example code.

What is new in version 0.4.1:

• Change # to . in --api.

What is new in version 0.4.0:

• Added gfm code blocks.
• Removed implicit titles.

What is new in version 0.3.3:

• Fixed --api .receiver.

What is new in version 0.3.1:

• Fixed annoying title bug.

What is new in version 0.2.0:

• Added -r, --raw support.

What is new in version 0.1.3:

• Added: allow arbitrary tags.
• Fixed function whitespace.

What is new in version 0.1.2:

• Removed HTML escaping for now.

What is new in version 0.1.1:

• Fixed:
• Colons in comment lines not intended as headers.

What is new in version 0.0.5:

• Adding "main" to package descriptor since "directories" are no longer supported.

What is new in version 0.0.4:

• Added --intro support for including an intro file written in markdown.

Requirements:

• Node.js