b758d92790
Also to get rid of regular expression parsing, instead of collecting exports for observables from the source files, we use the 'observable' annotations.
116 lines
3.6 KiB
JavaScript
116 lines
3.6 KiB
JavaScript
/*
|
|
* This plugin parses externs/oli.js as well as goog.exportSymbol and
|
|
* goog.exportProperty calls to build a list of API symbols and properties.
|
|
* Unexported modules linked from @param or @fires will be marked unexported,
|
|
* and the documentation will not contain the constructor. Everything else is
|
|
* marked undocumented, which will remove it from the docs.
|
|
*/
|
|
|
|
var api = [];
|
|
var unexported = [];
|
|
var observablesByClass = {};
|
|
|
|
function collectExports(source) {
|
|
var symbols = JSON.parse(source).symbols;
|
|
for (var i = 0, ii = symbols.length; i < ii; ++i) {
|
|
api.push(symbols[i].name);
|
|
}
|
|
}
|
|
|
|
function collectOliExports(source) {
|
|
var oli = source.match(/[^\{]oli\.([^;^ ]*);? ?/g);
|
|
if (oli) {
|
|
i = 0; ii = oli.length;
|
|
for (; i < ii; ++i) {
|
|
property = 'ol.' + oli[i].match(/oli.([^;]*)/)[1]
|
|
.replace('.prototype.', '#');
|
|
unexported.push(property);
|
|
}
|
|
}
|
|
}
|
|
|
|
var encoding = env.conf.encoding || 'utf8';
|
|
var fs = require('jsdoc/fs');
|
|
collectExports(fs.readFileSync('build/symbols.json', encoding));
|
|
collectOliExports(fs.readFileSync('externs/oli.js', encoding));
|
|
|
|
|
|
exports.handlers = {
|
|
|
|
newDoclet: function(e) {
|
|
var i, ii, j, jj;
|
|
if (e.doclet.meta.filename == "olx.js" && e.doclet.longname != 'olx') {
|
|
api.push(e.doclet.longname);
|
|
}
|
|
if (api.indexOf(e.doclet.longname) > -1) {
|
|
var names, name;
|
|
var params = e.doclet.params;
|
|
if (params) {
|
|
for (i = 0, ii = params.length; i < ii; ++i) {
|
|
names = params[i].type.names;
|
|
if (names) {
|
|
for (j = 0, jj=names.length; j < jj; ++j) {
|
|
name = names[j];
|
|
if (unexported.indexOf(name) === -1) {
|
|
unexported.push(name);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
var links = e.doclet.comment.match(/\{@link ([^\}]*)\}/g);
|
|
if (links) {
|
|
for (i=0, ii=links.length; i < ii; ++i) {
|
|
var link = links[i].match(/\{@link (.*)\}/)[1];
|
|
if (unexported.indexOf(link) === -1) {
|
|
unexported.push(link);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
if (e.doclet.observables) {
|
|
var observables = observablesByClass[e.doclet.longname] = [];
|
|
for (i = e.doclet.observables.length - 1; i >= 0; --i) {
|
|
observables.push(e.doclet.observables[i].name);
|
|
}
|
|
}
|
|
},
|
|
|
|
parseComplete: function(e) {
|
|
for (var j = e.doclets.length - 1; j >= 0; --j) {
|
|
var doclet = e.doclets[j];
|
|
if (doclet.meta.filename == 'olx.js' && doclet.kind == 'typedef') {
|
|
for (var i = e.doclets.length - 1; i >= 0; --i) {
|
|
var propertyDoclet = e.doclets[i];
|
|
if (propertyDoclet.memberof == doclet.longname) {
|
|
if (!doclet.properties) {
|
|
doclet.properties = [];
|
|
}
|
|
doclet.properties.unshift(propertyDoclet);
|
|
e.doclets.splice(i, 1)
|
|
}
|
|
}
|
|
}
|
|
if (doclet.kind == 'namespace' || doclet.kind == 'event' || doclet.fires) {
|
|
continue;
|
|
}
|
|
var fqn = doclet.longname;
|
|
if (fqn) {
|
|
var getterOrSetter = fqn.match(/([^#]*)#[gs]et(.*)/);
|
|
if (getterOrSetter) {
|
|
var observables = observablesByClass[getterOrSetter[1]];
|
|
if (observables && observables.indexOf(getterOrSetter[2].toLowerCase()) > -1) {
|
|
// Always document getters/setters of observables
|
|
continue;
|
|
}
|
|
}
|
|
doclet.unexported = (api.indexOf(fqn) === -1 && unexported.indexOf(fqn) !== -1);
|
|
if (api.indexOf(fqn) === -1 && unexported.indexOf(fqn) === -1) {
|
|
e.doclets.splice(j, 1);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
};
|