@storm-software/tsdoc 0.3.2 → 0.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/config/api-extractor.json +31 -1
- package/config/base.json +1 -1
- package/config/core.json +258 -1
- package/dist/index.cjs +288 -3
- package/dist/index.d.cts +39 -0
- package/dist/index.d.ts +39 -0
- package/dist/index.js +288 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -21,7 +21,7 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
|
|
|
21
21
|
|
|
22
22
|
<h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3><br />
|
|
23
23
|
|
|
24
|
-
[](https://prettier.io/) [](http://nx.dev/) [](https://nextjs.org/) [](http://commitizen.github.io/cz-cli/)  [](https://fumadocs.vercel.app/) 
|
|
25
25
|
|
|
26
26
|
<!-- prettier-ignore-start -->
|
|
27
27
|
<!-- markdownlint-disable -->
|
|
@@ -13,5 +13,35 @@
|
|
|
13
13
|
"tagName": "@preapproved",
|
|
14
14
|
"syntaxKind": "modifier"
|
|
15
15
|
}
|
|
16
|
-
]
|
|
16
|
+
],
|
|
17
|
+
"supportForTags": {
|
|
18
|
+
"@alpha": true,
|
|
19
|
+
"@beta": true,
|
|
20
|
+
"@defaultValue": true,
|
|
21
|
+
"@decorator": true,
|
|
22
|
+
"@deprecated": true,
|
|
23
|
+
"@eventProperty": true,
|
|
24
|
+
"@example": true,
|
|
25
|
+
"@experimental": true,
|
|
26
|
+
"@inheritDoc": true,
|
|
27
|
+
"@internal": true,
|
|
28
|
+
"@label": true,
|
|
29
|
+
"@link": true,
|
|
30
|
+
"@override": true,
|
|
31
|
+
"@packageDocumentation": true,
|
|
32
|
+
"@param": true,
|
|
33
|
+
"@privateRemarks": true,
|
|
34
|
+
"@public": true,
|
|
35
|
+
"@readonly": true,
|
|
36
|
+
"@remarks": true,
|
|
37
|
+
"@returns": true,
|
|
38
|
+
"@sealed": true,
|
|
39
|
+
"@see": true,
|
|
40
|
+
"@throws": true,
|
|
41
|
+
"@typeParam": true,
|
|
42
|
+
"@virtual": true,
|
|
43
|
+
"@betaDocumentation": true,
|
|
44
|
+
"@internalRemarks": true,
|
|
45
|
+
"@preapproved": true
|
|
46
|
+
}
|
|
17
47
|
}
|
package/config/base.json
CHANGED
package/config/core.json
CHANGED
|
@@ -1,4 +1,261 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
3
|
-
"extends": ["./typedoc.json", "./api-extractor.json", "./base.json"]
|
|
3
|
+
"extends": ["./typedoc.json", "./api-extractor.json", "./base.json"],
|
|
4
|
+
"tagDefinitions": [
|
|
5
|
+
{
|
|
6
|
+
"tagName": "@alias",
|
|
7
|
+
"syntaxKind": "block",
|
|
8
|
+
"allowMultiple": true
|
|
9
|
+
},
|
|
10
|
+
{
|
|
11
|
+
"tagName": "@label",
|
|
12
|
+
"syntaxKind": "block"
|
|
13
|
+
},
|
|
14
|
+
|
|
15
|
+
{
|
|
16
|
+
"tagName": "@betaDocumentation",
|
|
17
|
+
"syntaxKind": "modifier"
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
"tagName": "@internalRemarks",
|
|
21
|
+
"syntaxKind": "block"
|
|
22
|
+
},
|
|
23
|
+
{
|
|
24
|
+
"tagName": "@preapproved",
|
|
25
|
+
"syntaxKind": "modifier"
|
|
26
|
+
},
|
|
27
|
+
|
|
28
|
+
{
|
|
29
|
+
"tagName": "@author",
|
|
30
|
+
"syntaxKind": "block"
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
"tagName": "@module",
|
|
34
|
+
"syntaxKind": "block"
|
|
35
|
+
},
|
|
36
|
+
{
|
|
37
|
+
"tagName": "@mergeModuleWith",
|
|
38
|
+
"syntaxKind": "block"
|
|
39
|
+
},
|
|
40
|
+
{
|
|
41
|
+
"tagName": "@type",
|
|
42
|
+
"syntaxKind": "block"
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
"tagName": "@typedef",
|
|
46
|
+
"syntaxKind": "block"
|
|
47
|
+
},
|
|
48
|
+
{
|
|
49
|
+
"tagName": "@callback",
|
|
50
|
+
"syntaxKind": "block"
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
"tagName": "@prop",
|
|
54
|
+
"syntaxKind": "block",
|
|
55
|
+
"allowMultiple": true
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
"tagName": "@property",
|
|
59
|
+
"syntaxKind": "block",
|
|
60
|
+
"allowMultiple": true
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
"tagName": "@group",
|
|
64
|
+
"syntaxKind": "block",
|
|
65
|
+
"allowMultiple": true
|
|
66
|
+
},
|
|
67
|
+
{
|
|
68
|
+
"tagName": "@groupDescription",
|
|
69
|
+
"syntaxKind": "block",
|
|
70
|
+
"allowMultiple": true
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
"tagName": "@disableGroups",
|
|
74
|
+
"syntaxKind": "modifier",
|
|
75
|
+
"allowMultiple": false
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
"tagName": "@category",
|
|
79
|
+
"syntaxKind": "block",
|
|
80
|
+
"allowMultiple": true
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
"tagName": "@categoryDescription",
|
|
84
|
+
"syntaxKind": "block",
|
|
85
|
+
"allowMultiple": true
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
"tagName": "@hidden",
|
|
89
|
+
"syntaxKind": "modifier"
|
|
90
|
+
},
|
|
91
|
+
{
|
|
92
|
+
"tagName": "@ignore",
|
|
93
|
+
"syntaxKind": "modifier"
|
|
94
|
+
},
|
|
95
|
+
{
|
|
96
|
+
"tagName": "@class",
|
|
97
|
+
"syntaxKind": "modifier"
|
|
98
|
+
},
|
|
99
|
+
{
|
|
100
|
+
"tagName": "@abstract",
|
|
101
|
+
"syntaxKind": "modifier"
|
|
102
|
+
},
|
|
103
|
+
{
|
|
104
|
+
"tagName": "@document",
|
|
105
|
+
"syntaxKind": "block"
|
|
106
|
+
},
|
|
107
|
+
{
|
|
108
|
+
"tagName": "@default",
|
|
109
|
+
"syntaxKind": "block"
|
|
110
|
+
},
|
|
111
|
+
{
|
|
112
|
+
"tagName": "@extends",
|
|
113
|
+
"syntaxKind": "block"
|
|
114
|
+
},
|
|
115
|
+
{
|
|
116
|
+
"tagName": "@augments",
|
|
117
|
+
"syntaxKind": "block"
|
|
118
|
+
},
|
|
119
|
+
{
|
|
120
|
+
"tagName": "@return",
|
|
121
|
+
"syntaxKind": "block"
|
|
122
|
+
},
|
|
123
|
+
{
|
|
124
|
+
"tagName": "@yields",
|
|
125
|
+
"syntaxKind": "block"
|
|
126
|
+
},
|
|
127
|
+
{
|
|
128
|
+
"tagName": "@enum",
|
|
129
|
+
"syntaxKind": "modifier"
|
|
130
|
+
},
|
|
131
|
+
{
|
|
132
|
+
"tagName": "@event",
|
|
133
|
+
"syntaxKind": "modifier"
|
|
134
|
+
},
|
|
135
|
+
{
|
|
136
|
+
"tagName": "@expand",
|
|
137
|
+
"syntaxKind": "modifier"
|
|
138
|
+
},
|
|
139
|
+
{
|
|
140
|
+
"tagName": "@preventExpand",
|
|
141
|
+
"syntaxKind": "block"
|
|
142
|
+
},
|
|
143
|
+
{
|
|
144
|
+
"tagName": "@expandType",
|
|
145
|
+
"syntaxKind": "block"
|
|
146
|
+
},
|
|
147
|
+
{
|
|
148
|
+
"tagName": "@inline",
|
|
149
|
+
"syntaxKind": "modifier"
|
|
150
|
+
},
|
|
151
|
+
{
|
|
152
|
+
"tagName": "@preventInline",
|
|
153
|
+
"syntaxKind": "block"
|
|
154
|
+
},
|
|
155
|
+
{
|
|
156
|
+
"tagName": "@inlineType",
|
|
157
|
+
"syntaxKind": "block"
|
|
158
|
+
},
|
|
159
|
+
{
|
|
160
|
+
"tagName": "@primaryExport",
|
|
161
|
+
"syntaxKind": "modifier"
|
|
162
|
+
},
|
|
163
|
+
{
|
|
164
|
+
"tagName": "@template",
|
|
165
|
+
"syntaxKind": "block",
|
|
166
|
+
"allowMultiple": true
|
|
167
|
+
},
|
|
168
|
+
{
|
|
169
|
+
"tagName": "@linkcode",
|
|
170
|
+
"syntaxKind": "inline",
|
|
171
|
+
"allowMultiple": true
|
|
172
|
+
},
|
|
173
|
+
{
|
|
174
|
+
"tagName": "@linkplain",
|
|
175
|
+
"syntaxKind": "inline",
|
|
176
|
+
"allowMultiple": true
|
|
177
|
+
},
|
|
178
|
+
{
|
|
179
|
+
"tagName": "@include",
|
|
180
|
+
"syntaxKind": "inline",
|
|
181
|
+
"allowMultiple": true
|
|
182
|
+
},
|
|
183
|
+
{
|
|
184
|
+
"tagName": "@includeCode",
|
|
185
|
+
"syntaxKind": "inline",
|
|
186
|
+
"allowMultiple": true
|
|
187
|
+
},
|
|
188
|
+
{
|
|
189
|
+
"tagName": "@private",
|
|
190
|
+
"syntaxKind": "modifier"
|
|
191
|
+
},
|
|
192
|
+
{
|
|
193
|
+
"tagName": "@protected",
|
|
194
|
+
"syntaxKind": "modifier"
|
|
195
|
+
},
|
|
196
|
+
{
|
|
197
|
+
"tagName": "@satisfies",
|
|
198
|
+
"syntaxKind": "block"
|
|
199
|
+
},
|
|
200
|
+
{
|
|
201
|
+
"tagName": "@since",
|
|
202
|
+
"syntaxKind": "block"
|
|
203
|
+
},
|
|
204
|
+
{
|
|
205
|
+
"tagName": "@license",
|
|
206
|
+
"syntaxKind": "block"
|
|
207
|
+
},
|
|
208
|
+
{
|
|
209
|
+
"tagName": "@import",
|
|
210
|
+
"syntaxKind": "block"
|
|
211
|
+
},
|
|
212
|
+
{
|
|
213
|
+
"tagName": "@overload",
|
|
214
|
+
"syntaxKind": "modifier"
|
|
215
|
+
},
|
|
216
|
+
{
|
|
217
|
+
"tagName": "@namespace",
|
|
218
|
+
"syntaxKind": "modifier"
|
|
219
|
+
},
|
|
220
|
+
{
|
|
221
|
+
"tagName": "@interface",
|
|
222
|
+
"syntaxKind": "modifier"
|
|
223
|
+
},
|
|
224
|
+
{
|
|
225
|
+
"tagName": "@function",
|
|
226
|
+
"syntaxKind": "modifier"
|
|
227
|
+
},
|
|
228
|
+
{
|
|
229
|
+
"tagName": "@showCategories",
|
|
230
|
+
"syntaxKind": "modifier"
|
|
231
|
+
},
|
|
232
|
+
{
|
|
233
|
+
"tagName": "@hideCategories",
|
|
234
|
+
"syntaxKind": "modifier"
|
|
235
|
+
},
|
|
236
|
+
{
|
|
237
|
+
"tagName": "@showGroups",
|
|
238
|
+
"syntaxKind": "modifier"
|
|
239
|
+
},
|
|
240
|
+
{
|
|
241
|
+
"tagName": "@hideGroups",
|
|
242
|
+
"syntaxKind": "modifier"
|
|
243
|
+
},
|
|
244
|
+
{
|
|
245
|
+
"tagName": "@hideconstructor",
|
|
246
|
+
"syntaxKind": "modifier"
|
|
247
|
+
},
|
|
248
|
+
{
|
|
249
|
+
"tagName": "@jsx",
|
|
250
|
+
"syntaxKind": "block"
|
|
251
|
+
},
|
|
252
|
+
{
|
|
253
|
+
"tagName": "@summary",
|
|
254
|
+
"syntaxKind": "block"
|
|
255
|
+
},
|
|
256
|
+
{
|
|
257
|
+
"tagName": "@useDeclaredType",
|
|
258
|
+
"syntaxKind": "modifier"
|
|
259
|
+
}
|
|
260
|
+
]
|
|
4
261
|
}
|
package/dist/index.cjs
CHANGED
|
@@ -41,7 +41,37 @@ var api_extractor_default = {
|
|
|
41
41
|
tagName: "@preapproved",
|
|
42
42
|
syntaxKind: "modifier"
|
|
43
43
|
}
|
|
44
|
-
]
|
|
44
|
+
],
|
|
45
|
+
supportForTags: {
|
|
46
|
+
"@alpha": true,
|
|
47
|
+
"@beta": true,
|
|
48
|
+
"@defaultValue": true,
|
|
49
|
+
"@decorator": true,
|
|
50
|
+
"@deprecated": true,
|
|
51
|
+
"@eventProperty": true,
|
|
52
|
+
"@example": true,
|
|
53
|
+
"@experimental": true,
|
|
54
|
+
"@inheritDoc": true,
|
|
55
|
+
"@internal": true,
|
|
56
|
+
"@label": true,
|
|
57
|
+
"@link": true,
|
|
58
|
+
"@override": true,
|
|
59
|
+
"@packageDocumentation": true,
|
|
60
|
+
"@param": true,
|
|
61
|
+
"@privateRemarks": true,
|
|
62
|
+
"@public": true,
|
|
63
|
+
"@readonly": true,
|
|
64
|
+
"@remarks": true,
|
|
65
|
+
"@returns": true,
|
|
66
|
+
"@sealed": true,
|
|
67
|
+
"@see": true,
|
|
68
|
+
"@throws": true,
|
|
69
|
+
"@typeParam": true,
|
|
70
|
+
"@virtual": true,
|
|
71
|
+
"@betaDocumentation": true,
|
|
72
|
+
"@internalRemarks": true,
|
|
73
|
+
"@preapproved": true
|
|
74
|
+
}
|
|
45
75
|
};
|
|
46
76
|
|
|
47
77
|
// src/base.json
|
|
@@ -54,7 +84,7 @@ var base_default = {
|
|
|
54
84
|
allowMultiple: true
|
|
55
85
|
},
|
|
56
86
|
{
|
|
57
|
-
tagName: "@
|
|
87
|
+
tagName: "@label",
|
|
58
88
|
syntaxKind: "block"
|
|
59
89
|
}
|
|
60
90
|
]
|
|
@@ -63,7 +93,262 @@ var base_default = {
|
|
|
63
93
|
// src/core.json
|
|
64
94
|
var core_default = {
|
|
65
95
|
$schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
66
|
-
extends: ["./typedoc.json", "./api-extractor.json", "./base.json"]
|
|
96
|
+
extends: ["./typedoc.json", "./api-extractor.json", "./base.json"],
|
|
97
|
+
tagDefinitions: [
|
|
98
|
+
{
|
|
99
|
+
tagName: "@alias",
|
|
100
|
+
syntaxKind: "block",
|
|
101
|
+
allowMultiple: true
|
|
102
|
+
},
|
|
103
|
+
{
|
|
104
|
+
tagName: "@label",
|
|
105
|
+
syntaxKind: "block"
|
|
106
|
+
},
|
|
107
|
+
{
|
|
108
|
+
tagName: "@betaDocumentation",
|
|
109
|
+
syntaxKind: "modifier"
|
|
110
|
+
},
|
|
111
|
+
{
|
|
112
|
+
tagName: "@internalRemarks",
|
|
113
|
+
syntaxKind: "block"
|
|
114
|
+
},
|
|
115
|
+
{
|
|
116
|
+
tagName: "@preapproved",
|
|
117
|
+
syntaxKind: "modifier"
|
|
118
|
+
},
|
|
119
|
+
{
|
|
120
|
+
tagName: "@author",
|
|
121
|
+
syntaxKind: "block"
|
|
122
|
+
},
|
|
123
|
+
{
|
|
124
|
+
tagName: "@module",
|
|
125
|
+
syntaxKind: "block"
|
|
126
|
+
},
|
|
127
|
+
{
|
|
128
|
+
tagName: "@mergeModuleWith",
|
|
129
|
+
syntaxKind: "block"
|
|
130
|
+
},
|
|
131
|
+
{
|
|
132
|
+
tagName: "@type",
|
|
133
|
+
syntaxKind: "block"
|
|
134
|
+
},
|
|
135
|
+
{
|
|
136
|
+
tagName: "@typedef",
|
|
137
|
+
syntaxKind: "block"
|
|
138
|
+
},
|
|
139
|
+
{
|
|
140
|
+
tagName: "@callback",
|
|
141
|
+
syntaxKind: "block"
|
|
142
|
+
},
|
|
143
|
+
{
|
|
144
|
+
tagName: "@prop",
|
|
145
|
+
syntaxKind: "block",
|
|
146
|
+
allowMultiple: true
|
|
147
|
+
},
|
|
148
|
+
{
|
|
149
|
+
tagName: "@property",
|
|
150
|
+
syntaxKind: "block",
|
|
151
|
+
allowMultiple: true
|
|
152
|
+
},
|
|
153
|
+
{
|
|
154
|
+
tagName: "@group",
|
|
155
|
+
syntaxKind: "block",
|
|
156
|
+
allowMultiple: true
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
tagName: "@groupDescription",
|
|
160
|
+
syntaxKind: "block",
|
|
161
|
+
allowMultiple: true
|
|
162
|
+
},
|
|
163
|
+
{
|
|
164
|
+
tagName: "@disableGroups",
|
|
165
|
+
syntaxKind: "modifier",
|
|
166
|
+
allowMultiple: false
|
|
167
|
+
},
|
|
168
|
+
{
|
|
169
|
+
tagName: "@category",
|
|
170
|
+
syntaxKind: "block",
|
|
171
|
+
allowMultiple: true
|
|
172
|
+
},
|
|
173
|
+
{
|
|
174
|
+
tagName: "@categoryDescription",
|
|
175
|
+
syntaxKind: "block",
|
|
176
|
+
allowMultiple: true
|
|
177
|
+
},
|
|
178
|
+
{
|
|
179
|
+
tagName: "@hidden",
|
|
180
|
+
syntaxKind: "modifier"
|
|
181
|
+
},
|
|
182
|
+
{
|
|
183
|
+
tagName: "@ignore",
|
|
184
|
+
syntaxKind: "modifier"
|
|
185
|
+
},
|
|
186
|
+
{
|
|
187
|
+
tagName: "@class",
|
|
188
|
+
syntaxKind: "modifier"
|
|
189
|
+
},
|
|
190
|
+
{
|
|
191
|
+
tagName: "@abstract",
|
|
192
|
+
syntaxKind: "modifier"
|
|
193
|
+
},
|
|
194
|
+
{
|
|
195
|
+
tagName: "@document",
|
|
196
|
+
syntaxKind: "block"
|
|
197
|
+
},
|
|
198
|
+
{
|
|
199
|
+
tagName: "@default",
|
|
200
|
+
syntaxKind: "block"
|
|
201
|
+
},
|
|
202
|
+
{
|
|
203
|
+
tagName: "@extends",
|
|
204
|
+
syntaxKind: "block"
|
|
205
|
+
},
|
|
206
|
+
{
|
|
207
|
+
tagName: "@augments",
|
|
208
|
+
syntaxKind: "block"
|
|
209
|
+
},
|
|
210
|
+
{
|
|
211
|
+
tagName: "@return",
|
|
212
|
+
syntaxKind: "block"
|
|
213
|
+
},
|
|
214
|
+
{
|
|
215
|
+
tagName: "@yields",
|
|
216
|
+
syntaxKind: "block"
|
|
217
|
+
},
|
|
218
|
+
{
|
|
219
|
+
tagName: "@enum",
|
|
220
|
+
syntaxKind: "modifier"
|
|
221
|
+
},
|
|
222
|
+
{
|
|
223
|
+
tagName: "@event",
|
|
224
|
+
syntaxKind: "modifier"
|
|
225
|
+
},
|
|
226
|
+
{
|
|
227
|
+
tagName: "@expand",
|
|
228
|
+
syntaxKind: "modifier"
|
|
229
|
+
},
|
|
230
|
+
{
|
|
231
|
+
tagName: "@preventExpand",
|
|
232
|
+
syntaxKind: "block"
|
|
233
|
+
},
|
|
234
|
+
{
|
|
235
|
+
tagName: "@expandType",
|
|
236
|
+
syntaxKind: "block"
|
|
237
|
+
},
|
|
238
|
+
{
|
|
239
|
+
tagName: "@inline",
|
|
240
|
+
syntaxKind: "modifier"
|
|
241
|
+
},
|
|
242
|
+
{
|
|
243
|
+
tagName: "@preventInline",
|
|
244
|
+
syntaxKind: "block"
|
|
245
|
+
},
|
|
246
|
+
{
|
|
247
|
+
tagName: "@inlineType",
|
|
248
|
+
syntaxKind: "block"
|
|
249
|
+
},
|
|
250
|
+
{
|
|
251
|
+
tagName: "@primaryExport",
|
|
252
|
+
syntaxKind: "modifier"
|
|
253
|
+
},
|
|
254
|
+
{
|
|
255
|
+
tagName: "@template",
|
|
256
|
+
syntaxKind: "block",
|
|
257
|
+
allowMultiple: true
|
|
258
|
+
},
|
|
259
|
+
{
|
|
260
|
+
tagName: "@linkcode",
|
|
261
|
+
syntaxKind: "inline",
|
|
262
|
+
allowMultiple: true
|
|
263
|
+
},
|
|
264
|
+
{
|
|
265
|
+
tagName: "@linkplain",
|
|
266
|
+
syntaxKind: "inline",
|
|
267
|
+
allowMultiple: true
|
|
268
|
+
},
|
|
269
|
+
{
|
|
270
|
+
tagName: "@include",
|
|
271
|
+
syntaxKind: "inline",
|
|
272
|
+
allowMultiple: true
|
|
273
|
+
},
|
|
274
|
+
{
|
|
275
|
+
tagName: "@includeCode",
|
|
276
|
+
syntaxKind: "inline",
|
|
277
|
+
allowMultiple: true
|
|
278
|
+
},
|
|
279
|
+
{
|
|
280
|
+
tagName: "@private",
|
|
281
|
+
syntaxKind: "modifier"
|
|
282
|
+
},
|
|
283
|
+
{
|
|
284
|
+
tagName: "@protected",
|
|
285
|
+
syntaxKind: "modifier"
|
|
286
|
+
},
|
|
287
|
+
{
|
|
288
|
+
tagName: "@satisfies",
|
|
289
|
+
syntaxKind: "block"
|
|
290
|
+
},
|
|
291
|
+
{
|
|
292
|
+
tagName: "@since",
|
|
293
|
+
syntaxKind: "block"
|
|
294
|
+
},
|
|
295
|
+
{
|
|
296
|
+
tagName: "@license",
|
|
297
|
+
syntaxKind: "block"
|
|
298
|
+
},
|
|
299
|
+
{
|
|
300
|
+
tagName: "@import",
|
|
301
|
+
syntaxKind: "block"
|
|
302
|
+
},
|
|
303
|
+
{
|
|
304
|
+
tagName: "@overload",
|
|
305
|
+
syntaxKind: "modifier"
|
|
306
|
+
},
|
|
307
|
+
{
|
|
308
|
+
tagName: "@namespace",
|
|
309
|
+
syntaxKind: "modifier"
|
|
310
|
+
},
|
|
311
|
+
{
|
|
312
|
+
tagName: "@interface",
|
|
313
|
+
syntaxKind: "modifier"
|
|
314
|
+
},
|
|
315
|
+
{
|
|
316
|
+
tagName: "@function",
|
|
317
|
+
syntaxKind: "modifier"
|
|
318
|
+
},
|
|
319
|
+
{
|
|
320
|
+
tagName: "@showCategories",
|
|
321
|
+
syntaxKind: "modifier"
|
|
322
|
+
},
|
|
323
|
+
{
|
|
324
|
+
tagName: "@hideCategories",
|
|
325
|
+
syntaxKind: "modifier"
|
|
326
|
+
},
|
|
327
|
+
{
|
|
328
|
+
tagName: "@showGroups",
|
|
329
|
+
syntaxKind: "modifier"
|
|
330
|
+
},
|
|
331
|
+
{
|
|
332
|
+
tagName: "@hideGroups",
|
|
333
|
+
syntaxKind: "modifier"
|
|
334
|
+
},
|
|
335
|
+
{
|
|
336
|
+
tagName: "@hideconstructor",
|
|
337
|
+
syntaxKind: "modifier"
|
|
338
|
+
},
|
|
339
|
+
{
|
|
340
|
+
tagName: "@jsx",
|
|
341
|
+
syntaxKind: "block"
|
|
342
|
+
},
|
|
343
|
+
{
|
|
344
|
+
tagName: "@summary",
|
|
345
|
+
syntaxKind: "block"
|
|
346
|
+
},
|
|
347
|
+
{
|
|
348
|
+
tagName: "@useDeclaredType",
|
|
349
|
+
syntaxKind: "modifier"
|
|
350
|
+
}
|
|
351
|
+
]
|
|
67
352
|
};
|
|
68
353
|
|
|
69
354
|
// src/typedoc.json
|
package/dist/index.d.cts
CHANGED
|
@@ -30,10 +30,49 @@ declare const configs: {
|
|
|
30
30
|
tagName: string;
|
|
31
31
|
syntaxKind: string;
|
|
32
32
|
}[];
|
|
33
|
+
supportForTags: {
|
|
34
|
+
"@alpha": boolean;
|
|
35
|
+
"@beta": boolean;
|
|
36
|
+
"@defaultValue": boolean;
|
|
37
|
+
"@decorator": boolean;
|
|
38
|
+
"@deprecated": boolean;
|
|
39
|
+
"@eventProperty": boolean;
|
|
40
|
+
"@example": boolean;
|
|
41
|
+
"@experimental": boolean;
|
|
42
|
+
"@inheritDoc": boolean;
|
|
43
|
+
"@internal": boolean;
|
|
44
|
+
"@label": boolean;
|
|
45
|
+
"@link": boolean;
|
|
46
|
+
"@override": boolean;
|
|
47
|
+
"@packageDocumentation": boolean;
|
|
48
|
+
"@param": boolean;
|
|
49
|
+
"@privateRemarks": boolean;
|
|
50
|
+
"@public": boolean;
|
|
51
|
+
"@readonly": boolean;
|
|
52
|
+
"@remarks": boolean;
|
|
53
|
+
"@returns": boolean;
|
|
54
|
+
"@sealed": boolean;
|
|
55
|
+
"@see": boolean;
|
|
56
|
+
"@throws": boolean;
|
|
57
|
+
"@typeParam": boolean;
|
|
58
|
+
"@virtual": boolean;
|
|
59
|
+
"@betaDocumentation": boolean;
|
|
60
|
+
"@internalRemarks": boolean;
|
|
61
|
+
"@preapproved": boolean;
|
|
62
|
+
};
|
|
33
63
|
};
|
|
34
64
|
core: {
|
|
35
65
|
$schema: string;
|
|
36
66
|
extends: string[];
|
|
67
|
+
tagDefinitions: ({
|
|
68
|
+
tagName: string;
|
|
69
|
+
syntaxKind: string;
|
|
70
|
+
allowMultiple: boolean;
|
|
71
|
+
} | {
|
|
72
|
+
tagName: string;
|
|
73
|
+
syntaxKind: string;
|
|
74
|
+
allowMultiple?: undefined;
|
|
75
|
+
})[];
|
|
37
76
|
};
|
|
38
77
|
};
|
|
39
78
|
|
package/dist/index.d.ts
CHANGED
|
@@ -30,10 +30,49 @@ declare const configs: {
|
|
|
30
30
|
tagName: string;
|
|
31
31
|
syntaxKind: string;
|
|
32
32
|
}[];
|
|
33
|
+
supportForTags: {
|
|
34
|
+
"@alpha": boolean;
|
|
35
|
+
"@beta": boolean;
|
|
36
|
+
"@defaultValue": boolean;
|
|
37
|
+
"@decorator": boolean;
|
|
38
|
+
"@deprecated": boolean;
|
|
39
|
+
"@eventProperty": boolean;
|
|
40
|
+
"@example": boolean;
|
|
41
|
+
"@experimental": boolean;
|
|
42
|
+
"@inheritDoc": boolean;
|
|
43
|
+
"@internal": boolean;
|
|
44
|
+
"@label": boolean;
|
|
45
|
+
"@link": boolean;
|
|
46
|
+
"@override": boolean;
|
|
47
|
+
"@packageDocumentation": boolean;
|
|
48
|
+
"@param": boolean;
|
|
49
|
+
"@privateRemarks": boolean;
|
|
50
|
+
"@public": boolean;
|
|
51
|
+
"@readonly": boolean;
|
|
52
|
+
"@remarks": boolean;
|
|
53
|
+
"@returns": boolean;
|
|
54
|
+
"@sealed": boolean;
|
|
55
|
+
"@see": boolean;
|
|
56
|
+
"@throws": boolean;
|
|
57
|
+
"@typeParam": boolean;
|
|
58
|
+
"@virtual": boolean;
|
|
59
|
+
"@betaDocumentation": boolean;
|
|
60
|
+
"@internalRemarks": boolean;
|
|
61
|
+
"@preapproved": boolean;
|
|
62
|
+
};
|
|
33
63
|
};
|
|
34
64
|
core: {
|
|
35
65
|
$schema: string;
|
|
36
66
|
extends: string[];
|
|
67
|
+
tagDefinitions: ({
|
|
68
|
+
tagName: string;
|
|
69
|
+
syntaxKind: string;
|
|
70
|
+
allowMultiple: boolean;
|
|
71
|
+
} | {
|
|
72
|
+
tagName: string;
|
|
73
|
+
syntaxKind: string;
|
|
74
|
+
allowMultiple?: undefined;
|
|
75
|
+
})[];
|
|
37
76
|
};
|
|
38
77
|
};
|
|
39
78
|
|
package/dist/index.js
CHANGED
|
@@ -14,7 +14,37 @@ var api_extractor_default = {
|
|
|
14
14
|
tagName: "@preapproved",
|
|
15
15
|
syntaxKind: "modifier"
|
|
16
16
|
}
|
|
17
|
-
]
|
|
17
|
+
],
|
|
18
|
+
supportForTags: {
|
|
19
|
+
"@alpha": true,
|
|
20
|
+
"@beta": true,
|
|
21
|
+
"@defaultValue": true,
|
|
22
|
+
"@decorator": true,
|
|
23
|
+
"@deprecated": true,
|
|
24
|
+
"@eventProperty": true,
|
|
25
|
+
"@example": true,
|
|
26
|
+
"@experimental": true,
|
|
27
|
+
"@inheritDoc": true,
|
|
28
|
+
"@internal": true,
|
|
29
|
+
"@label": true,
|
|
30
|
+
"@link": true,
|
|
31
|
+
"@override": true,
|
|
32
|
+
"@packageDocumentation": true,
|
|
33
|
+
"@param": true,
|
|
34
|
+
"@privateRemarks": true,
|
|
35
|
+
"@public": true,
|
|
36
|
+
"@readonly": true,
|
|
37
|
+
"@remarks": true,
|
|
38
|
+
"@returns": true,
|
|
39
|
+
"@sealed": true,
|
|
40
|
+
"@see": true,
|
|
41
|
+
"@throws": true,
|
|
42
|
+
"@typeParam": true,
|
|
43
|
+
"@virtual": true,
|
|
44
|
+
"@betaDocumentation": true,
|
|
45
|
+
"@internalRemarks": true,
|
|
46
|
+
"@preapproved": true
|
|
47
|
+
}
|
|
18
48
|
};
|
|
19
49
|
|
|
20
50
|
// src/base.json
|
|
@@ -27,7 +57,7 @@ var base_default = {
|
|
|
27
57
|
allowMultiple: true
|
|
28
58
|
},
|
|
29
59
|
{
|
|
30
|
-
tagName: "@
|
|
60
|
+
tagName: "@label",
|
|
31
61
|
syntaxKind: "block"
|
|
32
62
|
}
|
|
33
63
|
]
|
|
@@ -36,7 +66,262 @@ var base_default = {
|
|
|
36
66
|
// src/core.json
|
|
37
67
|
var core_default = {
|
|
38
68
|
$schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
39
|
-
extends: ["./typedoc.json", "./api-extractor.json", "./base.json"]
|
|
69
|
+
extends: ["./typedoc.json", "./api-extractor.json", "./base.json"],
|
|
70
|
+
tagDefinitions: [
|
|
71
|
+
{
|
|
72
|
+
tagName: "@alias",
|
|
73
|
+
syntaxKind: "block",
|
|
74
|
+
allowMultiple: true
|
|
75
|
+
},
|
|
76
|
+
{
|
|
77
|
+
tagName: "@label",
|
|
78
|
+
syntaxKind: "block"
|
|
79
|
+
},
|
|
80
|
+
{
|
|
81
|
+
tagName: "@betaDocumentation",
|
|
82
|
+
syntaxKind: "modifier"
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
tagName: "@internalRemarks",
|
|
86
|
+
syntaxKind: "block"
|
|
87
|
+
},
|
|
88
|
+
{
|
|
89
|
+
tagName: "@preapproved",
|
|
90
|
+
syntaxKind: "modifier"
|
|
91
|
+
},
|
|
92
|
+
{
|
|
93
|
+
tagName: "@author",
|
|
94
|
+
syntaxKind: "block"
|
|
95
|
+
},
|
|
96
|
+
{
|
|
97
|
+
tagName: "@module",
|
|
98
|
+
syntaxKind: "block"
|
|
99
|
+
},
|
|
100
|
+
{
|
|
101
|
+
tagName: "@mergeModuleWith",
|
|
102
|
+
syntaxKind: "block"
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
tagName: "@type",
|
|
106
|
+
syntaxKind: "block"
|
|
107
|
+
},
|
|
108
|
+
{
|
|
109
|
+
tagName: "@typedef",
|
|
110
|
+
syntaxKind: "block"
|
|
111
|
+
},
|
|
112
|
+
{
|
|
113
|
+
tagName: "@callback",
|
|
114
|
+
syntaxKind: "block"
|
|
115
|
+
},
|
|
116
|
+
{
|
|
117
|
+
tagName: "@prop",
|
|
118
|
+
syntaxKind: "block",
|
|
119
|
+
allowMultiple: true
|
|
120
|
+
},
|
|
121
|
+
{
|
|
122
|
+
tagName: "@property",
|
|
123
|
+
syntaxKind: "block",
|
|
124
|
+
allowMultiple: true
|
|
125
|
+
},
|
|
126
|
+
{
|
|
127
|
+
tagName: "@group",
|
|
128
|
+
syntaxKind: "block",
|
|
129
|
+
allowMultiple: true
|
|
130
|
+
},
|
|
131
|
+
{
|
|
132
|
+
tagName: "@groupDescription",
|
|
133
|
+
syntaxKind: "block",
|
|
134
|
+
allowMultiple: true
|
|
135
|
+
},
|
|
136
|
+
{
|
|
137
|
+
tagName: "@disableGroups",
|
|
138
|
+
syntaxKind: "modifier",
|
|
139
|
+
allowMultiple: false
|
|
140
|
+
},
|
|
141
|
+
{
|
|
142
|
+
tagName: "@category",
|
|
143
|
+
syntaxKind: "block",
|
|
144
|
+
allowMultiple: true
|
|
145
|
+
},
|
|
146
|
+
{
|
|
147
|
+
tagName: "@categoryDescription",
|
|
148
|
+
syntaxKind: "block",
|
|
149
|
+
allowMultiple: true
|
|
150
|
+
},
|
|
151
|
+
{
|
|
152
|
+
tagName: "@hidden",
|
|
153
|
+
syntaxKind: "modifier"
|
|
154
|
+
},
|
|
155
|
+
{
|
|
156
|
+
tagName: "@ignore",
|
|
157
|
+
syntaxKind: "modifier"
|
|
158
|
+
},
|
|
159
|
+
{
|
|
160
|
+
tagName: "@class",
|
|
161
|
+
syntaxKind: "modifier"
|
|
162
|
+
},
|
|
163
|
+
{
|
|
164
|
+
tagName: "@abstract",
|
|
165
|
+
syntaxKind: "modifier"
|
|
166
|
+
},
|
|
167
|
+
{
|
|
168
|
+
tagName: "@document",
|
|
169
|
+
syntaxKind: "block"
|
|
170
|
+
},
|
|
171
|
+
{
|
|
172
|
+
tagName: "@default",
|
|
173
|
+
syntaxKind: "block"
|
|
174
|
+
},
|
|
175
|
+
{
|
|
176
|
+
tagName: "@extends",
|
|
177
|
+
syntaxKind: "block"
|
|
178
|
+
},
|
|
179
|
+
{
|
|
180
|
+
tagName: "@augments",
|
|
181
|
+
syntaxKind: "block"
|
|
182
|
+
},
|
|
183
|
+
{
|
|
184
|
+
tagName: "@return",
|
|
185
|
+
syntaxKind: "block"
|
|
186
|
+
},
|
|
187
|
+
{
|
|
188
|
+
tagName: "@yields",
|
|
189
|
+
syntaxKind: "block"
|
|
190
|
+
},
|
|
191
|
+
{
|
|
192
|
+
tagName: "@enum",
|
|
193
|
+
syntaxKind: "modifier"
|
|
194
|
+
},
|
|
195
|
+
{
|
|
196
|
+
tagName: "@event",
|
|
197
|
+
syntaxKind: "modifier"
|
|
198
|
+
},
|
|
199
|
+
{
|
|
200
|
+
tagName: "@expand",
|
|
201
|
+
syntaxKind: "modifier"
|
|
202
|
+
},
|
|
203
|
+
{
|
|
204
|
+
tagName: "@preventExpand",
|
|
205
|
+
syntaxKind: "block"
|
|
206
|
+
},
|
|
207
|
+
{
|
|
208
|
+
tagName: "@expandType",
|
|
209
|
+
syntaxKind: "block"
|
|
210
|
+
},
|
|
211
|
+
{
|
|
212
|
+
tagName: "@inline",
|
|
213
|
+
syntaxKind: "modifier"
|
|
214
|
+
},
|
|
215
|
+
{
|
|
216
|
+
tagName: "@preventInline",
|
|
217
|
+
syntaxKind: "block"
|
|
218
|
+
},
|
|
219
|
+
{
|
|
220
|
+
tagName: "@inlineType",
|
|
221
|
+
syntaxKind: "block"
|
|
222
|
+
},
|
|
223
|
+
{
|
|
224
|
+
tagName: "@primaryExport",
|
|
225
|
+
syntaxKind: "modifier"
|
|
226
|
+
},
|
|
227
|
+
{
|
|
228
|
+
tagName: "@template",
|
|
229
|
+
syntaxKind: "block",
|
|
230
|
+
allowMultiple: true
|
|
231
|
+
},
|
|
232
|
+
{
|
|
233
|
+
tagName: "@linkcode",
|
|
234
|
+
syntaxKind: "inline",
|
|
235
|
+
allowMultiple: true
|
|
236
|
+
},
|
|
237
|
+
{
|
|
238
|
+
tagName: "@linkplain",
|
|
239
|
+
syntaxKind: "inline",
|
|
240
|
+
allowMultiple: true
|
|
241
|
+
},
|
|
242
|
+
{
|
|
243
|
+
tagName: "@include",
|
|
244
|
+
syntaxKind: "inline",
|
|
245
|
+
allowMultiple: true
|
|
246
|
+
},
|
|
247
|
+
{
|
|
248
|
+
tagName: "@includeCode",
|
|
249
|
+
syntaxKind: "inline",
|
|
250
|
+
allowMultiple: true
|
|
251
|
+
},
|
|
252
|
+
{
|
|
253
|
+
tagName: "@private",
|
|
254
|
+
syntaxKind: "modifier"
|
|
255
|
+
},
|
|
256
|
+
{
|
|
257
|
+
tagName: "@protected",
|
|
258
|
+
syntaxKind: "modifier"
|
|
259
|
+
},
|
|
260
|
+
{
|
|
261
|
+
tagName: "@satisfies",
|
|
262
|
+
syntaxKind: "block"
|
|
263
|
+
},
|
|
264
|
+
{
|
|
265
|
+
tagName: "@since",
|
|
266
|
+
syntaxKind: "block"
|
|
267
|
+
},
|
|
268
|
+
{
|
|
269
|
+
tagName: "@license",
|
|
270
|
+
syntaxKind: "block"
|
|
271
|
+
},
|
|
272
|
+
{
|
|
273
|
+
tagName: "@import",
|
|
274
|
+
syntaxKind: "block"
|
|
275
|
+
},
|
|
276
|
+
{
|
|
277
|
+
tagName: "@overload",
|
|
278
|
+
syntaxKind: "modifier"
|
|
279
|
+
},
|
|
280
|
+
{
|
|
281
|
+
tagName: "@namespace",
|
|
282
|
+
syntaxKind: "modifier"
|
|
283
|
+
},
|
|
284
|
+
{
|
|
285
|
+
tagName: "@interface",
|
|
286
|
+
syntaxKind: "modifier"
|
|
287
|
+
},
|
|
288
|
+
{
|
|
289
|
+
tagName: "@function",
|
|
290
|
+
syntaxKind: "modifier"
|
|
291
|
+
},
|
|
292
|
+
{
|
|
293
|
+
tagName: "@showCategories",
|
|
294
|
+
syntaxKind: "modifier"
|
|
295
|
+
},
|
|
296
|
+
{
|
|
297
|
+
tagName: "@hideCategories",
|
|
298
|
+
syntaxKind: "modifier"
|
|
299
|
+
},
|
|
300
|
+
{
|
|
301
|
+
tagName: "@showGroups",
|
|
302
|
+
syntaxKind: "modifier"
|
|
303
|
+
},
|
|
304
|
+
{
|
|
305
|
+
tagName: "@hideGroups",
|
|
306
|
+
syntaxKind: "modifier"
|
|
307
|
+
},
|
|
308
|
+
{
|
|
309
|
+
tagName: "@hideconstructor",
|
|
310
|
+
syntaxKind: "modifier"
|
|
311
|
+
},
|
|
312
|
+
{
|
|
313
|
+
tagName: "@jsx",
|
|
314
|
+
syntaxKind: "block"
|
|
315
|
+
},
|
|
316
|
+
{
|
|
317
|
+
tagName: "@summary",
|
|
318
|
+
syntaxKind: "block"
|
|
319
|
+
},
|
|
320
|
+
{
|
|
321
|
+
tagName: "@useDeclaredType",
|
|
322
|
+
syntaxKind: "modifier"
|
|
323
|
+
}
|
|
324
|
+
]
|
|
40
325
|
};
|
|
41
326
|
|
|
42
327
|
// src/typedoc.json
|