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

All @api annotations imply stability

Browse Source
This commit is contained in:
Tim Schaub
2017-02-06 09:22:05 -07:00
parent ca23c7337f
commit f5aea97d3b
109 changed files with 705 additions and 747 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
config/jsdoc/api/plugins/api.js
View File

@@ -1,10 +1,6 @@
/**
* Define an @api tag
*/
var conf = env.conf.stability;
var defaultLevels = ["deprecated","experimental","unstable","stable","frozen","locked"];
var levels = conf.levels || defaultLevels;
var util = require('util');
exports.defineTags = function(dictionary) {
dictionary.defineTag('api', {
mustHaveValue: false,
@@ -12,13 +8,7 @@ exports.defineTags = function(dictionary) {
canHaveName: false,
onTagged: function(doclet, tag) {
includeTypes(doclet);
var level = tag.text || "experimental";
if (levels.indexOf(level) >= 0) {
doclet.stability = level;
} else {
var errorText = util.format('Invalid stability level (%s) in %s line %s', tag.text, doclet.meta.filename, doclet.meta.lineno);
require('jsdoc/lib/jsdoc/util/error').handle( new Error(errorText) );
}
doclet.stability = "stable";
}
});
};