dgeni-packages/dgeni/index.js

A collection of dgeni packages for generating documentation from source code

const Package = require('dgeni').Package;
const path = require('canonical-path');

/**
 * @dgPackage dgeni
 * @description Support for documenting Dgeni packages (incomplete)
 */
module.exports = new Package('dgeni', [
  require('../jsdoc'),
  require('../nunjucks'),
  require('../links')
])

.processor(require('./processors/readPackageInfo'))
.processor(require('./processors/filterJSFileDocs'))
.processor(require('./processors/checkDocsHavePackage'))
.processor(require('./processors/wireUpServicesToPackages'))
.processor(require('./processors/generateIndex'))
.processor(require('./processors/computeProcessorPipeline'))

.config(function(parseTagsProcessor, getInjectables) {
  parseTagsProcessor.tagDefinitions = parseTagsProcessor.tagDefinitions.concat(
    getInjectables([
      require('./tag-defs/dgPackage'),
      require('./tag-defs/dgService'),
      require('./tag-defs/dgProcessor')
    ]));
})

.config(function(computeIdsProcessor) {
  computeIdsProcessor.idTemplates.push({
    docTypes: ['dgPackage', 'indexPage'],
    idTemplate: '${name}',
    getAliases(doc) { return [doc.id]; }
  });

  computeIdsProcessor.idTemplates.push({
    docTypes: ['dgProcessor', 'dgService'],
    idTemplate: '${packageDoc.id}.${name}',
    getAliases(doc) { return [doc.name, doc.id]; }
  });
});
  // TODO: When using this package you will need to provide
  // * path templates to the computePathsProcessor for indexPage, dgPackage, dgProcessor and dgService
  // * rendered content templates to the templateFinder