Skip to content

Commit bfd3bb0

Browse files
committed
Merge branch hotfix/v9.0.2 into develop
2 parents c3dce4b + b6985ce commit bfd3bb0

File tree

15 files changed

+623
-8
lines changed

15 files changed

+623
-8
lines changed
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"source": {
3+
"include": ["../../../../sdkjs/cell/plugin-events.js"]
4+
},
5+
"plugins": ["./correct_doclets.js"],
6+
"opts": {
7+
"destination": "./out",
8+
"recurse": true,
9+
"encoding": "utf8"
10+
},
11+
"templates": {
12+
"json": {
13+
"pretty": true
14+
}
15+
}
16+
}
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"source": {
3+
"include": ["../../../../sdkjs/common/base-plugin-events.js"]
4+
},
5+
"plugins": ["./correct_doclets.js"],
6+
"opts": {
7+
"destination": "./out",
8+
"recurse": true,
9+
"encoding": "utf8"
10+
},
11+
"templates": {
12+
"json": {
13+
"pretty": true
14+
}
15+
}
16+
}
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"source": {
3+
"include": ["../../../../sdkjs/slide/plugin-events.js"]
4+
},
5+
"plugins": ["./correct_doclets.js"],
6+
"opts": {
7+
"destination": "./out",
8+
"recurse": true,
9+
"encoding": "utf8"
10+
},
11+
"templates": {
12+
"json": {
13+
"pretty": true
14+
}
15+
}
16+
}
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"source": {
3+
"include": ["../../../../sdkjs/word/plugin-events.js"]
4+
},
5+
"plugins": ["./correct_doclets.js"],
6+
"opts": {
7+
"destination": "./out",
8+
"recurse": true,
9+
"encoding": "utf8"
10+
},
11+
"templates": {
12+
"json": {
13+
"pretty": true
14+
}
15+
}
16+
}

scripts/sdkjs_common/jsdoc/config/plugins/common.json renamed to scripts/sdkjs_common/jsdoc/config/plugins/methods/common.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"source": {
3-
"include": ["../../../../sdkjs/common/plugins/plugin_base_api.js" ,"../../../../sdkjs/common/apiBase_plugins.js"]
3+
"include": ["../../../../sdkjs/common/plugins/plugin_base_api.js", "../../../../sdkjs/common/apiBase_plugins.js"]
44
},
55
"plugins": ["./correct_doclets.js"],
66
"opts": {
Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
exports.handlers = {
2+
processingComplete: function(e) {
3+
const filteredDoclets = [];
4+
5+
function checkNullProps(oDoclet) {
6+
for (let key of Object.keys(oDoclet)) {
7+
if (oDoclet[key] == null) {
8+
delete oDoclet[key];
9+
}
10+
if (typeof(oDoclet[key]) == "object") {
11+
checkNullProps(oDoclet[key]);
12+
}
13+
}
14+
}
15+
16+
for (let i = 0; i < e.doclets.length; i++) {
17+
const doclet = e.doclets[i];
18+
if (true == doclet.undocumented || doclet.kind == 'package') {
19+
continue;
20+
}
21+
22+
const filteredDoclet = {
23+
comment: doclet.comment,
24+
25+
meta: doclet.meta ? {
26+
lineno: doclet.meta.lineno,
27+
columnno: doclet.meta.columnno
28+
} : doclet.meta,
29+
30+
kind: doclet.kind,
31+
since: doclet.since,
32+
name: doclet.name,
33+
type: doclet.type ? {
34+
names: doclet.type.names,
35+
parsedType: doclet.type.parsedType
36+
} : doclet.type,
37+
38+
description: doclet.description,
39+
memberof: doclet.memberof,
40+
41+
properties: doclet.properties ? doclet.properties.map(property => ({
42+
type: property.type ? {
43+
names: property.type.names,
44+
parsedType: property.type.parsedType
45+
} : property.type,
46+
47+
name: property.name,
48+
description: property.description,
49+
optional: property.optional,
50+
defaultvalue: property.defaultvalue
51+
})) : doclet.properties,
52+
53+
longname: doclet.longname,
54+
scope: doclet.scope,
55+
alias: doclet.alias,
56+
57+
params: doclet.params ? doclet.params.map(param => ({
58+
type: param.type ? {
59+
names: param.type.names,
60+
parsedType: param.type.parsedType
61+
} : param.type,
62+
63+
name: param.name,
64+
description: param.description,
65+
optional: param.optional,
66+
defaultvalue: param.defaultvalue
67+
})) : doclet.params,
68+
69+
returns: doclet.returns ? doclet.returns.map(returnObj => ({
70+
type: {
71+
names: returnObj.type.names,
72+
parsedType: returnObj.type.parsedType
73+
}
74+
})) : doclet.returns,
75+
see: doclet.see
76+
};
77+
78+
checkNullProps(filteredDoclet)
79+
80+
filteredDoclets.push(filteredDoclet);
81+
}
82+
83+
e.doclets.splice(0, e.doclets.length, ...filteredDoclets);
84+
}
85+
};

0 commit comments

Comments
 (0)