1 | {
|
2 | "name": "@microsoft/tsdoc",
|
3 | "entries": [
|
4 | {
|
5 | "version": "0.12.20",
|
6 | "tag": "@microsoft/tsdoc_v0.12.20",
|
7 | "date": "Wed, 20 May 2020 22:33:27 GMT",
|
8 | "comments": {
|
9 | "patch": [
|
10 | {
|
11 | "comment": "Add support for `@see` tag"
|
12 | },
|
13 | {
|
14 | "comment": "Improve documentation for `@inheritDoc`"
|
15 | }
|
16 | ]
|
17 | }
|
18 | },
|
19 | {
|
20 | "version": "0.12.19",
|
21 | "tag": "@microsoft/tsdoc_v0.12.19",
|
22 | "date": "Fri, 27 Mar 2020 23:14:53 GMT",
|
23 | "comments": {
|
24 | "patch": [
|
25 | {
|
26 | "comment": "Add some missing entries to TSDocConfiguration.allTsdocMessageIds() which were breaking eslint-plugin-tsdoc"
|
27 | },
|
28 | {
|
29 | "comment": "Fix an issue where \"h1\" was not allowed as an HTML element name"
|
30 | }
|
31 | ]
|
32 | }
|
33 | },
|
34 | {
|
35 | "version": "0.12.18",
|
36 | "tag": "@microsoft/tsdoc_v0.12.18",
|
37 | "date": "Sat, 22 Feb 2020 20:44:16 GMT",
|
38 | "comments": {
|
39 | "patch": [
|
40 | {
|
41 | "comment": "Fix an issue where JSDoc optional params were not parsed correctly"
|
42 | }
|
43 | ]
|
44 | }
|
45 | },
|
46 | {
|
47 | "version": "0.12.17",
|
48 | "tag": "@microsoft/tsdoc_v0.12.17",
|
49 | "date": "Sat, 22 Feb 2020 02:55:07 GMT",
|
50 | "comments": {
|
51 | "patch": [
|
52 | {
|
53 | "comment": "Improve the parsing of `@param` and `@typeParam` tags to recognize legacy syntaxes"
|
54 | }
|
55 | ]
|
56 | }
|
57 | },
|
58 | {
|
59 | "version": "0.12.16",
|
60 | "tag": "@microsoft/tsdoc_v0.12.16",
|
61 | "date": "Tue, 19 Nov 2019 22:01:56 GMT",
|
62 | "comments": {
|
63 | "patch": [
|
64 | {
|
65 | "comment": "Add some new TSDocMessageId definitions used by @microsoft/tsdoc-config"
|
66 | }
|
67 | ]
|
68 | }
|
69 | },
|
70 | {
|
71 | "version": "0.12.15",
|
72 | "tag": "@microsoft/tsdoc_v0.12.15",
|
73 | "date": "Sat, 09 Nov 2019 05:55:42 GMT",
|
74 | "comments": {
|
75 | "patch": [
|
76 | {
|
77 | "comment": "Add new API TSDocConfiguration.allTsdocMessageIds"
|
78 | }
|
79 | ]
|
80 | }
|
81 | },
|
82 | {
|
83 | "version": "0.12.14",
|
84 | "tag": "@microsoft/tsdoc_v0.12.14",
|
85 | "date": "Wed, 04 Sep 2019 03:30:10 GMT",
|
86 | "comments": {
|
87 | "patch": [
|
88 | {
|
89 | "comment": "Fix a regression where some API signatures were incompatible with TypeScript versions prior to 3.4"
|
90 | }
|
91 | ]
|
92 | }
|
93 | },
|
94 | {
|
95 | "version": "0.12.13",
|
96 | "tag": "@microsoft/tsdoc_v0.12.13",
|
97 | "date": "Fri, 30 Aug 2019 18:38:59 GMT",
|
98 | "comments": {
|
99 | "patch": [
|
100 | {
|
101 | "comment": "Fix an invalid regular expression."
|
102 | }
|
103 | ]
|
104 | }
|
105 | },
|
106 | {
|
107 | "version": "0.12.12",
|
108 | "tag": "@microsoft/tsdoc_v0.12.12",
|
109 | "date": "Wed, 07 Aug 2019 23:06:02 GMT",
|
110 | "comments": {
|
111 | "patch": [
|
112 | {
|
113 | "comment": "Improve DeclarationReference.parse for module sources"
|
114 | },
|
115 | {
|
116 | "comment": "Add a definition for the `@throws` block tag (RFC 171)"
|
117 | }
|
118 | ]
|
119 | }
|
120 | },
|
121 | {
|
122 | "version": "0.12.11",
|
123 | "tag": "@microsoft/tsdoc_v0.12.11",
|
124 | "date": "Wed, 24 Jul 2019 00:38:18 GMT",
|
125 | "comments": {
|
126 | "patch": [
|
127 | {
|
128 | "comment": "Add new meanings to DeclarationReference and fix some parsing bugs"
|
129 | }
|
130 | ]
|
131 | }
|
132 | },
|
133 | {
|
134 | "version": "0.12.10",
|
135 | "tag": "@microsoft/tsdoc_v0.12.10",
|
136 | "date": "Fri, 19 Jul 2019 02:47:09 GMT",
|
137 | "comments": {
|
138 | "patch": [
|
139 | {
|
140 | "comment": "Add beta implementation of new DeclarationReference API"
|
141 | }
|
142 | ]
|
143 | }
|
144 | },
|
145 | {
|
146 | "version": "0.12.9",
|
147 | "tag": "@microsoft/tsdoc_v0.12.9",
|
148 | "date": "Thu, 11 Apr 2019 03:58:35 GMT",
|
149 | "comments": {
|
150 | "patch": [
|
151 | {
|
152 | "comment": "Improve the wording of the error messages involving character sequences that look like TSDoc tags"
|
153 | }
|
154 | ]
|
155 | }
|
156 | },
|
157 | {
|
158 | "version": "0.12.8",
|
159 | "tag": "@microsoft/tsdoc_v0.12.8",
|
160 | "date": "Tue, 12 Mar 2019 23:18:11 GMT",
|
161 | "comments": {
|
162 | "patch": [
|
163 | {
|
164 | "comment": "Fix an issue where tsdoc-param-tag-with-invalid-name was sometimes incorrectly reported certain identifiers (issue #148)"
|
165 | }
|
166 | ]
|
167 | }
|
168 | },
|
169 | {
|
170 | "version": "0.12.7",
|
171 | "tag": "@microsoft/tsdoc_v0.12.7",
|
172 | "date": "Fri, 01 Mar 2019 06:39:52 GMT",
|
173 | "comments": {
|
174 | "patch": [
|
175 | {
|
176 | "comment": "Add new API TSDocConfiguration.isKnownMessageId()"
|
177 | }
|
178 | ]
|
179 | }
|
180 | },
|
181 | {
|
182 | "version": "0.12.6",
|
183 | "tag": "@microsoft/tsdoc_v0.12.6",
|
184 | "date": "Thu, 28 Feb 2019 01:29:39 GMT",
|
185 | "comments": {
|
186 | "patch": [
|
187 | {
|
188 | "comment": "Add a new API ParserMessage.messageId with a unique ID useful for filtering and searching for errors"
|
189 | }
|
190 | ]
|
191 | }
|
192 | },
|
193 | {
|
194 | "version": "0.12.5",
|
195 | "tag": "@microsoft/tsdoc_v0.12.5",
|
196 | "date": "Tue, 29 Jan 2019 22:49:58 GMT",
|
197 | "comments": {
|
198 | "patch": [
|
199 | {
|
200 | "comment": "Update parser to allow `$` character in `@param` names, since ECMAScript allows this in unquoted identifiers"
|
201 | },
|
202 | {
|
203 | "comment": "Allow `$` character in declaration reference member identifiers (Example: `{@link Button.$render}`)"
|
204 | }
|
205 | ]
|
206 | }
|
207 | },
|
208 | {
|
209 | "version": "0.12.4",
|
210 | "tag": "@microsoft/tsdoc_v0.12.4",
|
211 | "date": "Tue, 20 Nov 2018 21:23:06 GMT",
|
212 | "comments": {
|
213 | "patch": [
|
214 | {
|
215 | "comment": "Add new interface `IStringBuilder`"
|
216 | }
|
217 | ]
|
218 | }
|
219 | },
|
220 | {
|
221 | "version": "0.12.3",
|
222 | "tag": "@microsoft/tsdoc_v0.12.3",
|
223 | "date": "Tue, 20 Nov 2018 07:42:17 GMT",
|
224 | "comments": {
|
225 | "patch": [
|
226 | {
|
227 | "comment": "Add a new API `PlainTextEmitter.hasAnyTextContent()`"
|
228 | }
|
229 | ]
|
230 | }
|
231 | },
|
232 | {
|
233 | "version": "0.12.2",
|
234 | "tag": "@microsoft/tsdoc_v0.12.2",
|
235 | "date": "Fri, 09 Nov 2018 15:13:13 GMT",
|
236 | "comments": {
|
237 | "patch": [
|
238 | {
|
239 | "comment": "Improve trimming of spacing for link text in `{@link}` tags"
|
240 | }
|
241 | ]
|
242 | }
|
243 | },
|
244 | {
|
245 | "version": "0.12.1",
|
246 | "tag": "@microsoft/tsdoc_v0.12.1",
|
247 | "date": "Tue, 06 Nov 2018 01:37:22 GMT",
|
248 | "comments": {
|
249 | "patch": [
|
250 | {
|
251 | "comment": "Allow HTML in a `DocSection` node"
|
252 | },
|
253 | {
|
254 | "comment": "Fix a bug where `TSDocEmitter.renderHtmlTag()` and `TSDocEmitter.renderDeclarationReference()` were including comment framing"
|
255 | },
|
256 | {
|
257 | "comment": "Add `DocSection.appendNodesInParagraph()` API"
|
258 | }
|
259 | ]
|
260 | }
|
261 | },
|
262 | {
|
263 | "version": "0.12.0",
|
264 | "tag": "@microsoft/tsdoc_v0.12.0",
|
265 | "date": "Sat, 03 Nov 2018 02:07:10 GMT",
|
266 | "comments": {
|
267 | "patch": [
|
268 | {
|
269 | "comment": "Add `DocDeclarationReference.emitAsTsdoc()`, `DocHtmlStartTag.emitAsHtml()`, and `DocHtmlEndTag.emitAsHtml()`"
|
270 | },
|
271 | {
|
272 | "comment": "Child nodes can now be specified as a second constructor parameter for `DocNodeContainer`"
|
273 | }
|
274 | ],
|
275 | "minor": [
|
276 | {
|
277 | "comment": "(API change) `DocErrorText` is no longer allowed in `DocSection`; instead it must be part of a `DocParagraph`"
|
278 | },
|
279 | {
|
280 | "comment": "(API change) Rename `TSDocParserConfiguration` to `TSDocConfiguration`"
|
281 | },
|
282 | {
|
283 | "comment": "(API change) Require an associated `TSDocConfiguration` to be included with the parameters for every `DocNode` constructor"
|
284 | },
|
285 | {
|
286 | "comment": "Introduce `TSDocConfiguration.docNodeManager` for registering custom `DocNode` subclasses and their container relationships"
|
287 | }
|
288 | ]
|
289 | }
|
290 | },
|
291 | {
|
292 | "version": "0.11.0",
|
293 | "tag": "@microsoft/tsdoc_v0.11.0",
|
294 | "date": "Sat, 27 Oct 2018 04:52:23 GMT",
|
295 | "comments": {
|
296 | "minor": [
|
297 | {
|
298 | "comment": "(API change) Introduce `DocParamCollection` to enable efficient lookups of parameters by name"
|
299 | },
|
300 | {
|
301 | "comment": "(API change) Rename `DocComment.typeParamBlocks` --> `DocComment.typeParams`"
|
302 | },
|
303 | {
|
304 | "comment": "(API change) Rename `DocComment.paramBlocks` --> `DocComment.params`"
|
305 | }
|
306 | ]
|
307 | }
|
308 | },
|
309 | {
|
310 | "version": "0.10.0",
|
311 | "tag": "@microsoft/tsdoc_v0.10.0",
|
312 | "date": "Fri, 26 Oct 2018 08:42:51 GMT",
|
313 | "comments": {
|
314 | "minor": [
|
315 | {
|
316 | "comment": "Add new APIs `DocComment.emitAsTsdoc()`, `TSDocEmitter`, and `StringBuilder`"
|
317 | }
|
318 | ]
|
319 | }
|
320 | },
|
321 | {
|
322 | "version": "0.9.3",
|
323 | "tag": "@microsoft/tsdoc_v0.9.3",
|
324 | "date": "Thu, 25 Oct 2018 08:29:36 GMT",
|
325 | "comments": {
|
326 | "patch": [
|
327 | {
|
328 | "comment": "Fix issue where `DocErrorText.text` returned `[object Object]` instead of the text"
|
329 | }
|
330 | ]
|
331 | }
|
332 | },
|
333 | {
|
334 | "version": "0.9.2",
|
335 | "tag": "@microsoft/tsdoc_v0.9.2",
|
336 | "date": "Wed, 17 Oct 2018 13:41:54 GMT",
|
337 | "comments": {
|
338 | "patch": [
|
339 | {
|
340 | "comment": "Fix stack overflow in DocFencedCode.language property getter"
|
341 | }
|
342 | ]
|
343 | }
|
344 | },
|
345 | {
|
346 | "version": "0.9.1",
|
347 | "tag": "@microsoft/tsdoc_v0.9.1",
|
348 | "date": "Wed, 17 Oct 2018 12:49:01 GMT",
|
349 | "comments": {
|
350 | "patch": [
|
351 | {
|
352 | "comment": "Fix a regression where the paragraph splitter was sometimes skipping blocks"
|
353 | }
|
354 | ]
|
355 | }
|
356 | },
|
357 | {
|
358 | "version": "0.9.0",
|
359 | "tag": "@microsoft/tsdoc_v0.9.0",
|
360 | "date": "Wed, 17 Oct 2018 04:47:19 GMT",
|
361 | "comments": {
|
362 | "minor": [
|
363 | {
|
364 | "comment": "(API change) Change `DocBlock` to have a `DocSection` property rather than inheriting from `DocSection`; this eliminates confusion about which nodes belong to the container"
|
365 | },
|
366 | {
|
367 | "comment": "(API change) Rename `DocParticle` to `DocExcerpt`, and eliminate the `Excerpt` class"
|
368 | },
|
369 | {
|
370 | "comment": "(API change) Eliminate `DocNodeLeaf`, since now `DocExcerpt` is the only class that can represent excerpts"
|
371 | },
|
372 | {
|
373 | "comment": "(API change) Remove `DocNode.updateParameters()` because it is no longer needed"
|
374 | },
|
375 | {
|
376 | "comment": "(API change) Spacing is now represented as a normal `DocExcerpt`, rather than via a special `Excerpt.spacingAfterContent`"
|
377 | },
|
378 | {
|
379 | "comment": "(API change) Simplify `DocNodeTransforms.trimSpacesInParagraph()` to no longer merge/remap excerpts during the transformation. If we need this information, we will track it differently."
|
380 | }
|
381 | ]
|
382 | }
|
383 | },
|
384 | {
|
385 | "version": "0.8.1",
|
386 | "tag": "@microsoft/api-extractor_v0.8.1",
|
387 | "date": "Sun, 07 Oct 2018 06:30:34 GMT",
|
388 | "comments": {
|
389 | "patch": [
|
390 | {
|
391 | "comment": "Improve error reporting for declaration references that are probably missing a `\"#\"` delimiter"
|
392 | },
|
393 | {
|
394 | "comment": "Rename `DocCodeFence` to `DocFencedCode`"
|
395 | }
|
396 | ]
|
397 | }
|
398 | },
|
399 | {
|
400 | "version": "0.8.0",
|
401 | "tag": "@microsoft/api-extractor_v0.8.0",
|
402 | "date": "Wed, 03 Oct 2018 02:43:47 GMT",
|
403 | "comments": {
|
404 | "minor": [
|
405 | {
|
406 | "comment": "Introduce a distinction between \"defined\" tags (i.e. recognized) versus \"supported\" tags (i.e. implemented by the tool)"
|
407 | },
|
408 | {
|
409 | "comment": "The parser optionally reports usage of undefined tags"
|
410 | },
|
411 | {
|
412 | "comment": "The parser optionally reports usage of unsupported tags"
|
413 | },
|
414 | {
|
415 | "comment": "The parser reports usage of inline/block syntax that is inconsistent with the tag definition"
|
416 | },
|
417 | {
|
418 | "comment": "Code spans are now allowed to be adjacent to other text, but must contain at least one character"
|
419 | },
|
420 | {
|
421 | "comment": "An `@deprecated` block must contain a deprecation message"
|
422 | },
|
423 | {
|
424 | "comment": "If `@inheritDoc` is used, then the summary section must be empty, and there must not be an `@remarks` block"
|
425 | }
|
426 | ]
|
427 | }
|
428 | },
|
429 | {
|
430 | "version": "0.7.0",
|
431 | "tag": "@microsoft/api-extractor_v0.7.0",
|
432 | "date": "Tue, 02 Oct 2018 02:35:35 GMT",
|
433 | "comments": {
|
434 | "minor": [
|
435 | {
|
436 | "comment": "Add support for `@defaultValue` tag"
|
437 | },
|
438 | {
|
439 | "comment": "Add support for `@typeParam` tag"
|
440 | }
|
441 | ]
|
442 | }
|
443 | },
|
444 | {
|
445 | "version": "0.6.0",
|
446 | "tag": "@microsoft/api-extractor_v0.6.0",
|
447 | "date": "Mon, 01 Oct 2018 22:11:24 GMT",
|
448 | "comments": {
|
449 | "minor": [
|
450 | {
|
451 | "comment": "Add support for `@link` tags using the new declaration reference syntax"
|
452 | },
|
453 | {
|
454 | "comment": "Add support for `@inheritDoc` tags"
|
455 | },
|
456 | {
|
457 | "comment": "Add new APIs: `DocDeclarationReference`, `DocInheritDocTag`, `DocLinkTag`, `DocMemberIdentifier`, `DocMemberReference`, `DocMemberSelector`, `DocMemberSymbol`"
|
458 | },
|
459 | {
|
460 | "comment": "Remove `ParserContext.verbatimNodes`"
|
461 | },
|
462 | {
|
463 | "comment": "Add `DocParticle.particleId` property"
|
464 | }
|
465 | ]
|
466 | }
|
467 | },
|
468 | {
|
469 | "version": "0.5.0",
|
470 | "tag": "@microsoft/api-extractor_v0.5.0",
|
471 | "date": "Tue, 25 Sep 2018 03:04:06 GMT",
|
472 | "comments": {
|
473 | "minor": [
|
474 | {
|
475 | "comment": "Add a new API `DocNode.updateParameters()` that allows a `DocNode` object to be updated after it was created; the tree nodes are no longer immutable"
|
476 | },
|
477 | {
|
478 | "comment": "Add `DocNodeTransforms.trimSpacesInParagraphNodes()` for collapsing whitespace inside `DocParagraph` subtrees"
|
479 | },
|
480 | {
|
481 | "comment": "Extract the `DocNode.excerpt` property into a new abstract base class `DocNodeLeaf`"
|
482 | }
|
483 | ]
|
484 | }
|
485 | },
|
486 | {
|
487 | "version": "0.4.1",
|
488 | "tag": "@microsoft/api-extractor_v0.4.1",
|
489 | "date": "Fri, 31 Aug 2018 03:32:18 GMT",
|
490 | "comments": {
|
491 | "patch": [
|
492 | {
|
493 | "comment": "Improve the error location reporting for DocErrorText objects"
|
494 | },
|
495 | {
|
496 | "comment": "Separate the **api-demo** sample into a \"simple\" scenario which parses a simple text string, and an \"advanced\" scenario which uses the TypeScript compiler API to extract comments and parse custom TSDoc tags"
|
497 | }
|
498 | ]
|
499 | }
|
500 | },
|
501 | {
|
502 | "version": "0.4.0",
|
503 | "tag": "@microsoft/api-extractor_v0.4.0",
|
504 | "date": "Tue, 28 Aug 2018 03:17:20 GMT",
|
505 | "comments": {
|
506 | "minor": [
|
507 | {
|
508 | "comment": "Rename `DocCodeSpan.text` to `DocCodeSpan.code` and model the delimiters using particles"
|
509 | },
|
510 | {
|
511 | "comment": "Add support for code fences (`DocCodeFence`)"
|
512 | },
|
513 | {
|
514 | "comment": "`DocSection` content is now grouped into `DocParagraph` nodes; blank lines are used to indicate paragraph boundaries"
|
515 | },
|
516 | {
|
517 | "comment": "Rename `DocComment.deprecated` to `deprecatedBlock`"
|
518 | }
|
519 | ]
|
520 | }
|
521 | },
|
522 | {
|
523 | "version": "0.3.0",
|
524 | "tag": "@microsoft/api-extractor_v0.3.0",
|
525 | "date": "Sat, 25 Aug 2018 05:53:56 GMT",
|
526 | "comments": {
|
527 | "minor": [
|
528 | {
|
529 | "comment": "Add TextRange.isEmpty()"
|
530 | },
|
531 | {
|
532 | "comment": "Improve the ModifierTagSet API"
|
533 | },
|
534 | {
|
535 | "comment": "Implement the @privateRemarks and @deprecated tags"
|
536 | }
|
537 | ]
|
538 | }
|
539 | },
|
540 | {
|
541 | "version": "0.2.0",
|
542 | "tag": "@microsoft/api-extractor_v0.2.0",
|
543 | "date": "Fri, 24 Aug 2018 01:19:56 GMT",
|
544 | "comments": {
|
545 | "minor": [
|
546 | {
|
547 | "comment": "Rename `CoreTags` to `StandardTags` so we can include non-core tags in the standard definitions"
|
548 | },
|
549 | {
|
550 | "comment": "Rename `CoreModifierTagSet` to `StandardModifierTagSet` and convert properties to functions"
|
551 | },
|
552 | {
|
553 | "comment": "Categorize the standard tags according to a `Standardization` enum, and document them"
|
554 | },
|
555 | {
|
556 | "comment": "Add more standard tag definitions: `@deprecated`, `@eventProperty`, `@example`, `@inheritDoc`, `@link`, `@override`, `@packageDocumentation`, `@public`, `@privateRemarks`, `@sealed`, `@virtual`"
|
557 | },
|
558 | {
|
559 | "comment": "Replace TSDocTagDefinition.singleton with TSDocTagDefinition.allowMultiple, since in practice most tags are single-usage"
|
560 | }
|
561 | ]
|
562 | }
|
563 | },
|
564 | {
|
565 | "version": "0.1.0",
|
566 | "tag": "@microsoft/api-extractor_v0.1.0",
|
567 | "date": "Thu, 16 Aug 2018 18:18:02 GMT",
|
568 | "comments": {
|
569 | "minor": [
|
570 | {
|
571 | "comment": "Initial release of the TSDoc library! :-)"
|
572 | }
|
573 | ]
|
574 | }
|
575 | }
|
576 | ]
|
577 | }
|