PDOC documenter for Node.JS
Be warned, it's currently extremely hacky, just a proof of concept.
git clone git://github.com/andris9/node-pdoc.git
npm install optimist(command line parser)
npm install node-markdown(markdown parser)
node pdoc.js -i include_dir -o docs.html
- -i directory where the .js files reside. Nested directories are supported.
- -o single file for the final documentation. Optional, defaults to docs-timestamp.html
See output.html in examples directory - it is created from source.js with node-pdoc. You can re-create the file with
node pdoc.js -i examples -o examples/output.html
Node-pdoc doesn't support Prototype classes and mixins. Currently constants are also not supported. Everything else should be quite fine.
See PDOC manual for documentation.
Add PDOC compatible comments to node-pdoc source. Currently comments are extremely sparse :S