[not maintained anymore] Doxer is port of Docco for Dox documentation
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
resources
.gitignore
.npmignore
History.md
README.md
index.js
package.json

README.md

Doxer

Doxer is a port of, and borrows heavily from, Docco but for Dox documentation. Doxer is not perfect and maybe contains bugs.

Docco -- the original quick-and-dirty, hundred-line-long,literate-programming-style documentation generator in CoffeeScript.

Example page

Installation

Install from npm:

$ npm install -g doxer

Usage

Usage: doxer [options] <file ...>

Options:

  -h, --help             output usage information
  -V, --version          output the version number
  -t, --title [title]    doxer title, default file name
  -d, --dir [directory]  output directory

Usage example

$ doxer lib/*

Will only take .js and .coffee files, other will not be touched. After generating the documentation it will save doxer.css in output directory and a html for each JavaScript or CoffeeScript files.

Supported top comments

/*!
 * Project comment
 * ...
 * ... 
 */
 
// Project comment
// ...
// ...

// Project comment

// ...
// ...