| 1 | ;
|
| 2 |
|
| 3 | /**
|
| 4 | * Removes all symbols that begin with an underscore from the doc output. If
|
| 5 | * you're using underscores to denote private variables in modules, this
|
| 6 | * automatically hides them.
|
| 7 | *
|
| 8 | * @module plugins/underscore
|
| 9 | * @author Daniel Ellis <coug36@gmail.com>
|
| 10 | */
|
| 11 |
|
| 12 | exports.handlers = {
|
| 13 | newDoclet: function(e) {
|
| 14 | var doclet = e.doclet;
|
| 15 |
|
| 16 | // Ignore comment blocks for all symbols that begin with underscore
|
| 17 | if (doclet.name.charAt(0) === '_' || doclet.name.substr(0, 6) === 'this._') {
|
| 18 | doclet.access = 'private';
|
| 19 | }
|
| 20 | }
|
| 21 | };
|