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