diff --git a/docs/dgeni-package/index.js b/docs/dgeni-package/index.js index 1be0bbf6fb..db3c8c60ad 100644 --- a/docs/dgeni-package/index.js +++ b/docs/dgeni-package/index.js @@ -42,6 +42,7 @@ module.exports = new Package('angular', [jsdocPackage, nunjucksPackage]) .processor(require('./processors/processClassDocs')) .processor(require('./processors/generateNavigationDoc')) .processor(require('./processors/extractTitleFromGuides')) +.processor(require('./processors/createOverviewDump')) // Configure the log service .config(function(log) { diff --git a/docs/dgeni-package/processors/createOverviewDump.js b/docs/dgeni-package/processors/createOverviewDump.js new file mode 100644 index 0000000000..c0c1d60d08 --- /dev/null +++ b/docs/dgeni-package/processors/createOverviewDump.js @@ -0,0 +1,24 @@ +var _ = require('lodash'); + +module.exports = function createOverviewDump() { + + return { + $runAfter: ['processModuleDocs', 'processClassDocs'], + $runBefore: ['docs-processed'], + $process: function(docs) { + var overviewDoc = { + id: 'overview-dump', + aliases: ['overview-dump'], + path: 'overview-dump', + outputPath: 'overview-dump.html', + modules: [] + }; + _.forEach(docs, function(doc) { + if ( doc.docType === 'module' ) { + overviewDoc.modules.push(doc); + } + }); + docs.push(overviewDoc); + } + }; +}; \ No newline at end of file diff --git a/docs/dgeni-package/templates/overview-dump.template.html b/docs/dgeni-package/templates/overview-dump.template.html new file mode 100644 index 0000000000..98680760fb --- /dev/null +++ b/docs/dgeni-package/templates/overview-dump.template.html @@ -0,0 +1,43 @@ +{% include "lib/paramList.html" -%} +< + + + + + + + + +

Modules

+ +{% for module in doc.modules %} + +

{$ module.id $} + {%- if module.publicModule %} (public){% endif %}

+ + {% for export in module.exports %} +

{$ export.name $}

+ + {%- if export.constructorDoc %} +

{$ doc.constructorDoc.name $}{$ paramList(doc.constructorDoc.params) $}

+ {% endif -%} + {%- for member in export.members %} +

{$ member.name $}{$ paramList(member.params) $}

+ {% endfor %} + + {% endfor %} + +{% endfor %} + + +