chore(doc-gen): track modules in a dgeni service

This commit is contained in:
Peter Bacon Darwin 2015-03-17 16:41:54 +00:00 committed by Misko Hevery
parent a16954d3a5
commit ede7690be3
3 changed files with 8 additions and 1 deletions

View File

@ -13,6 +13,7 @@ var GUIDES_PATH = PARTIAL_PATH + '/guides';
module.exports = new Package('angular', [jsdocPackage, nunjucksPackage])
// Register the services and file readers
.factory(require('./services/modules'))
.factory(require('./services/atParser'))
.factory(require('./services/getJSDocComment'))
.factory(require('./services/SourceFile'))
@ -44,6 +45,7 @@ module.exports = new Package('angular', [jsdocPackage, nunjucksPackage])
readFilesProcessor.fileReaders = [atScriptFileReader, ngdocFileReader];
readFilesProcessor.basePath = path.resolve(__dirname, '../..');
readFilesProcessor.sourceFiles = [
{ include: 'modules/*/*.js', basePath: 'modules' },
{ include: 'modules/*/src/**/*.js', basePath: 'modules' },
{ include: 'modules/*/docs/**/*.md', basePath: 'modules' },
{ include: 'docs/content/**/*.md', basePath: 'docs/content' }

View File

@ -7,7 +7,7 @@ var path = require('canonical-path');
* This file reader will create a simple doc for each
* file including a code AST of the AtScript in the file.
*/
module.exports = function atScriptFileReader(log, atParser) {
module.exports = function atScriptFileReader(log, atParser, modules) {
var reader = {
name: 'atScriptFileReader',
defaultPattern: /\.js$/,
@ -18,6 +18,8 @@ module.exports = function atScriptFileReader(log, atParser) {
moduleDoc.id = moduleDoc.moduleTree.moduleName;
moduleDoc.aliases = [moduleDoc.id];
modules[moduleDoc.id] = moduleDoc;
// Readers return a collection of docs read from the file
// but in this read there is only one document (module) to return
return [moduleDoc];

View File

@ -0,0 +1,3 @@
module.exports = function modules() {
return {};
};