cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(doc-gen): include exported variable declaration in public docs

Browse Source
This commit is contained in:
Peter Bacon Darwin
2015-03-19 14:48:47 +00:00
parent 8a10edec01
commit 0f20c39f42
4 changed files with 23 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/public-docs-package/index.js
View File

@ -10,8 +10,9 @@ module.exports = new Package('angular-public', [basePackage])
parseTagsProcessor.tagDefinitions.push({ name: 'publicModule' });
})
.config(function(processClassDocs) {
.config(function(processClassDocs, filterPublicDocs, EXPORT_DOC_TYPES) {
processClassDocs.ignorePrivateMembers = true;
filterPublicDocs.docTypes = EXPORT_DOC_TYPES;
})
// Configure file writing

12
docs/public-docs-package/processors/filterPublicDocs.js
View File

@ -4,16 +4,20 @@ module.exports = function filterPublicDocs(modules) {
return {
$runAfter: ['tags-parsed'],
$runBefore: ['computing-ids'],
docTypes: [],
$validate: {
docTypes: { presence: true }
},
$process: function(docs) {
//console.log('filterPublicDocs', Object.keys(modules));
docTypes = this.docTypes;
docs = _.filter(docs, function(doc) {
if (doc.docType !== 'class') return true;
if (docTypes.indexOf(doc.docType) === -1) return true;
if (!doc.publicModule) return false;
//console.log('CLASS:', doc.name, doc.moduleDoc.id);
updateModule(doc);
return true;
@ -39,8 +43,6 @@ module.exports = function filterPublicDocs(modules) {
publicModule.isPublic = true;
//console.log('UPDATE CLASS', classDoc.id, originalModule.id, publicModule.id);
_.remove(classDoc.moduleDoc.exports, function(doc) { return doc === classDoc; });
classDoc.moduleDoc = publicModule;
publicModule.exports.push(classDoc);