Ignoring tags in yuidoc javascript documentor -
is possible ignore various tags in yuidoc make documentation build process messages more useful.
i've problem tags @author, @date etc
/** * xyz view ... * these tags yuidoc result in yuidoc warning * * @company <company name> * @date mon aug 27 2013 22:30:50 gmt+0200 (cest) * * these tags yuidoc able interpret * @author bernhard <email@foo> * @module welcome * @submodule frontend * @class welcomeview * @constructor * */ // yuidoc throws warnings warn: (docparser): unknown tag: company, path/to/file.js:1 warn: (docparser): unknown tag: date, path/to/file.js:1:1
and there tons of files makes impossible find "real" warnings" there way exlude tags in yuidoc?
based on research have conducted, yuidoc provides no means set list of tags ignore nor other means screen out these warnings.
however, can follows:
- (optional) fork existing yuidoc project
edit
yuidocjs/lib/docparser.js
, , add desired tagstaglist
:taglist = [ // ... "conditional", // conditional module "company", "config", // config param (not attribute, no change events) // ... "contributor", // author "date", "default", // property/attribute default value // ... ]
- run yuidoc normal , watch warnings disappear!
note these fields won't appear in documentation, seems primary concern how omit warnings. if want handle tags, you'll need make changes digesters
list.
Comments
Post a Comment