fix(docs): don't render private class members

This commit is contained in:
Tim Lancina
2015-10-02 11:33:44 -05:00
parent 963f3dca1b
commit 47f9722c33
3 changed files with 21 additions and 1 deletions

View File

@ -17,6 +17,7 @@ module.exports = function(currentVersion){
.processor(require('./processors/latest-version')) .processor(require('./processors/latest-version'))
.processor(require('./processors/index-page')) .processor(require('./processors/index-page'))
.processor(require('./processors/jekyll')) .processor(require('./processors/jekyll'))
.processor(require('./processors/remove-private-members'))
// for debugging docs // for debugging docs
// .processor(function test(){ // .processor(function test(){

View File

@ -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;
}
}
};

View File

@ -125,7 +125,7 @@ defined in <$ githubViewLink(doc) $>
<@ endfor @> <@ endfor @>
<@ endif -@> <@ endif -@>
<@- if doc.members @> <@- if doc.members and doc.members.length @>
## Members ## Members
<@- for method in doc.members @> <@- for method in doc.members @>