ibm-js / jsdoc-amddcl

An effort to create a JSDoc template that works well with AMD and C3MRO-based multiple class inheritance.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Automatic filtering of methods and properties with underscore prefix in their name

AdrianVasiliu opened this issue · comments

While the use of @Private or avoiding the use of /** ... */ does allow to filter out private methods or properties from the API doc, wouldn't it be useful to automatically filter out by default all _XXX methods and properties?
This would seem convenient and would avoid the risk to forget adding the @Private tag.

For comparison, jsdoc-toolkit did implement this feature (see https://code.google.com/p/jsdoc-toolkit/issues/detail?id=88).