jsdoc: generate modules for sensor groups; customize yuidoc templates for displaying sensor groups by categories & connection types

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Heidi Pan
2015-05-21 10:09:48 -07:00
committed by Mihai Tudor Panu
parent ed52f0e5cb
commit 33b508110e
14 changed files with 2150 additions and 116 deletions

View File

@ -35,7 +35,7 @@ var xml2js = require('./xml2js')
_.extend(opts, { addOptions: function(module) { return module.addOptions(opts); } });
opts
.option('-m, --module [module]', 'module name for which to build documentation', 'mraa')
.option('-f, --formats [formats]', 'format for js comments', 'jsdoc,yuidoc,ternjs')
.option('-f, --formats [formats]', 'format for js comments', 'yuidoc,ternjs')
.option('-o, --outdir [directory]', 'top directory to build documentation', __dirname + '/jsdoc')
.addOptions(xml2js)
.parse(process.argv);
@ -44,12 +44,14 @@ opts
// use promise-style programming rather than spaghetti callbacks
Promise.promisifyAll(fs);
// TODO: create directory structure if doesn't exist
var formats = opts.formats.split(',');
formats.forEach(function(format){
mkdirp('jsdoc/' + format + '/' + opts.module);
});
// main
xml2js.parse().then(function(specjs) {
Promise.all(_.map(formats, function(format) {