senchalabs/jsduck — Issue #102: Add ability to hide "links to private member" warnings.
Author: Gjslick
Created: 2011-11-23 06:18:41+00:00
State: open

Right now, there is only the ability to hide *all* warnings related to @link tags, which includes linking to non-existent members, and private members. It would be useful to be able to just hide the "links to private member" warnings. We often link to private members in our internal docs to make them clear for developers as to the behavior of classes, but we still want to be able to see the other "non-existent link" errors when we generate the docs, preventing us from setting the --warnings=-link option.

Or, what would really be most useful is to have the private members included in the docs, but hidden initially until a checkbox for "show private members" is checked. An example of this is YUI's docs, where there are checkboxes to show/hide inherited, protected, and private members (ex: http://yuilibrary.com/yui/docs/api/classes/Anim.html).