suh-dgeni-ngdocs/src/processors/module-docs.js

A package to generate ng-docs similar to what is used on AngularJS website.

var _ = require('lodash');

/**
 * @dgProcessor moduleDocsProcessor
 * @description
 * Compute the various fields for modules
 */
module.exports = function(conf){
  return function moduleDocsProcessor2(log, aliasMap, moduleMap, createDocMessage) {
    return {
      $runAfter: ['ids-computed', 'memberDocsProcessor'],
      $runBefore: ['computing-paths'],
      $process: function(docs) {
        var parts;

        // Compute some extra fields for docs in the API area
        _.forEach(docs, function(doc){
          if (doc.docType === 'module'){
            doc.angularJSVersion = 'Suhail';
            doc.packageFile = 'Suhail.js';
          }
        });
        // /*_.forEach(docs, function(doc) {

        //   if ( doc.docType === 'module' ) {

        //     moduleMap.set(doc.id, doc);

        //     // Create a place to store references to the module's components
        //     doc.components = [];


        //     // Compute the package name and filename for the module
        //     var match = /^ng(.*)/.exec(doc.name);
        //     if ( match ) {
        //       if ( !doc.packageName ) {
        //         var packageName = match[1].toLowerCase();
        //         if ( packageName ) { packageName = '-' + packageName; }
        //         doc.packageName = 'angular' + packageName;
        //       }
        //       doc.packageFile = doc.packageName + '.js';
        //     }
        //   }
        // });


        // // Attach each doc to its module
        // _.forEach(docs, function(doc) {
        //   if ( doc.docType !== 'module' && doc.module ) {
        //     var matchingModules = aliasMap.getDocs(doc.module);

        //     if ( matchingModules.length > 1 ) {
        //       // try matching with the 'module:' specifier
        //       matchingModules = aliasMap.getDocs('module:' + doc.module);
        //     }

        //     if ( matchingModules.length === 1 ) {
        //       var module = matchingModules[0];
        //       if (module.docType === 'module') {
        //         module.components.push(doc);
        //       } else {
        //         throw new Error(createDocMessage('"' + module.name + '" is not a module. It is documented as "' + module.docType + '". Either the module is incorrectly typed or the module reference is invalid', doc));
        //       }
        //       doc.moduleDoc = module;
        //     } else if ( matchingModules.length > 1 ) {
        //       var error = createDocMessage('Ambiguous module reference: "' + doc.module + '"', doc);
        //       error += '\nMatching modules:\n';
        //       _.forEach(matchingModules, function(mod) {
        //         error += '- ' + mod.id + '\n';
        //       });
        //       throw new Error(error);
        //     }
        //   }
        // });

      }
    };
  };
};