dgeni-packages/jsdoc/processors/code-name.js

A collection of dgeni packages for generating documentation from source code

/**
 * @dgProcessor codeNameProcessor
 * @description  Infer the name of the document from name of the following code
 */
module.exports = function codeNameProcessor(log, codeNameService) {
  return {
    $runAfter: ['files-read'],
    $runBefore: ['processing-docs'],
    $process(docs) {
      docs.forEach(doc => {
        doc.codeName = doc.codeName || (doc.codeNode && codeNameService.find(doc.codeNode)) || null;
        if ( doc.codeName ) {
          log.silly('found codeName: ', doc.codeName);
        }
      });
      return docs;
    }
  };
};