Skip to content

Commit ede7690

Browse files
petebacondarwinmhevery
authored andcommitted
chore(doc-gen): track modules in a dgeni service
1 parent a16954d commit ede7690

3 files changed

Lines changed: 8 additions & 1 deletion

File tree

docs/dgeni-package/index.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ var GUIDES_PATH = PARTIAL_PATH + '/guides';
1313
module.exports = new Package('angular', [jsdocPackage, nunjucksPackage])
1414

1515
// Register the services and file readers
16+
.factory(require('./services/modules'))
1617
.factory(require('./services/atParser'))
1718
.factory(require('./services/getJSDocComment'))
1819
.factory(require('./services/SourceFile'))
@@ -44,6 +45,7 @@ module.exports = new Package('angular', [jsdocPackage, nunjucksPackage])
4445
readFilesProcessor.fileReaders = [atScriptFileReader, ngdocFileReader];
4546
readFilesProcessor.basePath = path.resolve(__dirname, '../..');
4647
readFilesProcessor.sourceFiles = [
48+
{ include: 'modules/*/*.js', basePath: 'modules' },
4749
{ include: 'modules/*/src/**/*.js', basePath: 'modules' },
4850
{ include: 'modules/*/docs/**/*.md', basePath: 'modules' },
4951
{ include: 'docs/content/**/*.md', basePath: 'docs/content' }

docs/dgeni-package/readers/atScript.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ var path = require('canonical-path');
77
* This file reader will create a simple doc for each
88
* file including a code AST of the AtScript in the file.
99
*/
10-
module.exports = function atScriptFileReader(log, atParser) {
10+
module.exports = function atScriptFileReader(log, atParser, modules) {
1111
var reader = {
1212
name: 'atScriptFileReader',
1313
defaultPattern: /\.js$/,
@@ -18,6 +18,8 @@ module.exports = function atScriptFileReader(log, atParser) {
1818
moduleDoc.id = moduleDoc.moduleTree.moduleName;
1919
moduleDoc.aliases = [moduleDoc.id];
2020

21+
modules[moduleDoc.id] = moduleDoc;
22+
2123
// Readers return a collection of docs read from the file
2224
// but in this read there is only one document (module) to return
2325
return [moduleDoc];
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = function modules() {
2+
return {};
3+
};

0 commit comments

Comments
 (0)