1 | # Change Log - @microsoft/tsdoc
|
2 |
|
3 | This log was last generated on Mon, 19 Apr 2021 21:22:32 GMT and should not be manually modified.
|
4 |
|
5 | ## 0.13.1
|
6 | Mon, 19 Apr 2021 21:22:32 GMT
|
7 |
|
8 | ### Patches
|
9 |
|
10 | - Add a new TSDocMessageId definition used by @microsoft/tsdoc-config
|
11 |
|
12 | ## 0.13.0
|
13 | Fri, 22 Jan 2021 18:07:19 GMT
|
14 |
|
15 | ### Minor changes
|
16 |
|
17 | - Update tsdoc.json schema to add a new field "noStandardTags"
|
18 | - Add new APIs: TSDocConfiguration.clear() and TSDocTagDefinition.validateTSDocTagName()
|
19 | - Add new "supportForTags" field to tsdoc.json schema
|
20 |
|
21 | ### Patches
|
22 |
|
23 | - Update doc comments to fix some syntax issues
|
24 |
|
25 | ## 0.12.24
|
26 | Thu, 03 Dec 2020 08:07:55 GMT
|
27 |
|
28 | ### Patches
|
29 |
|
30 | - Add a missing declaration file
|
31 |
|
32 | ## 0.12.23
|
33 | Thu, 03 Dec 2020 04:31:52 GMT
|
34 |
|
35 | ### Patches
|
36 |
|
37 | - Add a definition for the `@decorator` block tag (RFC 271)
|
38 |
|
39 | ## 0.12.22
|
40 | Mon, 30 Nov 2020 06:16:21 GMT
|
41 |
|
42 | ### Patches
|
43 |
|
44 | - Update documentation to reference the new website URL
|
45 | - Upgrade build tools and configuration
|
46 | - Fix typo
|
47 |
|
48 | ## 0.12.21
|
49 | Fri, 04 Sep 2020 15:53:27 GMT
|
50 |
|
51 | ### Patches
|
52 |
|
53 | - Fix an issue where the line extractor's trailing whitespace trimming sometimes trimmed a non-whitespace character (GitHub #258)
|
54 | - Update build system
|
55 |
|
56 | ## 0.12.20
|
57 | Wed, 20 May 2020 22:33:27 GMT
|
58 |
|
59 | ### Patches
|
60 |
|
61 | - Add support for `@see` tag
|
62 | - Improve documentation for `@inheritDoc`
|
63 |
|
64 | ## 0.12.19
|
65 | Fri, 27 Mar 2020 23:14:53 GMT
|
66 |
|
67 | ### Patches
|
68 |
|
69 | - Add some missing entries to TSDocConfiguration.allTsdocMessageIds() which were breaking eslint-plugin-tsdoc
|
70 | - Fix an issue where "h1" was not allowed as an HTML element name
|
71 |
|
72 | ## 0.12.18
|
73 | Sat, 22 Feb 2020 20:44:16 GMT
|
74 |
|
75 | ### Patches
|
76 |
|
77 | - Fix an issue where JSDoc optional params were not parsed correctly
|
78 |
|
79 | ## 0.12.17
|
80 | Sat, 22 Feb 2020 02:55:07 GMT
|
81 |
|
82 | ### Patches
|
83 |
|
84 | - Improve the parsing of `@param` and `@typeParam` tags to recognize legacy syntaxes
|
85 |
|
86 | ## 0.12.16
|
87 | Tue, 19 Nov 2019 22:01:56 GMT
|
88 |
|
89 | ### Patches
|
90 |
|
91 | - Add some new TSDocMessageId definitions used by @microsoft/tsdoc-config
|
92 |
|
93 | ## 0.12.15
|
94 | Sat, 09 Nov 2019 05:55:42 GMT
|
95 |
|
96 | ### Patches
|
97 |
|
98 | - Add new API TSDocConfiguration.allTsdocMessageIds
|
99 |
|
100 | ## 0.12.14
|
101 | Wed, 04 Sep 2019 03:30:10 GMT
|
102 |
|
103 | ### Patches
|
104 |
|
105 | - Fix a regression where some API signatures were incompatible with TypeScript versions prior to 3.4
|
106 |
|
107 | ## 0.12.13
|
108 | Fri, 30 Aug 2019 18:38:59 GMT
|
109 |
|
110 | ### Patches
|
111 |
|
112 | - Fix an invalid regular expression.
|
113 |
|
114 | ## 0.12.12
|
115 | Wed, 07 Aug 2019 23:06:02 GMT
|
116 |
|
117 | ### Patches
|
118 |
|
119 | - Improve DeclarationReference.parse for module sources
|
120 | - Add a definition for the `@throws` block tag (RFC 171)
|
121 |
|
122 | ## 0.12.11
|
123 | Wed, 24 Jul 2019 00:38:18 GMT
|
124 |
|
125 | ### Patches
|
126 |
|
127 | - Add new meanings to DeclarationReference and fix some parsing bugs
|
128 |
|
129 | ## 0.12.10
|
130 | Fri, 19 Jul 2019 02:47:09 GMT
|
131 |
|
132 | ### Patches
|
133 |
|
134 | - Add beta implementation of new DeclarationReference API
|
135 |
|
136 | ## 0.12.9
|
137 | Thu, 11 Apr 2019 03:58:35 GMT
|
138 |
|
139 | ### Patches
|
140 |
|
141 | - Improve the wording of the error messages involving character sequences that look like TSDoc tags
|
142 |
|
143 | ## 0.12.8
|
144 | Tue, 12 Mar 2019 23:18:11 GMT
|
145 |
|
146 | ### Patches
|
147 |
|
148 | - Fix an issue where tsdoc-param-tag-with-invalid-name was sometimes incorrectly reported certain identifiers (issue #148)
|
149 |
|
150 | ## 0.12.7
|
151 | Fri, 01 Mar 2019 06:39:52 GMT
|
152 |
|
153 | ### Patches
|
154 |
|
155 | - Add new API TSDocConfiguration.isKnownMessageId()
|
156 |
|
157 | ## 0.12.6
|
158 | Thu, 28 Feb 2019 01:29:39 GMT
|
159 |
|
160 | ### Patches
|
161 |
|
162 | - Add a new API ParserMessage.messageId with a unique ID useful for filtering and searching for errors
|
163 |
|
164 | ## 0.12.5
|
165 | Tue, 29 Jan 2019 22:49:58 GMT
|
166 |
|
167 | ### Patches
|
168 |
|
169 | - Update parser to allow `$` character in `@param` names, since ECMAScript allows this in unquoted identifiers
|
170 | - Allow `$` character in declaration reference member identifiers (Example: `{@link Button.$render}`)
|
171 |
|
172 | ## 0.12.4
|
173 | Tue, 20 Nov 2018 21:23:06 GMT
|
174 |
|
175 | ### Patches
|
176 |
|
177 | - Add new interface `IStringBuilder`
|
178 |
|
179 | ## 0.12.3
|
180 | Tue, 20 Nov 2018 07:42:17 GMT
|
181 |
|
182 | ### Patches
|
183 |
|
184 | - Add a new API `PlainTextEmitter.hasAnyTextContent()`
|
185 |
|
186 | ## 0.12.2
|
187 | Fri, 09 Nov 2018 15:13:13 GMT
|
188 |
|
189 | ### Patches
|
190 |
|
191 | - Improve trimming of spacing for link text in `{@link}` tags
|
192 |
|
193 | ## 0.12.1
|
194 | Tue, 06 Nov 2018 01:37:22 GMT
|
195 |
|
196 | ### Patches
|
197 |
|
198 | - Allow HTML in a `DocSection` node
|
199 | - Fix a bug where `TSDocEmitter.renderHtmlTag()` and `TSDocEmitter.renderDeclarationReference()` were including comment framing
|
200 | - Add `DocSection.appendNodesInParagraph()` API
|
201 |
|
202 | ## 0.12.0
|
203 | Sat, 03 Nov 2018 02:07:10 GMT
|
204 |
|
205 | ### Minor changes
|
206 |
|
207 | - (API change) `DocErrorText` is no longer allowed in `DocSection`; instead it must be part of a `DocParagraph`
|
208 | - (API change) Rename `TSDocParserConfiguration` to `TSDocConfiguration`
|
209 | - (API change) Require an associated `TSDocConfiguration` to be included with the parameters for every `DocNode` constructor
|
210 | - Introduce `TSDocConfiguration.docNodeManager` for registering custom `DocNode` subclasses and their container relationships
|
211 |
|
212 | ### Patches
|
213 |
|
214 | - Add `DocDeclarationReference.emitAsTsdoc()`, `DocHtmlStartTag.emitAsHtml()`, and `DocHtmlEndTag.emitAsHtml()`
|
215 | - Child nodes can now be specified as a second constructor parameter for `DocNodeContainer`
|
216 |
|
217 | ## 0.11.0
|
218 | Sat, 27 Oct 2018 04:52:23 GMT
|
219 |
|
220 | ### Minor changes
|
221 |
|
222 | - (API change) Introduce `DocParamCollection` to enable efficient lookups of parameters by name
|
223 | - (API change) Rename `DocComment.typeParamBlocks` --> `DocComment.typeParams`
|
224 | - (API change) Rename `DocComment.paramBlocks` --> `DocComment.params`
|
225 |
|
226 | ## 0.10.0
|
227 | Fri, 26 Oct 2018 08:42:51 GMT
|
228 |
|
229 | ### Minor changes
|
230 |
|
231 | - Add new APIs `DocComment.emitAsTsdoc()`, `TSDocEmitter`, and `StringBuilder`
|
232 |
|
233 | ## 0.9.3
|
234 | Thu, 25 Oct 2018 08:29:36 GMT
|
235 |
|
236 | ### Patches
|
237 |
|
238 | - Fix issue where `DocErrorText.text` returned `[object Object]` instead of the text
|
239 |
|
240 | ## 0.9.2
|
241 | Wed, 17 Oct 2018 13:41:54 GMT
|
242 |
|
243 | ### Patches
|
244 |
|
245 | - Fix stack overflow in DocFencedCode.language property getter
|
246 |
|
247 | ## 0.9.1
|
248 | Wed, 17 Oct 2018 12:49:01 GMT
|
249 |
|
250 | ### Patches
|
251 |
|
252 | - Fix a regression where the paragraph splitter was sometimes skipping blocks
|
253 |
|
254 | ## 0.9.0
|
255 | Wed, 17 Oct 2018 04:47:19 GMT
|
256 |
|
257 | ### Minor changes
|
258 |
|
259 | - (API change) Change `DocBlock` to have a `DocSection` property rather than inheriting from `DocSection`; this eliminates confusion about which nodes belong to the container
|
260 | - (API change) Rename `DocParticle` to `DocExcerpt`, and eliminate the `Excerpt` class
|
261 | - (API change) Eliminate `DocNodeLeaf`, since now `DocExcerpt` is the only class that can represent excerpts
|
262 | - (API change) Remove `DocNode.updateParameters()` because it is no longer needed
|
263 | - (API change) Spacing is now represented as a normal `DocExcerpt`, rather than via a special `Excerpt.spacingAfterContent`
|
264 | - (API change) Simplify `DocNodeTransforms.trimSpacesInParagraph()` to no longer merge/remap excerpts during the transformation. If we need this information, we will track it differently.
|
265 |
|
266 | ## 0.8.1
|
267 | Sun, 07 Oct 2018 06:30:34 GMT
|
268 |
|
269 | ### Patches
|
270 |
|
271 | - Improve error reporting for declaration references that are probably missing a `"#"` delimiter
|
272 | - Rename `DocCodeFence` to `DocFencedCode`
|
273 |
|
274 | ## 0.8.0
|
275 | Wed, 03 Oct 2018 02:43:47 GMT
|
276 |
|
277 | ### Minor changes
|
278 |
|
279 | - Introduce a distinction between "defined" tags (i.e. recognized) versus "supported" tags (i.e. implemented by the tool)
|
280 | - The parser optionally reports usage of undefined tags
|
281 | - The parser optionally reports usage of unsupported tags
|
282 | - The parser reports usage of inline/block syntax that is inconsistent with the tag definition
|
283 | - Code spans are now allowed to be adjacent to other text, but must contain at least one character
|
284 | - An `@deprecated` block must contain a deprecation message
|
285 | - If `@inheritDoc` is used, then the summary section must be empty, and there must not be an `@remarks` block
|
286 |
|
287 | ## 0.7.0
|
288 | Tue, 02 Oct 2018 02:35:35 GMT
|
289 |
|
290 | ### Minor changes
|
291 |
|
292 | - Add support for `@defaultValue` tag
|
293 | - Add support for `@typeParam` tag
|
294 |
|
295 | ## 0.6.0
|
296 | Mon, 01 Oct 2018 22:11:24 GMT
|
297 |
|
298 | ### Minor changes
|
299 |
|
300 | - Add support for `@link` tags using the new declaration reference syntax
|
301 | - Add support for `@inheritDoc` tags
|
302 | - Add new APIs: `DocDeclarationReference`, `DocInheritDocTag`, `DocLinkTag`, `DocMemberIdentifier`, `DocMemberReference`, `DocMemberSelector`, `DocMemberSymbol`
|
303 | - Remove `ParserContext.verbatimNodes`
|
304 | - Add `DocParticle.particleId` property
|
305 |
|
306 | ## 0.5.0
|
307 | Tue, 25 Sep 2018 03:04:06 GMT
|
308 |
|
309 | ### Minor changes
|
310 |
|
311 | - 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
|
312 | - Add `DocNodeTransforms.trimSpacesInParagraphNodes()` for collapsing whitespace inside `DocParagraph` subtrees
|
313 | - Extract the `DocNode.excerpt` property into a new abstract base class `DocNodeLeaf`
|
314 |
|
315 | ## 0.4.1
|
316 | Fri, 31 Aug 2018 03:32:18 GMT
|
317 |
|
318 | ### Patches
|
319 |
|
320 | - Improve the error location reporting for DocErrorText objects
|
321 | - 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
|
322 |
|
323 | ## 0.4.0
|
324 | Tue, 28 Aug 2018 03:17:20 GMT
|
325 |
|
326 | ### Minor changes
|
327 |
|
328 | - Rename `DocCodeSpan.text` to `DocCodeSpan.code` and model the delimiters using particles
|
329 | - Add support for code fences (`DocCodeFence`)
|
330 | - `DocSection` content is now grouped into `DocParagraph` nodes; blank lines are used to indicate paragraph boundaries
|
331 | - Rename `DocComment.deprecated` to `deprecatedBlock`
|
332 |
|
333 | ## 0.3.0
|
334 | Sat, 25 Aug 2018 05:53:56 GMT
|
335 |
|
336 | ### Minor changes
|
337 |
|
338 | - Add TextRange.isEmpty()
|
339 | - Improve the ModifierTagSet API
|
340 | - Implement the @privateRemarks and @deprecated tags
|
341 |
|
342 | ## 0.2.0
|
343 | Fri, 24 Aug 2018 01:19:56 GMT
|
344 |
|
345 | ### Minor changes
|
346 |
|
347 | - Rename `CoreTags` to `StandardTags` so we can include non-core tags in the standard definitions
|
348 | - Rename `CoreModifierTagSet` to `StandardModifierTagSet` and convert properties to functions
|
349 | - Categorize the standard tags according to a `Standardization` enum, and document them
|
350 | - Add more standard tag definitions: `@deprecated`, `@eventProperty`, `@example`, `@inheritDoc`, `@link`, `@override`, `@packageDocumentation`, `@public`, `@privateRemarks`, `@sealed`, `@virtual`
|
351 | - Replace TSDocTagDefinition.singleton with TSDocTagDefinition.allowMultiple, since in practice most tags are single-usage
|
352 |
|
353 | ## 0.1.0
|
354 | Thu, 16 Aug 2018 18:18:02 GMT
|
355 |
|
356 | ### Minor changes
|
357 |
|
358 | - Initial release of the TSDoc library! :-)
|
359 |
|