lexicon
api documentation generator
Getting Started
Install the module with: npm install lexicon
Using from the commandline
lexicon file1.js file2.js file3.js -f json > doc.jsonlexicon file1.js file2.js file3.js -f markdown > doc.mdlexicon -i src -o docs -f markdown
Using the API
var lexicon = parser = lexiconparser formatter = lexiconformatter;console;
Documentation
(Coming soon)
Testing
Testing is done using buster thru grunt-buster plugin.
grunt buster
or simply grunt
which will run the code with lint.
Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.
Release History
0.2.11 fixed missing square brackets in optional params
License
Copyright (c) 2012 kates
Licensed under the MIT license.