c17ac0cae3
This commit simplifies the exports.js plugin so it only relies on the stability notes to generate the documentation, which completely decouples it from the exportable API. As a rule of thumb, whenever something has an 'api' annotation, it should also have a 'stability' annotation. A more verbose documentation of ol3 specific annotation usage is available in the new 'apidoc/readme.md' file. This commit also modifies all source files to implement these usage suggestions.
27 lines
703 B
JavaScript
27 lines
703 B
JavaScript
var util = require('util');
|
|
exports.defineTags = function(dictionary) {
|
|
|
|
var classTag = dictionary.lookUp('class');
|
|
dictionary.defineTag('interface', {
|
|
mustHaveValue: false,
|
|
onTagged: function(doclet, tag) {
|
|
classTag.onTagged.apply(this, arguments);
|
|
doclet.interface = true;
|
|
}
|
|
});
|
|
|
|
var augmentsTag = dictionary.lookUp('augments');
|
|
dictionary.defineTag('implements', {
|
|
mustHaveValue: true,
|
|
onTagged: function(doclet, tag) {
|
|
tag.value = tag.value.match(/^\{?([^\}]*)\}?$/)[1];
|
|
augmentsTag.onTagged.apply(this, arguments);
|
|
if (!doclet.implements) {
|
|
doclet.implements = [];
|
|
}
|
|
doclet.implements.push(tag.value);
|
|
}
|
|
});
|
|
|
|
};
|