22 lines
581 B
JavaScript
22 lines
581 B
JavaScript
|
'use strict';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Removes all symbols that begin with an underscore from the doc output. If
|
||
|
|
* you're using underscores to denote private variables in modules, this
|
||
|
|
* automatically hides them.
|
||
|
|
*
|
||
|
|
* @module plugins/underscore
|
||
|
|
* @author Daniel Ellis <coug36@gmail.com>
|
||
|
|
*/
|
||
|
|
|
||
|
|
exports.handlers = {
|
||
|
|
newDoclet: function(e) {
|
||
|
|
var doclet = e.doclet;
|
||
|
|
|
||
|
|
// Ignore comment blocks for all symbols that begin with underscore
|
||
|
|
if (doclet.name.charAt(0) === '_' || doclet.name.substr(0, 6) === 'this._') {
|
||
|
|
doclet.access = 'private';
|
||
|
|
}
|
||
|
|
}
|
||
|
|
};
|