jsdoc/plugins/underscore.js
Daniel Ellis dda789ae76 Squashed commit of the following:
commit 6010d34fcb7380281914f348023422f486033c68
Author: Daniel Ellis <coug36@gmail.com>
Date:   Wed Dec 31 09:29:00 2014 -0800

    Removed support for deprecated functionality

commit dba51a6ba74aa0de5c376434004eec8b05e1207b
Author: Daniel Ellis <coug36@gmail.com>
Date:   Fri Dec 26 11:51:08 2014 -0800

    Updated underscore plugin to pass tests

commit 3739ea55bd33186cbf507db3f086c9cf1ea9a339
Author: Daniel Ellis <coug36@gmail.com>
Date:   Sat Dec 13 21:33:48 2014 -0800

    Added unit tests for underscore plugin

commit 1b1bda5bb77ee74c311dfc9c9fe299e1e99f84cc
Merge: adfa364 a122ae6
Author: Daniel Ellis <coug36@gmail.com>
Date:   Sat Dec 13 18:39:32 2014 -0800

    Merge remote-tracking branch 'upstream/master' into underscore

commit adfa3646ebb7f11db897f7d0ba2490de79f86e2b
Author: Daniel Ellis <coug36@gmail.com>
Date:   Fri Aug 2 10:30:40 2013 -0700

    Added underscore plugin
2014-12-31 10:09:57 -08:00

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';
}
}
};