jsdoc-sphinx/template/view-models/doclet.js

A JSDoc3 template which output ReStructured Text for Sphinx Doc

var _ = require('lodash');
var util = require('../util');
var logger = require('jsdoc/util/logger');
module.exports = docletModel;

/**
 * The Mustache ViewModel to render a doclet.
 * @param  {object} doclet the doclet to render
 * @return {function}      the template helper func
 */
function docletModel(doclet) {
  return function(context, cb) {
    logger.debug('doclet', doclet);
    var viewModel = _.extend({},
      util.rstMixin,
      util.docletChildren(context, doclet, util.mainDocletKinds),
      // (doclet.kind === 'module' ? {} :
      //   util.docletChildren(context, doclet, util.subDocletKinds)
      // ), {
      util.docletChildren(context, doclet, util.subDocletKinds), {
        doclet: doclet,
        example: util.example
      }
    );
    util.view('doclet.rst', viewModel, cb);
  };
}