0.3.5 • Published 9 years ago
openhost-jsdoc v0.3.5
Openhost JSDoc
JSDoc 3 template for AngularJS.
A simple collection of JSDoc plugin and template for AngularJS.
Features
- Left side table of contents for navigation by Directives, Services, Controllers, etc.
- Right side menu for navigation by component members.
- Read and process @ngdoc tag.
Install
$ npm install jsdoc openhost-jsdoc --save-dev
Run
Run jsdoc command to generate your documentation. All command line options are the options of jsdoc
$ path/to/jsdoc -c path to conf> -t <template> <your source code>
In example,
`$ node_modules/jsdoc/jsdoc.js -c node_modules/openhost-jsdoc/conf -t node_modules/openhost-jsdoc/template -r myDir`
Run with gulp-jsdoc
install gulp-jsdoc
$ npm install gulp-shell --save-dev
add the following to the gulpfile.json
var shell = require('gulp-shell'); gulp.task('docs', shell.task([ 'node_modules/jsdoc/jsdoc.js '+ '-c node_modules/openhost-jsdoc/conf.json '+ // config file '-t node_modules/openhost-jsdoc/template '+ // template file '-d build/docs '+ // output directory '-r app/scripts' // source code directory ]));
- run gulp task
$ gulp docs