Currently the project is under development and it is not heavily tested, but seems to be working. The code ported from jsdocs-toolkit is very messy and it was not designed for modular systems conforming Securable Modules specification, therefore a major refactoring still has to be done. The template system is likely to be changed as it is really tied to the model now. Everyone is more than welcome to help with it!
To start working with JSDoc, checkout the Narhwal and JSDoc repositories and add narwhal/bin to your PATH environment variable (e.x. "export PATH=$PATH:narwhal/bin"). Currently you need to use relative path symlinks to integrate with Narwhal.
cd narwhal/packages/ ln -s ../../jsdocs jsdocs
cd ../bin ln -s ../../jsdocs/bin/jsocs jsdocs
After that you should be able to run tool by typing:
jsdocs -t jsdocs/templates/jsdoc/ bespinserv/lib/
-t points to the folder with template to be used. In the root of the repository you can find the templates/ folder with a jsdoc/ subfolder. Thats an example of a template (jsdoc-toolkit templates are not compatible). The second argument is the path to folder containing sources that will be documented.
For more additional info run:
- Irakli Gozalishvili