honeymoose/angular-cn
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(doc-gen): ignore @param tags

Browse Source 
At the moment we are not parsing param tags. This commit ignores them
completely.

TODO: hook up param descriptions with the actual param data in the doc.

Closes #2633
This commit is contained in:
Peter Bacon Darwin 2015-06-19 13:56:49 +01:00 committed by Naomi Black
parent c8ef5b5811
commit b8ef20e353
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -78,7 +78,8 @@ module.exports = new Package('angular', [jsdocPackage, nunjucksPackage, linksPac
// We actually don't want to parse param docs in this package as we are getting the data out using TS // We actually don't want to parse param docs in this package as we are getting the data out using TS
parseTagsProcessor.tagDefinitions.forEach(function(tagDef) { parseTagsProcessor.tagDefinitions.forEach(function(tagDef) {
if (tagDef.name === 'param') { if (tagDef.name === 'param') {
tagDef.ignore = true; tagDef.docProperty = 'paramData';
tagDef.transforms = [];
} }
}); });