0.1.5 • Published 12 years ago

doxer v0.1.5

Weekly downloads
4
License
-
Repository
github
Last release
12 years ago

Doxer

Doxer is a port of, and borrows a bit from, Docco but for Dox documentation. Doxer is not perfect and will contains bugs, use at your own risk.

npm install -g doxer
doxer --title "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' });

It will return an object with html and style properties. Where html is the html document and style is Doxer stylesheet.

0.1.5

12 years ago

0.1.4

12 years ago

0.1.3

12 years ago

0.1.2

12 years ago

0.1.1

12 years ago

0.1.0

12 years ago