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