carto-4.2.2-1.js/config/jsdoc/plugins/api.js

27 lines
519 B
JavaScript
Raw Permalink Normal View History

2024-05-23 15:34:45 +08:00
/**
* Define @api tag
*/
exports.defineTags = function (dictionary) {
dictionary.defineTag('api', {
mustHaveValue: false,
canHaveType: false,
canHaveName: false,
onTagged: function (doclet, tag) {
doclet.public = true;
}
});
};
/*
* Only items with @api annotation should be documented
*/
exports.handlers = {
parseComplete: function (e) {
var doclets = e.doclets;
for (var i = 0; i < doclets.length; i++) {
doclets[i].undocumented = !doclets[i].public;
}
}
};