source code document

It’s always good to write source code document. As it’s said better written than remember nothing.

Recently， I was involved in one js project. And the project contains basic control and app develop framework. So it’s a must to have clearlly wirten APIs.

We choose js doc as the tools.

First, install the tools

sudo npm install git+https://github.com/jsdoc3/jsdoc.git
sudo npm install ink-docstrap

Secondly, setup configuration.json file

Finally, run

jsdoc -c ./configuration.json -t $TemplatePath -d ./docstrap_doc

where $TemplatePath, is node_modules/ink-docstrap/template

---

After that, you have got bunches of .xml files. And you can put in in some website. They are static web sites.