hide-private-api.js 527 B

1234567891011121314151617181920
  1. module.exports = function removePrivateApi() {
  2. return {
  3. name: 'remove-private-api',
  4. description: 'Prevent the private apis from being rendered',
  5. $runAfter: ['paths-computed'],
  6. $runBefore: ['rendering-docs'],
  7. $process: function(docs) {
  8. var publicDocs = [];
  9. docs.forEach(function(doc){
  10. if (!doc.private && (!doc.tags || !doc.tags.tagsByName.get('hidden'))){
  11. publicDocs.push(doc);
  12. return doc
  13. }
  14. })
  15. docs = publicDocs;
  16. return docs;
  17. }
  18. }
  19. };