@storm-software/tsdoc 0.1.2 → 0.1.4

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 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
- [![Version](https://img.shields.io/badge/version-0.1.0-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
24
+ [![Version](https://img.shields.io/badge/version-0.1.2-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
25
25
 
26
26
  <!-- prettier-ignore-start -->
27
27
  <!-- markdownlint-disable -->
@@ -0,0 +1,15 @@
1
+ {
2
+ "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
3
+ "extends": ["./typedoc.json"],
4
+ "tagDefinitions": [
5
+ {
6
+ "tagName": "@alias",
7
+ "syntaxKind": "block",
8
+ "allowMultiple": true
9
+ },
10
+ {
11
+ "tagName": "@displayName",
12
+ "syntaxKind": "block"
13
+ }
14
+ ]
15
+ }
@@ -0,0 +1,238 @@
1
+ {
2
+ "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
3
+ "noStandardTags": false,
4
+ "tagDefinitions": [
5
+ {
6
+ "tagName": "@author",
7
+ "syntaxKind": "block"
8
+ },
9
+ {
10
+ "tagName": "@module",
11
+ "syntaxKind": "block"
12
+ },
13
+ {
14
+ "tagName": "@mergeModuleWith",
15
+ "syntaxKind": "block"
16
+ },
17
+ {
18
+ "tagName": "@type",
19
+ "syntaxKind": "block"
20
+ },
21
+ {
22
+ "tagName": "@typedef",
23
+ "syntaxKind": "block"
24
+ },
25
+ {
26
+ "tagName": "@callback",
27
+ "syntaxKind": "block"
28
+ },
29
+ {
30
+ "tagName": "@prop",
31
+ "syntaxKind": "block",
32
+ "allowMultiple": true
33
+ },
34
+ {
35
+ "tagName": "@property",
36
+ "syntaxKind": "block",
37
+ "allowMultiple": true
38
+ },
39
+ {
40
+ "tagName": "@group",
41
+ "syntaxKind": "block",
42
+ "allowMultiple": true
43
+ },
44
+ {
45
+ "tagName": "@groupDescription",
46
+ "syntaxKind": "block",
47
+ "allowMultiple": true
48
+ },
49
+ {
50
+ "tagName": "@disableGroups",
51
+ "syntaxKind": "modifier",
52
+ "allowMultiple": false
53
+ },
54
+ {
55
+ "tagName": "@category",
56
+ "syntaxKind": "block",
57
+ "allowMultiple": true
58
+ },
59
+ {
60
+ "tagName": "@categoryDescription",
61
+ "syntaxKind": "block",
62
+ "allowMultiple": true
63
+ },
64
+ {
65
+ "tagName": "@hidden",
66
+ "syntaxKind": "modifier"
67
+ },
68
+ {
69
+ "tagName": "@ignore",
70
+ "syntaxKind": "modifier"
71
+ },
72
+ {
73
+ "tagName": "@class",
74
+ "syntaxKind": "modifier"
75
+ },
76
+ {
77
+ "tagName": "@abstract",
78
+ "syntaxKind": "modifier"
79
+ },
80
+ {
81
+ "tagName": "@document",
82
+ "syntaxKind": "block"
83
+ },
84
+ {
85
+ "tagName": "@default",
86
+ "syntaxKind": "block"
87
+ },
88
+ {
89
+ "tagName": "@extends",
90
+ "syntaxKind": "block"
91
+ },
92
+ {
93
+ "tagName": "@augments",
94
+ "syntaxKind": "block"
95
+ },
96
+ {
97
+ "tagName": "@return",
98
+ "syntaxKind": "block"
99
+ },
100
+ {
101
+ "tagName": "@yields",
102
+ "syntaxKind": "block"
103
+ },
104
+ {
105
+ "tagName": "@enum",
106
+ "syntaxKind": "modifier"
107
+ },
108
+ {
109
+ "tagName": "@event",
110
+ "syntaxKind": "modifier"
111
+ },
112
+ {
113
+ "tagName": "@expand",
114
+ "syntaxKind": "modifier"
115
+ },
116
+ {
117
+ "tagName": "@preventExpand",
118
+ "syntaxKind": "block"
119
+ },
120
+ {
121
+ "tagName": "@expandType",
122
+ "syntaxKind": "block"
123
+ },
124
+ {
125
+ "tagName": "@inline",
126
+ "syntaxKind": "modifier"
127
+ },
128
+ {
129
+ "tagName": "@preventInline",
130
+ "syntaxKind": "block"
131
+ },
132
+ {
133
+ "tagName": "@inlineType",
134
+ "syntaxKind": "block"
135
+ },
136
+ {
137
+ "tagName": "@primaryExport",
138
+ "syntaxKind": "modifier"
139
+ },
140
+ {
141
+ "tagName": "@template",
142
+ "syntaxKind": "block",
143
+ "allowMultiple": true
144
+ },
145
+ {
146
+ "tagName": "@linkcode",
147
+ "syntaxKind": "inline",
148
+ "allowMultiple": true
149
+ },
150
+ {
151
+ "tagName": "@linkplain",
152
+ "syntaxKind": "inline",
153
+ "allowMultiple": true
154
+ },
155
+ {
156
+ "tagName": "@include",
157
+ "syntaxKind": "inline",
158
+ "allowMultiple": true
159
+ },
160
+ {
161
+ "tagName": "@includeCode",
162
+ "syntaxKind": "inline",
163
+ "allowMultiple": true
164
+ },
165
+ {
166
+ "tagName": "@private",
167
+ "syntaxKind": "modifier"
168
+ },
169
+ {
170
+ "tagName": "@protected",
171
+ "syntaxKind": "modifier"
172
+ },
173
+ {
174
+ "tagName": "@satisfies",
175
+ "syntaxKind": "block"
176
+ },
177
+ {
178
+ "tagName": "@since",
179
+ "syntaxKind": "block"
180
+ },
181
+ {
182
+ "tagName": "@license",
183
+ "syntaxKind": "block"
184
+ },
185
+ {
186
+ "tagName": "@import",
187
+ "syntaxKind": "block"
188
+ },
189
+ {
190
+ "tagName": "@overload",
191
+ "syntaxKind": "modifier"
192
+ },
193
+ {
194
+ "tagName": "@namespace",
195
+ "syntaxKind": "modifier"
196
+ },
197
+ {
198
+ "tagName": "@interface",
199
+ "syntaxKind": "modifier"
200
+ },
201
+ {
202
+ "tagName": "@function",
203
+ "syntaxKind": "modifier"
204
+ },
205
+ {
206
+ "tagName": "@showCategories",
207
+ "syntaxKind": "modifier"
208
+ },
209
+ {
210
+ "tagName": "@hideCategories",
211
+ "syntaxKind": "modifier"
212
+ },
213
+ {
214
+ "tagName": "@showGroups",
215
+ "syntaxKind": "modifier"
216
+ },
217
+ {
218
+ "tagName": "@hideGroups",
219
+ "syntaxKind": "modifier"
220
+ },
221
+ {
222
+ "tagName": "@hideconstructor",
223
+ "syntaxKind": "modifier"
224
+ },
225
+ {
226
+ "tagName": "@jsx",
227
+ "syntaxKind": "block"
228
+ },
229
+ {
230
+ "tagName": "@summary",
231
+ "syntaxKind": "block"
232
+ },
233
+ {
234
+ "tagName": "@useDeclaredType",
235
+ "syntaxKind": "modifier"
236
+ }
237
+ ]
238
+ }
package/dist/index.cjs CHANGED
@@ -45,153 +45,101 @@ var base_default = {
45
45
  // src/typedoc.json
46
46
  var typedoc_default = {
47
47
  $schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
48
+ noStandardTags: false,
48
49
  tagDefinitions: [
49
50
  {
50
51
  tagName: "@author",
51
52
  syntaxKind: "block"
52
53
  },
53
54
  {
54
- tagName: "@category",
55
- syntaxKind: "block"
56
- },
57
- {
58
- tagName: "@categoryDescription",
59
- syntaxKind: "block"
60
- },
61
- {
62
- tagName: "@showCategories",
55
+ tagName: "@module",
63
56
  syntaxKind: "block"
64
57
  },
65
58
  {
66
- tagName: "@hideCategories",
59
+ tagName: "@mergeModuleWith",
67
60
  syntaxKind: "block"
68
61
  },
69
62
  {
70
- tagName: "@defaultValue",
63
+ tagName: "@type",
71
64
  syntaxKind: "block"
72
65
  },
73
66
  {
74
- tagName: "@default",
67
+ tagName: "@typedef",
75
68
  syntaxKind: "block"
76
69
  },
77
70
  {
78
- tagName: "@deprecated",
79
- syntaxKind: "modifier"
80
- },
81
- {
82
- tagName: "@document",
71
+ tagName: "@callback",
83
72
  syntaxKind: "block"
84
73
  },
85
74
  {
86
- tagName: "@example",
87
- syntaxKind: "block"
75
+ tagName: "@prop",
76
+ syntaxKind: "block",
77
+ allowMultiple: true
88
78
  },
89
79
  {
90
- tagName: "@expandType",
91
- syntaxKind: "modifier"
80
+ tagName: "@property",
81
+ syntaxKind: "block",
82
+ allowMultiple: true
92
83
  },
93
84
  {
94
85
  tagName: "@group",
95
- syntaxKind: "block"
86
+ syntaxKind: "block",
87
+ allowMultiple: true
96
88
  },
97
89
  {
98
90
  tagName: "@groupDescription",
99
- syntaxKind: "block"
100
- },
101
- {
102
- tagName: "@showGroups",
103
- syntaxKind: "block"
104
- },
105
- {
106
- tagName: "@hideGroups",
107
- syntaxKind: "block"
91
+ syntaxKind: "block",
92
+ allowMultiple: true
108
93
  },
109
94
  {
110
95
  tagName: "@disableGroups",
111
- syntaxKind: "block"
112
- },
113
- {
114
- tagName: "@import",
115
- syntaxKind: "modifier"
96
+ syntaxKind: "modifier",
97
+ allowMultiple: false
116
98
  },
117
99
  {
118
- tagName: "@inlineType",
119
- syntaxKind: "modifier"
120
- },
121
- {
122
- tagName: "@license",
123
- syntaxKind: "block"
124
- },
125
- {
126
- tagName: "@mergeModuleWith",
127
- syntaxKind: "modifier"
128
- },
129
- {
130
- tagName: "@module",
131
- syntaxKind: "modifier"
132
- },
133
- {
134
- tagName: "@param",
135
- syntaxKind: "modifier"
136
- },
137
- {
138
- tagName: "@preventExpand",
139
- syntaxKind: "modifier"
140
- },
141
- {
142
- tagName: "@preventInline",
143
- syntaxKind: "modifier"
100
+ tagName: "@category",
101
+ syntaxKind: "block",
102
+ allowMultiple: true
144
103
  },
145
104
  {
146
- tagName: "@privateRemarks",
147
- syntaxKind: "block"
105
+ tagName: "@categoryDescription",
106
+ syntaxKind: "block",
107
+ allowMultiple: true
148
108
  },
149
109
  {
150
- tagName: "@property",
110
+ tagName: "@hidden",
151
111
  syntaxKind: "modifier"
152
112
  },
153
113
  {
154
- tagName: "@prop",
114
+ tagName: "@ignore",
155
115
  syntaxKind: "modifier"
156
116
  },
157
117
  {
158
- tagName: "@remarks",
159
- syntaxKind: "block"
160
- },
161
- {
162
- tagName: "@returns",
118
+ tagName: "@class",
163
119
  syntaxKind: "modifier"
164
120
  },
165
121
  {
166
- tagName: "@return",
122
+ tagName: "@abstract",
167
123
  syntaxKind: "modifier"
168
124
  },
169
125
  {
170
- tagName: "@see",
171
- syntaxKind: "block"
172
- },
173
- {
174
- tagName: "@since",
175
- syntaxKind: "block"
176
- },
177
- {
178
- tagName: "@summary",
126
+ tagName: "@document",
179
127
  syntaxKind: "block"
180
128
  },
181
129
  {
182
- tagName: "@template",
130
+ tagName: "@default",
183
131
  syntaxKind: "block"
184
132
  },
185
133
  {
186
- tagName: "@throws",
134
+ tagName: "@extends",
187
135
  syntaxKind: "block"
188
136
  },
189
137
  {
190
- tagName: "@typeParam",
138
+ tagName: "@augments",
191
139
  syntaxKind: "block"
192
140
  },
193
141
  {
194
- tagName: "@type",
142
+ tagName: "@return",
195
143
  syntaxKind: "block"
196
144
  },
197
145
  {
@@ -199,91 +147,92 @@ var typedoc_default = {
199
147
  syntaxKind: "block"
200
148
  },
201
149
  {
202
- tagName: "@jsx",
203
- syntaxKind: "block"
204
- },
205
- {
206
- tagName: "@typedef",
207
- syntaxKind: "block"
150
+ tagName: "@enum",
151
+ syntaxKind: "modifier"
208
152
  },
209
153
  {
210
- tagName: "@extends",
211
- syntaxKind: "block"
154
+ tagName: "@event",
155
+ syntaxKind: "modifier"
212
156
  },
213
157
  {
214
- tagName: "@augments",
215
- syntaxKind: "block"
158
+ tagName: "@expand",
159
+ syntaxKind: "modifier"
216
160
  },
217
161
  {
218
- tagName: "@satisfies",
162
+ tagName: "@preventExpand",
219
163
  syntaxKind: "block"
220
164
  },
221
165
  {
222
- tagName: "@callback",
166
+ tagName: "@expandType",
223
167
  syntaxKind: "block"
224
168
  },
225
169
  {
226
- tagName: "@abstract",
170
+ tagName: "@inline",
227
171
  syntaxKind: "modifier"
228
172
  },
229
173
  {
230
- tagName: "@alpha",
231
- syntaxKind: "modifier"
174
+ tagName: "@preventInline",
175
+ syntaxKind: "block"
232
176
  },
233
177
  {
234
- tagName: "@beta",
235
- syntaxKind: "modifier"
178
+ tagName: "@inlineType",
179
+ syntaxKind: "block"
236
180
  },
237
181
  {
238
- tagName: "@class",
182
+ tagName: "@primaryExport",
239
183
  syntaxKind: "modifier"
240
184
  },
241
185
  {
242
- tagName: "@enum",
243
- syntaxKind: "modifier"
186
+ tagName: "@template",
187
+ syntaxKind: "block",
188
+ allowMultiple: true
244
189
  },
245
190
  {
246
- tagName: "@event",
247
- syntaxKind: "modifier"
191
+ tagName: "@linkcode",
192
+ syntaxKind: "inline",
193
+ allowMultiple: true
248
194
  },
249
195
  {
250
- tagName: "@eventProperty",
251
- syntaxKind: "modifier"
196
+ tagName: "@linkplain",
197
+ syntaxKind: "inline",
198
+ allowMultiple: true
252
199
  },
253
200
  {
254
- tagName: "@expand",
255
- syntaxKind: "modifier"
201
+ tagName: "@include",
202
+ syntaxKind: "inline",
203
+ allowMultiple: true
256
204
  },
257
205
  {
258
- tagName: "@experimental",
259
- syntaxKind: "modifier"
206
+ tagName: "@includeCode",
207
+ syntaxKind: "inline",
208
+ allowMultiple: true
260
209
  },
261
210
  {
262
- tagName: "@function",
211
+ tagName: "@private",
263
212
  syntaxKind: "modifier"
264
213
  },
265
214
  {
266
- tagName: "@hidden",
215
+ tagName: "@protected",
267
216
  syntaxKind: "modifier"
268
217
  },
269
218
  {
270
- tagName: "@hideconstructor",
271
- syntaxKind: "modifier"
219
+ tagName: "@satisfies",
220
+ syntaxKind: "block"
272
221
  },
273
222
  {
274
- tagName: "@ignore",
275
- syntaxKind: "modifier"
223
+ tagName: "@since",
224
+ syntaxKind: "block"
276
225
  },
277
226
  {
278
- tagName: "@inline",
279
- syntaxKind: "modifier"
227
+ tagName: "@license",
228
+ syntaxKind: "block"
280
229
  },
281
230
  {
282
- tagName: "@interface",
283
- syntaxKind: "modifier"
231
+ tagName: "@import",
232
+ syntaxKind: "block"
284
233
  },
285
234
  {
286
- tagName: "@internal",
235
+ tagName: "@overload",
287
236
  syntaxKind: "modifier"
288
237
  },
289
238
  {
@@ -291,76 +240,44 @@ var typedoc_default = {
291
240
  syntaxKind: "modifier"
292
241
  },
293
242
  {
294
- tagName: "@overload",
243
+ tagName: "@interface",
295
244
  syntaxKind: "modifier"
296
245
  },
297
246
  {
298
- tagName: "@override",
247
+ tagName: "@function",
299
248
  syntaxKind: "modifier"
300
249
  },
301
250
  {
302
- tagName: "@packageDocumentation",
251
+ tagName: "@showCategories",
303
252
  syntaxKind: "modifier"
304
253
  },
305
254
  {
306
- tagName: "@primaryExport",
255
+ tagName: "@hideCategories",
307
256
  syntaxKind: "modifier"
308
257
  },
309
258
  {
310
- tagName: "@private",
259
+ tagName: "@showGroups",
311
260
  syntaxKind: "modifier"
312
261
  },
313
262
  {
314
- tagName: "@protected",
263
+ tagName: "@hideGroups",
315
264
  syntaxKind: "modifier"
316
265
  },
317
266
  {
318
- tagName: "@public",
267
+ tagName: "@hideconstructor",
319
268
  syntaxKind: "modifier"
320
269
  },
321
270
  {
322
- tagName: "@readonly",
323
- syntaxKind: "modifier"
271
+ tagName: "@jsx",
272
+ syntaxKind: "block"
324
273
  },
325
274
  {
326
- tagName: "@sealed",
327
- syntaxKind: "modifier"
275
+ tagName: "@summary",
276
+ syntaxKind: "block"
328
277
  },
329
278
  {
330
279
  tagName: "@useDeclaredType",
331
280
  syntaxKind: "modifier"
332
- },
333
- {
334
- tagName: "@virtual",
335
- syntaxKind: "modifier"
336
- },
337
- {
338
- tagName: "@include",
339
- syntaxKind: "inline"
340
- },
341
- {
342
- tagName: "@includeCode",
343
- syntaxKind: "inline"
344
- },
345
- {
346
- tagName: "@inheritDoc",
347
- syntaxKind: "inline"
348
- },
349
- {
350
- tagName: "@label",
351
- syntaxKind: "inline"
352
- },
353
- {
354
- tagName: "@link",
355
- syntaxKind: "inline"
356
- },
357
- {
358
- tagName: "@linkcode",
359
- syntaxKind: "inline"
360
- },
361
- {
362
- tagName: "@linkplain",
363
- syntaxKind: "inline"
364
281
  }
365
282
  ]
366
283
  };
package/dist/index.d.cts CHANGED
@@ -14,10 +14,16 @@ declare const configs: {
14
14
  };
15
15
  typedoc: {
16
16
  $schema: string;
17
- tagDefinitions: {
17
+ noStandardTags: boolean;
18
+ tagDefinitions: ({
18
19
  tagName: string;
19
20
  syntaxKind: string;
20
- }[];
21
+ allowMultiple?: undefined;
22
+ } | {
23
+ tagName: string;
24
+ syntaxKind: string;
25
+ allowMultiple: boolean;
26
+ })[];
21
27
  };
22
28
  };
23
29
 
package/dist/index.d.ts CHANGED
@@ -14,10 +14,16 @@ declare const configs: {
14
14
  };
15
15
  typedoc: {
16
16
  $schema: string;
17
- tagDefinitions: {
17
+ noStandardTags: boolean;
18
+ tagDefinitions: ({
18
19
  tagName: string;
19
20
  syntaxKind: string;
20
- }[];
21
+ allowMultiple?: undefined;
22
+ } | {
23
+ tagName: string;
24
+ syntaxKind: string;
25
+ allowMultiple: boolean;
26
+ })[];
21
27
  };
22
28
  };
23
29
 
package/dist/index.js CHANGED
@@ -18,153 +18,101 @@ var base_default = {
18
18
  // src/typedoc.json
19
19
  var typedoc_default = {
20
20
  $schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
21
+ noStandardTags: false,
21
22
  tagDefinitions: [
22
23
  {
23
24
  tagName: "@author",
24
25
  syntaxKind: "block"
25
26
  },
26
27
  {
27
- tagName: "@category",
28
- syntaxKind: "block"
29
- },
30
- {
31
- tagName: "@categoryDescription",
32
- syntaxKind: "block"
33
- },
34
- {
35
- tagName: "@showCategories",
28
+ tagName: "@module",
36
29
  syntaxKind: "block"
37
30
  },
38
31
  {
39
- tagName: "@hideCategories",
32
+ tagName: "@mergeModuleWith",
40
33
  syntaxKind: "block"
41
34
  },
42
35
  {
43
- tagName: "@defaultValue",
36
+ tagName: "@type",
44
37
  syntaxKind: "block"
45
38
  },
46
39
  {
47
- tagName: "@default",
40
+ tagName: "@typedef",
48
41
  syntaxKind: "block"
49
42
  },
50
43
  {
51
- tagName: "@deprecated",
52
- syntaxKind: "modifier"
53
- },
54
- {
55
- tagName: "@document",
44
+ tagName: "@callback",
56
45
  syntaxKind: "block"
57
46
  },
58
47
  {
59
- tagName: "@example",
60
- syntaxKind: "block"
48
+ tagName: "@prop",
49
+ syntaxKind: "block",
50
+ allowMultiple: true
61
51
  },
62
52
  {
63
- tagName: "@expandType",
64
- syntaxKind: "modifier"
53
+ tagName: "@property",
54
+ syntaxKind: "block",
55
+ allowMultiple: true
65
56
  },
66
57
  {
67
58
  tagName: "@group",
68
- syntaxKind: "block"
59
+ syntaxKind: "block",
60
+ allowMultiple: true
69
61
  },
70
62
  {
71
63
  tagName: "@groupDescription",
72
- syntaxKind: "block"
73
- },
74
- {
75
- tagName: "@showGroups",
76
- syntaxKind: "block"
77
- },
78
- {
79
- tagName: "@hideGroups",
80
- syntaxKind: "block"
64
+ syntaxKind: "block",
65
+ allowMultiple: true
81
66
  },
82
67
  {
83
68
  tagName: "@disableGroups",
84
- syntaxKind: "block"
85
- },
86
- {
87
- tagName: "@import",
88
- syntaxKind: "modifier"
69
+ syntaxKind: "modifier",
70
+ allowMultiple: false
89
71
  },
90
72
  {
91
- tagName: "@inlineType",
92
- syntaxKind: "modifier"
93
- },
94
- {
95
- tagName: "@license",
96
- syntaxKind: "block"
97
- },
98
- {
99
- tagName: "@mergeModuleWith",
100
- syntaxKind: "modifier"
101
- },
102
- {
103
- tagName: "@module",
104
- syntaxKind: "modifier"
105
- },
106
- {
107
- tagName: "@param",
108
- syntaxKind: "modifier"
109
- },
110
- {
111
- tagName: "@preventExpand",
112
- syntaxKind: "modifier"
113
- },
114
- {
115
- tagName: "@preventInline",
116
- syntaxKind: "modifier"
73
+ tagName: "@category",
74
+ syntaxKind: "block",
75
+ allowMultiple: true
117
76
  },
118
77
  {
119
- tagName: "@privateRemarks",
120
- syntaxKind: "block"
78
+ tagName: "@categoryDescription",
79
+ syntaxKind: "block",
80
+ allowMultiple: true
121
81
  },
122
82
  {
123
- tagName: "@property",
83
+ tagName: "@hidden",
124
84
  syntaxKind: "modifier"
125
85
  },
126
86
  {
127
- tagName: "@prop",
87
+ tagName: "@ignore",
128
88
  syntaxKind: "modifier"
129
89
  },
130
90
  {
131
- tagName: "@remarks",
132
- syntaxKind: "block"
133
- },
134
- {
135
- tagName: "@returns",
91
+ tagName: "@class",
136
92
  syntaxKind: "modifier"
137
93
  },
138
94
  {
139
- tagName: "@return",
95
+ tagName: "@abstract",
140
96
  syntaxKind: "modifier"
141
97
  },
142
98
  {
143
- tagName: "@see",
144
- syntaxKind: "block"
145
- },
146
- {
147
- tagName: "@since",
148
- syntaxKind: "block"
149
- },
150
- {
151
- tagName: "@summary",
99
+ tagName: "@document",
152
100
  syntaxKind: "block"
153
101
  },
154
102
  {
155
- tagName: "@template",
103
+ tagName: "@default",
156
104
  syntaxKind: "block"
157
105
  },
158
106
  {
159
- tagName: "@throws",
107
+ tagName: "@extends",
160
108
  syntaxKind: "block"
161
109
  },
162
110
  {
163
- tagName: "@typeParam",
111
+ tagName: "@augments",
164
112
  syntaxKind: "block"
165
113
  },
166
114
  {
167
- tagName: "@type",
115
+ tagName: "@return",
168
116
  syntaxKind: "block"
169
117
  },
170
118
  {
@@ -172,91 +120,92 @@ var typedoc_default = {
172
120
  syntaxKind: "block"
173
121
  },
174
122
  {
175
- tagName: "@jsx",
176
- syntaxKind: "block"
177
- },
178
- {
179
- tagName: "@typedef",
180
- syntaxKind: "block"
123
+ tagName: "@enum",
124
+ syntaxKind: "modifier"
181
125
  },
182
126
  {
183
- tagName: "@extends",
184
- syntaxKind: "block"
127
+ tagName: "@event",
128
+ syntaxKind: "modifier"
185
129
  },
186
130
  {
187
- tagName: "@augments",
188
- syntaxKind: "block"
131
+ tagName: "@expand",
132
+ syntaxKind: "modifier"
189
133
  },
190
134
  {
191
- tagName: "@satisfies",
135
+ tagName: "@preventExpand",
192
136
  syntaxKind: "block"
193
137
  },
194
138
  {
195
- tagName: "@callback",
139
+ tagName: "@expandType",
196
140
  syntaxKind: "block"
197
141
  },
198
142
  {
199
- tagName: "@abstract",
143
+ tagName: "@inline",
200
144
  syntaxKind: "modifier"
201
145
  },
202
146
  {
203
- tagName: "@alpha",
204
- syntaxKind: "modifier"
147
+ tagName: "@preventInline",
148
+ syntaxKind: "block"
205
149
  },
206
150
  {
207
- tagName: "@beta",
208
- syntaxKind: "modifier"
151
+ tagName: "@inlineType",
152
+ syntaxKind: "block"
209
153
  },
210
154
  {
211
- tagName: "@class",
155
+ tagName: "@primaryExport",
212
156
  syntaxKind: "modifier"
213
157
  },
214
158
  {
215
- tagName: "@enum",
216
- syntaxKind: "modifier"
159
+ tagName: "@template",
160
+ syntaxKind: "block",
161
+ allowMultiple: true
217
162
  },
218
163
  {
219
- tagName: "@event",
220
- syntaxKind: "modifier"
164
+ tagName: "@linkcode",
165
+ syntaxKind: "inline",
166
+ allowMultiple: true
221
167
  },
222
168
  {
223
- tagName: "@eventProperty",
224
- syntaxKind: "modifier"
169
+ tagName: "@linkplain",
170
+ syntaxKind: "inline",
171
+ allowMultiple: true
225
172
  },
226
173
  {
227
- tagName: "@expand",
228
- syntaxKind: "modifier"
174
+ tagName: "@include",
175
+ syntaxKind: "inline",
176
+ allowMultiple: true
229
177
  },
230
178
  {
231
- tagName: "@experimental",
232
- syntaxKind: "modifier"
179
+ tagName: "@includeCode",
180
+ syntaxKind: "inline",
181
+ allowMultiple: true
233
182
  },
234
183
  {
235
- tagName: "@function",
184
+ tagName: "@private",
236
185
  syntaxKind: "modifier"
237
186
  },
238
187
  {
239
- tagName: "@hidden",
188
+ tagName: "@protected",
240
189
  syntaxKind: "modifier"
241
190
  },
242
191
  {
243
- tagName: "@hideconstructor",
244
- syntaxKind: "modifier"
192
+ tagName: "@satisfies",
193
+ syntaxKind: "block"
245
194
  },
246
195
  {
247
- tagName: "@ignore",
248
- syntaxKind: "modifier"
196
+ tagName: "@since",
197
+ syntaxKind: "block"
249
198
  },
250
199
  {
251
- tagName: "@inline",
252
- syntaxKind: "modifier"
200
+ tagName: "@license",
201
+ syntaxKind: "block"
253
202
  },
254
203
  {
255
- tagName: "@interface",
256
- syntaxKind: "modifier"
204
+ tagName: "@import",
205
+ syntaxKind: "block"
257
206
  },
258
207
  {
259
- tagName: "@internal",
208
+ tagName: "@overload",
260
209
  syntaxKind: "modifier"
261
210
  },
262
211
  {
@@ -264,76 +213,44 @@ var typedoc_default = {
264
213
  syntaxKind: "modifier"
265
214
  },
266
215
  {
267
- tagName: "@overload",
216
+ tagName: "@interface",
268
217
  syntaxKind: "modifier"
269
218
  },
270
219
  {
271
- tagName: "@override",
220
+ tagName: "@function",
272
221
  syntaxKind: "modifier"
273
222
  },
274
223
  {
275
- tagName: "@packageDocumentation",
224
+ tagName: "@showCategories",
276
225
  syntaxKind: "modifier"
277
226
  },
278
227
  {
279
- tagName: "@primaryExport",
228
+ tagName: "@hideCategories",
280
229
  syntaxKind: "modifier"
281
230
  },
282
231
  {
283
- tagName: "@private",
232
+ tagName: "@showGroups",
284
233
  syntaxKind: "modifier"
285
234
  },
286
235
  {
287
- tagName: "@protected",
236
+ tagName: "@hideGroups",
288
237
  syntaxKind: "modifier"
289
238
  },
290
239
  {
291
- tagName: "@public",
240
+ tagName: "@hideconstructor",
292
241
  syntaxKind: "modifier"
293
242
  },
294
243
  {
295
- tagName: "@readonly",
296
- syntaxKind: "modifier"
244
+ tagName: "@jsx",
245
+ syntaxKind: "block"
297
246
  },
298
247
  {
299
- tagName: "@sealed",
300
- syntaxKind: "modifier"
248
+ tagName: "@summary",
249
+ syntaxKind: "block"
301
250
  },
302
251
  {
303
252
  tagName: "@useDeclaredType",
304
253
  syntaxKind: "modifier"
305
- },
306
- {
307
- tagName: "@virtual",
308
- syntaxKind: "modifier"
309
- },
310
- {
311
- tagName: "@include",
312
- syntaxKind: "inline"
313
- },
314
- {
315
- tagName: "@includeCode",
316
- syntaxKind: "inline"
317
- },
318
- {
319
- tagName: "@inheritDoc",
320
- syntaxKind: "inline"
321
- },
322
- {
323
- tagName: "@label",
324
- syntaxKind: "inline"
325
- },
326
- {
327
- tagName: "@link",
328
- syntaxKind: "inline"
329
- },
330
- {
331
- tagName: "@linkcode",
332
- syntaxKind: "inline"
333
- },
334
- {
335
- tagName: "@linkplain",
336
- syntaxKind: "inline"
337
254
  }
338
255
  ]
339
256
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@storm-software/tsdoc",
3
- "version": "0.1.2",
3
+ "version": "0.1.4",
4
4
  "type": "module",
5
5
  "description": "This package contains shared TSDoc configurations used in Storm Software projects.",
6
6
  "repository": {
@@ -64,15 +64,15 @@
64
64
  }
65
65
  },
66
66
  "types": "./dist/index.d.ts",
67
- "files": ["dist/**/*"],
68
- "keywords": ["tsdoc", "storm", "storm-ops", "storm-stack"],
67
+ "files": ["config/**/*", "dist/**/*"],
68
+ "keywords": ["tsdoc", "typedoc", "storm", "storm-ops", "storm-software"],
69
69
  "peerDependencies": {
70
70
  "@microsoft/tsdoc": ">=0.15.0",
71
71
  "@microsoft/tsdoc-config": ">=0.17.0"
72
72
  },
73
73
  "peerDependenciesMeta": {
74
- "@microsoft/tsdoc": { "optional": false },
75
- "@microsoft/tsdoc-config": { "optional": false }
74
+ "@microsoft/tsdoc": { "optional": true },
75
+ "@microsoft/tsdoc-config": { "optional": true }
76
76
  },
77
77
  "devDependencies": {
78
78
  "@types/node": "^22.10.2",