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

Merge pull request #1906 from ahocevar/fix-event-docs

Browse Source 
Do not delete event and fires doclets
This commit is contained in:
Andreas Hocevar
2014-03-27 13:00:37 +01:00
parent 07775ae1ca d4eb5dd2ee
commit 47b82f0f11
2 changed files with 7 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apidoc/plugins/exports.js
+6 -30
View File
@@ -37,7 +37,6 @@ function collectOliExports(source) {
for (; i < ii; ++i) { for (; i < ii; ++i) {
property = 'ol.' + oli[i].match(/oli.([^;]*)/)[1] property = 'ol.' + oli[i].match(/oli.([^;]*)/)[1]
.replace('.prototype.', '#'); .replace('.prototype.', '#');
api.push(property);
unexported.push(property); unexported.push(property);
} }
} }
@@ -73,7 +72,6 @@ exports.handlers = {
} }
} }
if (api.indexOf(e.doclet.longname) > -1) { if (api.indexOf(e.doclet.longname) > -1) {
// Add params, links and events of API symbols to the API
var names, name; var names, name;
var params = e.doclet.params; var params = e.doclet.params;
if (params) { if (params) {
@@ -92,19 +90,9 @@ exports.handlers = {
var links = e.doclet.comment.match(/\{@link ([^\}]*)\}/g); var links = e.doclet.comment.match(/\{@link ([^\}]*)\}/g);
if (links) { if (links) {
for (i=0, ii=links.length; i < ii; ++i) { for (i=0, ii=links.length; i < ii; ++i) {
if (unexported.indexOf(links[i]) === -1) { var link = links[i].match(/\{@link (.*)\}/)[1];
unexported.push(links[i].match(/\{@link (.*)\}/)[1]); if (unexported.indexOf(link) === -1) {
} unexported.push(link);
}
}
var fires = e.doclet.fires;
var event;
if (fires) {
for (i = 0, ii = fires.length; i < ii; ++i) {
event = fires[i].split(' ').pop();
name = event.replace('event:', '');
if (unexported.indexOf(name) === -1) {
unexported.push(name);
} }
} }
} }
@@ -114,25 +102,13 @@ exports.handlers = {
parseComplete: function(e) { parseComplete: function(e) {
for (var j = e.doclets.length - 1; j >= 0; --j) { for (var j = e.doclets.length - 1; j >= 0; --j) {
var doclet = e.doclets[j]; var doclet = e.doclets[j];
if (doclet.kind == 'namespace') { if (doclet.kind == 'namespace' || doclet.kind == 'event' || doclet.fires) {
continue; continue;
} }
var fqn = doclet.longname; var fqn = doclet.longname;
if (fqn) { if (fqn) {
doclet.unexported = (unexported.indexOf(fqn) !== -1); doclet.unexported = (api.indexOf(fqn) === -1 && unexported.indexOf(fqn) !== -1);
var undocumented = (api.indexOf(fqn) === -1 && !doclet.unexported); if (api.indexOf(fqn) === -1 && 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); e.doclets.splice(j, 1);
} }
} }
apidoc/template/static/styles/jsdoc-default.css
+1 -1
View File
@@ -211,7 +211,7 @@ dt.tag-source, dd.tag-source {
.description { .description {
margin-bottom: 1em; margin-bottom: 1em;
margin-left: -16px; margin-left: 0px;
margin-top: 1em; margin-top: 1em;
} }