ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Remove undocumented symbols at the end of the parsing process

Browse Source 
This ensures that we do not mark symbols as undocumented before
all potential dependencies are parsed.
This commit is contained in:
ahocevar
2014-03-26 18:31:31 +01:00
parent 36305f7efe
commit 118d9c200a
1 changed files with 23 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
apidoc/plugins/exports.js
View File

@@ -101,36 +101,34 @@ exports.handlers = {
}
}
}
}
},
};
function filter(e) {
if (e.doclet) {
var fqn = e.doclet.longname;
if (fqn) {
e.doclet.undocumented = (api.indexOf(fqn) === -1 && unexported.indexOf(fqn) === -1);
e.doclet.unexported = (unexported.indexOf(fqn) !== -1);
// Remove parents that are not part of the API
var parent;
var parents = e.doclet.augments;
if (parents) {
for (var i = parents.length - 1; i >= 0; --i) {
parent = parents[i];
if (api.indexOf(parent) === -1) {
parents.splice(i, 1);
parseComplete: function(e) {
for (var j = e.doclets.length - 1; j >= 0; --j) {
var doclet = e.doclets[j];
if (doclet.kind == 'namespace') {
continue;
}
var fqn = doclet.longname;
if (fqn) {
var undocumented = (api.indexOf(fqn) === -1 && unexported.indexOf(fqn) === -1);
doclet.unexported = (unexported.indexOf(fqn) !== -1);
// Remove parents that are not part of the API
var parent;
var parents = doclet.augments;
if (parents) {
for (var i = parents.length - 1; i >= 0; --i) {
parent = parents[i];
if (api.indexOf(parent) === -1 && unexported.indexOf(parent) === -1) {
parents.splice(i, 1);
}
}
}
if (undocumented) {
e.doclets.splice(j, 1);
}
}
}
}
}
exports.nodeVisitor = {
visitNode: function(node, e, parser, currentSourceName) {
// filter out non-API symbols before the addDocletRef finisher is called
e.finishers.unshift(filter);
}
};