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
37 lines
1.1 KiB
JavaScript
37 lines
1.1 KiB
JavaScript
var _ = require('lodash');
|
|
|
|
module.exports = function cloneExportedFromDocs(modules, EXPORT_DOC_TYPES) {
|
|
return {
|
|
$runAfter: ['tags-parsed', 'attachModuleDocs'],
|
|
$runBefore: ['computing-ids'],
|
|
$process: function(docs) {
|
|
|
|
var extraPublicDocs = [];
|
|
|
|
_.forEach(docs, function(doc) {
|
|
|
|
if (EXPORT_DOC_TYPES.indexOf(doc.docType) === -1 || !doc.exportedAs) return;
|
|
|
|
_.forEach(doc.exportedAs, function(exportedAs) {
|
|
var exportedAsModule = modules[exportedAs];
|
|
|
|
if (!exportedAsModule) {
|
|
throw new Error('Missing module definition: "' + doc.exportedAs + '"\n' +
|
|
'Referenced in "@exportedAs" tag on class: "' + doc.moduleDoc.id + '/' + doc.name + '"');
|
|
} else {
|
|
|
|
// Add a clone of export to its "exportedAs" module
|
|
var clonedDoc = _.clone(doc);
|
|
clonedDoc.moduleDoc = exportedAsModule;
|
|
exportedAsModule.exports.push(clonedDoc);
|
|
extraPublicDocs.push(clonedDoc);
|
|
}
|
|
});
|
|
});
|
|
|
|
docs = docs.concat(extraPublicDocs);
|
|
|
|
return docs;
|
|
}
|
|
};
|
|
}; |