javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2026-03-13 10:22:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): updating dgeni typescript package

Browse Source
This commit is contained in:
perry
2017-03-14 14:50:31 -05:00
parent 4354fc212e
commit 396f891f33
160 changed files with 760 additions and 2014 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
scripts/docs/processors/hide-private-api.js
View File

@@ -2,17 +2,18 @@ module.exports = function removePrivateApi() {
return {
name: 'remove-private-api',
description: 'Prevent the private apis from being rendered',
$runAfter: ['paths-computed'],
$runBefore: ['rendering-docs'],
$process: function(docs) {
var publicDocs = [];
docs.forEach(function(doc){
if(!doc.private){
docs.forEach(function(doc){
if (!doc.private && (!doc.tags || !doc.tags.tagsByName.get('hidden'))){
publicDocs.push(doc);
return doc
}
})
docs = publicDocs;
return docs;
docs = publicDocs;
return docs;
}
}
};

2
scripts/docs/processors/parse-returns-object.js
View File

@@ -1,4 +1,4 @@
module.exports = function removePrivateApi() {
module.exports = function parseReturnsObject() {
/*
* This processor assumes the format:

4
scripts/docs/processors/remove-private-members.js
View File

@@ -8,12 +8,12 @@ module.exports = function removePrivateMembers() {
docs.forEach(function(doc) {
if (doc.members) {
doc.members = doc.members.filter(function(member) {
return !member.tags.tagsByName.get('private') && !member.tags.tagsByName.get('internal');
return !member.tags.tagsByName.get('hidden') && !member.tags.tagsByName.get('internal');
});
}
if (doc.statics) {
doc.statics = doc.statics.filter(function(staticMethod) {
return !staticMethod.tags.tagsByName.get('private') && !staticMethod.tags.tagsByName.get('internal')
return !staticMethod.tags.tagsByName.get('hidden') && !staticMethod.tags.tagsByName.get('internal')
});
}
});