documentation/streams/filter_access.js

'use strict';

var mapStream = require('map-stream');

/**
 * Exclude given access levels from the generated documentation: this allows
 * users to write documentation for non-public members by using the
 * `@private` tag.
 *
 * @name access
 * @public
 * @param {Array<String>} [levels=[private]] excluded access levels.
 * @return {stream.Transform}
 */
module.exports = function (levels) {
  levels = levels || ['private'];
  return mapStream(function (comment, callback) {
    if (levels.indexOf(comment.access) === -1) {
      callback(null, comment);
    } else {
      callback();
    }
  });
};