awesome-cordova-plugins/scripts/docs/processors/remove-private-members.js
2017-03-23 22:07:59 -04:00

25 lines
609 B
JavaScript

"use strict";
module.exports = function removePrivateMembers() {
return {
name: 'remove-private-members',
description: 'Remove member docs with @private tags',
$runAfter: ['tags-parsed'],
$runBefore: ['rendering-docs'],
$process: docs => {
docs.forEach(doc => {
if (doc.members) {
doc.members = doc.members.filter(member => !member.tags.tagsByName.get('hidden'));
}
if (doc.statics) {
doc.statics = doc.statics.filter(staticMethod => !staticMethod.tags.tagsByName.get('hidden'));
}
});
return docs;
}
};
};