javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-19 11:41:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(api): do not generate files for private classes

Browse Source 
Closes #684
This commit is contained in:
Drew Rygh
2015-12-02 13:32:59 -06:00
parent 50fab2504b
commit 160cc70332
2 changed files with 20 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
scripts/docs/dgeni-config.js
View File

@ -19,6 +19,8 @@ module.exports = function(currentVersion){
.processor(require('./processors/index-page')) .processor(require('./processors/index-page'))
.processor(require('./processors/jekyll')) .processor(require('./processors/jekyll'))
.processor(require('./processors/remove-private-members')) .processor(require('./processors/remove-private-members'))
.processor(require('./processors/hide-private-api'))
// for debugging docs // for debugging docs
// .processor(function test(){ // .processor(function test(){

18
scripts/docs/processors/hide-private-api.js Normal file
View File

@ -0,0 +1,18 @@
module.exports = function removePrivateApi() {
return {
name: 'remove-private-api',
description: 'Prevent the private apis from being rendered',
$runBefore: ['rendering-docs'],
$process: function(docs) {
var publicDocs = [];
docs.forEach(function(doc){
if(!doc.private){
publicDocs.push(doc);
return doc
}
})
docs = publicDocs;
return docs;
}
}
};