b5002fb46b
chore(doc-gen): capture docs for modules from comments Closes #1258 docs(*): add module description jsdoc tags docs(*): add @public tag to public modules chore(doc-gen): fix overview-dump template The template was referencing an invalid property chore(doc-gen): use `@exportedAs` and `@public` rather than `@publicModule` This commit refactors how we describe components that are re-exported in another module. For example the "public" modules like `angular/angular` and `angular/annotations` are public but they only re-export components from "private" modules. Previously, you must apply the `@publicModule` tag to a component that was to be re-exported. Applying this tag caused the destination module to become public. Now, you specify that a module is public by applying the `@public` tag and then you can "re-export" components to other modules by applying the `@exportedAs` giving the name of the module from which the component will be re-exported. tag. This tag can be used multiple times on a single component, allowing the component to be exported on multiple modules. docs(*): rename `@publicModule` to `@exportedAs` The `@publicModule` dgeni tag has been replaced by the `@exportedAs` dgeni tag on components that are to be re-exported on another module. Closes #1290
24 lines
597 B
JavaScript
24 lines
597 B
JavaScript
var _ = require('lodash');
|
|
|
|
module.exports = function createOverviewDump() {
|
|
|
|
return {
|
|
$runAfter: ['captureModuleExports', 'captureClassMembers'],
|
|
$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);
|
|
}
|
|
};
|
|
}; |