jsdoc 0.22.0

JsDoc parser writen in rust
Documentation
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
[
    JsDoc {
        span: Span {
            lo: BytePos(
                0,
            ),
            hi: BytePos(
                0,
            ),
            ctxt: #0,
        },
        description: Text {
            span: Span {
                lo: BytePos(
                    0,
                ),
                hi: BytePos(
                    49,
                ),
                ctxt: #0,
            },
            value: Atom('An example of a server-side JavaScript module.
             *' type=dynamic),
        },
        tags: [
            TagItem {
                span: Span {
                    lo: BytePos(
                        0,
                    ),
                    hi: BytePos(
                        6,
                    ),
                    ctxt: #0,
                },
                tag_name: Text {
                    span: Span {
                        lo: BytePos(
                            0,
                        ),
                        hi: BytePos(
                            6,
                        ),
                        ctxt: #0,
                    },
                    value: Atom('module' type=static),
                },
                tag: Module(
                    ModuleTag {
                        span: Span {
                            lo: BytePos(
                                0,
                            ),
                            hi: BytePos(
                                6,
                            ),
                            ctxt: #0,
                        },
                        name: Text {
                            span: Span {
                                lo: BytePos(
                                    0,
                                ),
                                hi: BytePos(
                                    5,
                                ),
                                ctxt: #0,
                            },
                            value: Atom('world' type=inline),
                        },
                        ty: Text {
                            span: Span {
                                lo: BytePos(
                                    0,
                                ),
                                hi: BytePos(
                                    5,
                                ),
                                ctxt: #0,
                            },
                            value: Atom('hello' type=inline),
                        },
                    },
                ),
            },
            TagItem {
                span: Span {
                    lo: BytePos(
                        0,
                    ),
                    hi: BytePos(
                        7,
                    ),
                    ctxt: #0,
                },
                tag_name: Text {
                    span: Span {
                        lo: BytePos(
                            0,
                        ),
                        hi: BytePos(
                            7,
                        ),
                        ctxt: #0,
                    },
                    value: Atom('example' type=inline),
                },
                tag: Example(
                    ExampleTag {
                        span: Span {
                            lo: BytePos(
                                0,
                            ),
                            hi: BytePos(
                                7,
                            ),
                            ctxt: #0,
                        },
                        text: Text {
                            span: Span {
                                lo: BytePos(
                                    0,
                                ),
                                hi: BytePos(
                                    57,
                                ),
                                ctxt: #0,
                            },
                            value: Atom('*    var g = require('hello/world').sayHello('Gracie');
                             ' type=dynamic),
                        },
                    },
                ),
            },
        ],
    },
    JsDoc {
        span: Span {
            lo: BytePos(
                151,
            ),
            hi: BytePos(
                151,
            ),
            ctxt: #0,
        },
        description: Text {
            span: Span {
                lo: BytePos(
                    151,
                ),
                hi: BytePos(
                    174,
                ),
                ctxt: #0,
            },
            value: Atom('Generate a greeting.
             *' type=dynamic),
        },
        tags: [
            TagItem {
                span: Span {
                    lo: BytePos(
                        151,
                    ),
                    hi: BytePos(
                        156,
                    ),
                    ctxt: #0,
                },
                tag_name: Text {
                    span: Span {
                        lo: BytePos(
                            151,
                        ),
                        hi: BytePos(
                            156,
                        ),
                        ctxt: #0,
                    },
                    value: Atom('param' type=inline),
                },
                tag: Parameter(
                    ParameterTag {
                        span: Span {
                            lo: BytePos(
                                151,
                            ),
                            hi: BytePos(
                                156,
                            ),
                            ctxt: #0,
                        },
                        name: None,
                        ty: Some(
                            Text {
                                span: Span {
                                    lo: BytePos(
                                        151,
                                    ),
                                    hi: BytePos(
                                        159,
                                    ),
                                    ctxt: #0,
                                },
                                value: Atom('{string}' type=dynamic),
                            },
                        ),
                        desc: Text {
                            span: Span {
                                lo: BytePos(
                                    151,
                                ),
                                hi: BytePos(
                                    190,
                                ),
                                ctxt: #0,
                            },
                            value: Atom('[subject="world"] To whom we say hello.' type=dynamic),
                        },
                    },
                ),
            },
            TagItem {
                span: Span {
                    lo: BytePos(
                        151,
                    ),
                    hi: BytePos(
                        158,
                    ),
                    ctxt: #0,
                },
                tag_name: Text {
                    span: Span {
                        lo: BytePos(
                            151,
                        ),
                        hi: BytePos(
                            158,
                        ),
                        ctxt: #0,
                    },
                    value: Atom('returns' type=inline),
                },
                tag: Return(
                    ReturnTag {
                        span: Span {
                            lo: BytePos(
                                151,
                            ),
                            hi: BytePos(
                                158,
                            ),
                            ctxt: #0,
                        },
                        ty: Some(
                            Text {
                                span: Span {
                                    lo: BytePos(
                                        151,
                                    ),
                                    hi: BytePos(
                                        159,
                                    ),
                                    ctxt: #0,
                                },
                                value: Atom('{string}' type=dynamic),
                            },
                        ),
                        description: Text {
                            span: Span {
                                lo: BytePos(
                                    151,
                                ),
                                hi: BytePos(
                                    151,
                                ),
                                ctxt: #0,
                            },
                            value: Atom('' type=static),
                        },
                    },
                ),
            },
        ],
    },
    JsDoc {
        span: Span {
            lo: BytePos(
                350,
            ),
            hi: BytePos(
                350,
            ),
            ctxt: #0,
        },
        description: Text {
            span: Span {
                lo: BytePos(
                    350,
                ),
                hi: BytePos(
                    380,
                ),
                ctxt: #0,
            },
            value: Atom('Generate a morose farewell.
             *' type=dynamic),
        },
        tags: [
            TagItem {
                span: Span {
                    lo: BytePos(
                        350,
                    ),
                    hi: BytePos(
                        355,
                    ),
                    ctxt: #0,
                },
                tag_name: Text {
                    span: Span {
                        lo: BytePos(
                            350,
                        ),
                        hi: BytePos(
                            355,
                        ),
                        ctxt: #0,
                    },
                    value: Atom('param' type=inline),
                },
                tag: Parameter(
                    ParameterTag {
                        span: Span {
                            lo: BytePos(
                                350,
                            ),
                            hi: BytePos(
                                355,
                            ),
                            ctxt: #0,
                        },
                        name: None,
                        ty: Some(
                            Text {
                                span: Span {
                                    lo: BytePos(
                                        350,
                                    ),
                                    hi: BytePos(
                                        358,
                                    ),
                                    ctxt: #0,
                                },
                                value: Atom('{string}' type=dynamic),
                            },
                        ),
                        desc: Text {
                            span: Span {
                                lo: BytePos(
                                    350,
                                ),
                                hi: BytePos(
                                    391,
                                ),
                                ctxt: #0,
                            },
                            value: Atom('[subject="world"] To whom we say goodbye.' type=dynamic),
                        },
                    },
                ),
            },
            TagItem {
                span: Span {
                    lo: BytePos(
                        350,
                    ),
                    hi: BytePos(
                        357,
                    ),
                    ctxt: #0,
                },
                tag_name: Text {
                    span: Span {
                        lo: BytePos(
                            350,
                        ),
                        hi: BytePos(
                            357,
                        ),
                        ctxt: #0,
                    },
                    value: Atom('returns' type=inline),
                },
                tag: Return(
                    ReturnTag {
                        span: Span {
                            lo: BytePos(
                                350,
                            ),
                            hi: BytePos(
                                357,
                            ),
                            ctxt: #0,
                        },
                        ty: Some(
                            Text {
                                span: Span {
                                    lo: BytePos(
                                        350,
                                    ),
                                    hi: BytePos(
                                        358,
                                    ),
                                    ctxt: #0,
                                },
                                value: Atom('{string}' type=dynamic),
                            },
                        ),
                        description: Text {
                            span: Span {
                                lo: BytePos(
                                    350,
                                ),
                                hi: BytePos(
                                    350,
                                ),
                                ctxt: #0,
                            },
                            value: Atom('' type=static),
                        },
                    },
                ),
            },
        ],
    },
]