forked from SuperMap/iClient-JavaScript
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathusage.js
More file actions
60 lines (58 loc) · 1.79 KB
/
usage.js
File metadata and controls
60 lines (58 loc) · 1.79 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
const env = require('jsdoc/lib/jsdoc/env');
const globalParams = env.conf.templates;
exports.defineTags = function (dictionary) {
dictionary.defineTag('usage', {
mustHaveValue: false,
mustNotHaveDescription: false,
canHaveType: false,
canHaveName: false,
onTagged: function (doclet, tag) {
if (tag.value) {
doclet.usage = tag.value;
} else {
const deprecatedClasses = [];
let aliasClass = '';
let deprecatedClassInstance;
let browserNamespace = '';
if (doclet.tags) {
for (let index = 0; index < doclet.tags.length; index++) {
const tag = doclet.tags[index];
if (tag.title === 'deprecatedclass') {
deprecatedClasses.push(tag.value);
}
if (tag.title === 'aliasclass') {
aliasClass = tag.value;
}
if (tag.title === 'deprecatedclassinstance') {
deprecatedClassInstance = tag.value;
}
if (tag.title === 'browsernamespace') {
browserNamespace = tag.value;
}
}
}
doclet.usage = {
className: doclet.kind === 'class' ? doclet.name : '',
aliasClass: aliasClass,
globalParams,
deprecatedClasses: deprecatedClasses,
deprecatedClassInstance: deprecatedClassInstance,
browserNamespace: browserNamespace
};
}
}
});
};
exports.handlers = {
newDoclet: function (e) {
var usage = e.doclet.usage;
if (usage && usage.indexOf) {
for (const key in globalParams) {
if (Object.hasOwnProperty.call(globalParams, key)) {
const element = globalParams[key];
e.doclet.usage = e.doclet.usage.replace(`{${key}}`, element);
}
}
}
}
};