underscore.js 488 B

12345678910111213141516
  1. /**
  2. * Removes all symbols that begin with an underscore from the doc output. If
  3. * you're using underscores to denote private variables in modules, this
  4. * automatically hides them.
  5. *
  6. * @module plugins/underscore
  7. */
  8. exports.handlers = {
  9. newDoclet({doclet}) {
  10. // Ignore comment blocks for all symbols that begin with underscore
  11. if (doclet.name.charAt(0) === '_' || doclet.name.substr(0, 6) === 'this._') {
  12. doclet.access = 'private';
  13. }
  14. }
  15. };