From 47f9722c331ed59f9a8a0949bc70fe0ea48f3391 Mon Sep 17 00:00:00 2001 From: Tim Lancina Date: Fri, 2 Oct 2015 11:33:44 -0500 Subject: [PATCH] fix(docs): don't render private class members --- scripts/docs/dgeni-config.js | 1 + .../docs/processors/remove-private-members.js | 19 +++++++++++++++++++ scripts/docs/templates/common.template.html | 2 +- 3 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 scripts/docs/processors/remove-private-members.js diff --git a/scripts/docs/dgeni-config.js b/scripts/docs/dgeni-config.js index 4aa294512c..3086fac2df 100644 --- a/scripts/docs/dgeni-config.js +++ b/scripts/docs/dgeni-config.js @@ -17,6 +17,7 @@ module.exports = function(currentVersion){ .processor(require('./processors/latest-version')) .processor(require('./processors/index-page')) .processor(require('./processors/jekyll')) +.processor(require('./processors/remove-private-members')) // for debugging docs // .processor(function test(){ diff --git a/scripts/docs/processors/remove-private-members.js b/scripts/docs/processors/remove-private-members.js new file mode 100644 index 0000000000..1762c11e33 --- /dev/null +++ b/scripts/docs/processors/remove-private-members.js @@ -0,0 +1,19 @@ +module.exports = function removePrivateMembers() { + return { + name: 'remove-private-members', + description: 'Remove member docs with @private tags', + $runAfter: ['tags-parsed'], + $runBefore: ['rendering-docs'], + $process: function(docs) { + docs.forEach(function(doc){ + if (doc.members) { + doc.members = doc.members.filter(function(member){ + return !member.tags.tagsByName.get("private"); + }) + } + }) + + return docs; + } + } +}; diff --git a/scripts/docs/templates/common.template.html b/scripts/docs/templates/common.template.html index 2556e73ee5..6299c55e4d 100644 --- a/scripts/docs/templates/common.template.html +++ b/scripts/docs/templates/common.template.html @@ -125,7 +125,7 @@ defined in <$ githubViewLink(doc) $> <@ endfor @> <@ endif -@> -<@- if doc.members @> +<@- if doc.members and doc.members.length @> ## Members <@- for method in doc.members @>