doxer

Doxer

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

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
  -d, --dir [directory]  output directory

Usage example

$ doxer -t "project name" source.js

Will save doxer.html and doxer.css in docs directory after generating the documentation.

Supported top comments

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

// Project comment

// ...
// ...

Using Doxer inside your code

var doxer = require('doxer');

doxer.process({ files: [], title: 'Title' }, function (res) {
  // res.html is the html document
  // res.style is Doxer stylesheet
});

files can be a string containg source code, path to filename or array with files.