389 lines
11 KiB
Markdown
389 lines
11 KiB
Markdown
|
# Change Log - @microsoft/tsdoc
|
||
|
|
|
||
|
|
This log was last generated on Wed, 14 Sep 2022 02:55:06 GMT and should not be manually modified.
|
||
|
|
|
||
|
|
## 0.14.2
|
||
|
|
Wed, 14 Sep 2022 02:55:06 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Update an internal type import to avoid a circular reference (GitHub #327 and #328)
|
||
|
|
|
||
|
|
## 0.14.1
|
||
|
|
Sat, 09 Apr 2022 02:28:41 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Rename the "master" branch to "main."
|
||
|
|
|
||
|
|
## 0.14.0
|
||
|
|
Thu, 07 Apr 2022 22:51:07 GMT
|
||
|
|
|
||
|
|
### Minor changes
|
||
|
|
|
||
|
|
- Add `supportedHtmlElements` and `reportUnsupportedHtmlElements` options and corresponding validation
|
||
|
|
- Convert "const enum" APIs to be regular enums to enable compatibility with isolatedModules=true (GitHub #306)
|
||
|
|
|
||
|
|
## 0.13.2
|
||
|
|
Tue, 20 Apr 2021 04:25:13 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Fix an issue where "tsdoc-inline-tag-missing-braces" and "tsdoc-tag-should-not-have-braces" were reported incorrectly
|
||
|
|
|
||
|
|
## 0.13.1
|
||
|
|
Mon, 19 Apr 2021 21:22:32 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Add a new TSDocMessageId definition used by @microsoft/tsdoc-config
|
||
|
|
|
||
|
|
## 0.13.0
|
||
|
|
Fri, 22 Jan 2021 18:07:19 GMT
|
||
|
|
|
||
|
|
### Minor changes
|
||
|
|
|
||
|
|
- Update tsdoc.json schema to add a new field "noStandardTags"
|
||
|
|
- Add new APIs: TSDocConfiguration.clear() and TSDocTagDefinition.validateTSDocTagName()
|
||
|
|
- Add new "supportForTags" field to tsdoc.json schema
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Update doc comments to fix some syntax issues
|
||
|
|
|
||
|
|
## 0.12.24
|
||
|
|
Thu, 03 Dec 2020 08:07:55 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Add a missing declaration file
|
||
|
|
|
||
|
|
## 0.12.23
|
||
|
|
Thu, 03 Dec 2020 04:31:52 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Add a definition for the `@decorator` block tag (RFC 271)
|
||
|
|
|
||
|
|
## 0.12.22
|
||
|
|
Mon, 30 Nov 2020 06:16:21 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Update documentation to reference the new website URL
|
||
|
|
- Upgrade build tools and configuration
|
||
|
|
- Fix typo
|
||
|
|
|
||
|
|
## 0.12.21
|
||
|
|
Fri, 04 Sep 2020 15:53:27 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Fix an issue where the line extractor's trailing whitespace trimming sometimes trimmed a non-whitespace character (GitHub #258)
|
||
|
|
- Update build system
|
||
|
|
|
||
|
|
## 0.12.20
|
||
|
|
Wed, 20 May 2020 22:33:27 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Add support for `@see` tag
|
||
|
|
- Improve documentation for `@inheritDoc`
|
||
|
|
|
||
|
|
## 0.12.19
|
||
|
|
Fri, 27 Mar 2020 23:14:53 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Add some missing entries to TSDocConfiguration.allTsdocMessageIds() which were breaking eslint-plugin-tsdoc
|
||
|
|
- Fix an issue where "h1" was not allowed as an HTML element name
|
||
|
|
|
||
|
|
## 0.12.18
|
||
|
|
Sat, 22 Feb 2020 20:44:16 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Fix an issue where JSDoc optional params were not parsed correctly
|
||
|
|
|
||
|
|
## 0.12.17
|
||
|
|
Sat, 22 Feb 2020 02:55:07 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Improve the parsing of `@param` and `@typeParam` tags to recognize legacy syntaxes
|
||
|
|
|
||
|
|
## 0.12.16
|
||
|
|
Tue, 19 Nov 2019 22:01:56 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Add some new TSDocMessageId definitions used by @microsoft/tsdoc-config
|
||
|
|
|
||
|
|
## 0.12.15
|
||
|
|
Sat, 09 Nov 2019 05:55:42 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Add new API TSDocConfiguration.allTsdocMessageIds
|
||
|
|
|
||
|
|
## 0.12.14
|
||
|
|
Wed, 04 Sep 2019 03:30:10 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Fix a regression where some API signatures were incompatible with TypeScript versions prior to 3.4
|
||
|
|
|
||
|
|
## 0.12.13
|
||
|
|
Fri, 30 Aug 2019 18:38:59 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Fix an invalid regular expression.
|
||
|
|
|
||
|
|
## 0.12.12
|
||
|
|
Wed, 07 Aug 2019 23:06:02 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Improve DeclarationReference.parse for module sources
|
||
|
|
- Add a definition for the `@throws` block tag (RFC 171)
|
||
|
|
|
||
|
|
## 0.12.11
|
||
|
|
Wed, 24 Jul 2019 00:38:18 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Add new meanings to DeclarationReference and fix some parsing bugs
|
||
|
|
|
||
|
|
## 0.12.10
|
||
|
|
Fri, 19 Jul 2019 02:47:09 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Add beta implementation of new DeclarationReference API
|
||
|
|
|
||
|
|
## 0.12.9
|
||
|
|
Thu, 11 Apr 2019 03:58:35 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Improve the wording of the error messages involving character sequences that look like TSDoc tags
|
||
|
|
|
||
|
|
## 0.12.8
|
||
|
|
Tue, 12 Mar 2019 23:18:11 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Fix an issue where tsdoc-param-tag-with-invalid-name was sometimes incorrectly reported certain identifiers (issue #148)
|
||
|
|
|
||
|
|
## 0.12.7
|
||
|
|
Fri, 01 Mar 2019 06:39:52 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Add new API TSDocConfiguration.isKnownMessageId()
|
||
|
|
|
||
|
|
## 0.12.6
|
||
|
|
Thu, 28 Feb 2019 01:29:39 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Add a new API ParserMessage.messageId with a unique ID useful for filtering and searching for errors
|
||
|
|
|
||
|
|
## 0.12.5
|
||
|
|
Tue, 29 Jan 2019 22:49:58 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Update parser to allow `$` character in `@param` names, since ECMAScript allows this in unquoted identifiers
|
||
|
|
- Allow `$` character in declaration reference member identifiers (Example: `{@link Button.$render}`)
|
||
|
|
|
||
|
|
## 0.12.4
|
||
|
|
Tue, 20 Nov 2018 21:23:06 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Add new interface `IStringBuilder`
|
||
|
|
|
||
|
|
## 0.12.3
|
||
|
|
Tue, 20 Nov 2018 07:42:17 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Add a new API `PlainTextEmitter.hasAnyTextContent()`
|
||
|
|
|
||
|
|
## 0.12.2
|
||
|
|
Fri, 09 Nov 2018 15:13:13 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Improve trimming of spacing for link text in `{@link}` tags
|
||
|
|
|
||
|
|
## 0.12.1
|
||
|
|
Tue, 06 Nov 2018 01:37:22 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Allow HTML in a `DocSection` node
|
||
|
|
- Fix a bug where `TSDocEmitter.renderHtmlTag()` and `TSDocEmitter.renderDeclarationReference()` were including comment framing
|
||
|
|
- Add `DocSection.appendNodesInParagraph()` API
|
||
|
|
|
||
|
|
## 0.12.0
|
||
|
|
Sat, 03 Nov 2018 02:07:10 GMT
|
||
|
|
|
||
|
|
### Minor changes
|
||
|
|
|
||
|
|
- (API change) `DocErrorText` is no longer allowed in `DocSection`; instead it must be part of a `DocParagraph`
|
||
|
|
- (API change) Rename `TSDocParserConfiguration` to `TSDocConfiguration`
|
||
|
|
- (API change) Require an associated `TSDocConfiguration` to be included with the parameters for every `DocNode` constructor
|
||
|
|
- Introduce `TSDocConfiguration.docNodeManager` for registering custom `DocNode` subclasses and their container relationships
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Add `DocDeclarationReference.emitAsTsdoc()`, `DocHtmlStartTag.emitAsHtml()`, and `DocHtmlEndTag.emitAsHtml()`
|
||
|
|
- Child nodes can now be specified as a second constructor parameter for `DocNodeContainer`
|
||
|
|
|
||
|
|
## 0.11.0
|
||
|
|
Sat, 27 Oct 2018 04:52:23 GMT
|
||
|
|
|
||
|
|
### Minor changes
|
||
|
|
|
||
|
|
- (API change) Introduce `DocParamCollection` to enable efficient lookups of parameters by name
|
||
|
|
- (API change) Rename `DocComment.typeParamBlocks` --> `DocComment.typeParams`
|
||
|
|
- (API change) Rename `DocComment.paramBlocks` --> `DocComment.params`
|
||
|
|
|
||
|
|
## 0.10.0
|
||
|
|
Fri, 26 Oct 2018 08:42:51 GMT
|
||
|
|
|
||
|
|
### Minor changes
|
||
|
|
|
||
|
|
- Add new APIs `DocComment.emitAsTsdoc()`, `TSDocEmitter`, and `StringBuilder`
|
||
|
|
|
||
|
|
## 0.9.3
|
||
|
|
Thu, 25 Oct 2018 08:29:36 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Fix issue where `DocErrorText.text` returned `[object Object]` instead of the text
|
||
|
|
|
||
|
|
## 0.9.2
|
||
|
|
Wed, 17 Oct 2018 13:41:54 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Fix stack overflow in DocFencedCode.language property getter
|
||
|
|
|
||
|
|
## 0.9.1
|
||
|
|
Wed, 17 Oct 2018 12:49:01 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Fix a regression where the paragraph splitter was sometimes skipping blocks
|
||
|
|
|
||
|
|
## 0.9.0
|
||
|
|
Wed, 17 Oct 2018 04:47:19 GMT
|
||
|
|
|
||
|
|
### Minor changes
|
||
|
|
|
||
|
|
- (API change) Change `DocBlock` to have a `DocSection` property rather than inheriting from `DocSection`; this eliminates confusion about which nodes belong to the container
|
||
|
|
- (API change) Rename `DocParticle` to `DocExcerpt`, and eliminate the `Excerpt` class
|
||
|
|
- (API change) Eliminate `DocNodeLeaf`, since now `DocExcerpt` is the only class that can represent excerpts
|
||
|
|
- (API change) Remove `DocNode.updateParameters()` because it is no longer needed
|
||
|
|
- (API change) Spacing is now represented as a normal `DocExcerpt`, rather than via a special `Excerpt.spacingAfterContent`
|
||
|
|
- (API change) Simplify `DocNodeTransforms.trimSpacesInParagraph()` to no longer merge/remap excerpts during the transformation. If we need this information, we will track it differently.
|
||
|
|
|
||
|
|
## 0.8.1
|
||
|
|
Sun, 07 Oct 2018 06:30:34 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Improve error reporting for declaration references that are probably missing a `"#"` delimiter
|
||
|
|
- Rename `DocCodeFence` to `DocFencedCode`
|
||
|
|
|
||
|
|
## 0.8.0
|
||
|
|
Wed, 03 Oct 2018 02:43:47 GMT
|
||
|
|
|
||
|
|
### Minor changes
|
||
|
|
|
||
|
|
- Introduce a distinction between "defined" tags (i.e. recognized) versus "supported" tags (i.e. implemented by the tool)
|
||
|
|
- The parser optionally reports usage of undefined tags
|
||
|
|
- The parser optionally reports usage of unsupported tags
|
||
|
|
- The parser reports usage of inline/block syntax that is inconsistent with the tag definition
|
||
|
|
- Code spans are now allowed to be adjacent to other text, but must contain at least one character
|
||
|
|
- An `@deprecated` block must contain a deprecation message
|
||
|
|
- If `@inheritDoc` is used, then the summary section must be empty, and there must not be an `@remarks` block
|
||
|
|
|
||
|
|
## 0.7.0
|
||
|
|
Tue, 02 Oct 2018 02:35:35 GMT
|
||
|
|
|
||
|
|
### Minor changes
|
||
|
|
|
||
|
|
- Add support for `@defaultValue` tag
|
||
|
|
- Add support for `@typeParam` tag
|
||
|
|
|
||
|
|
## 0.6.0
|
||
|
|
Mon, 01 Oct 2018 22:11:24 GMT
|
||
|
|
|
||
|
|
### Minor changes
|
||
|
|
|
||
|
|
- Add support for `@link` tags using the new declaration reference syntax
|
||
|
|
- Add support for `@inheritDoc` tags
|
||
|
|
- Add new APIs: `DocDeclarationReference`, `DocInheritDocTag`, `DocLinkTag`, `DocMemberIdentifier`, `DocMemberReference`, `DocMemberSelector`, `DocMemberSymbol`
|
||
|
|
- Remove `ParserContext.verbatimNodes`
|
||
|
|
- Add `DocParticle.particleId` property
|
||
|
|
|
||
|
|
## 0.5.0
|
||
|
|
Tue, 25 Sep 2018 03:04:06 GMT
|
||
|
|
|
||
|
|
### Minor changes
|
||
|
|
|
||
|
|
- 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
|
||
|
|
- Add `DocNodeTransforms.trimSpacesInParagraphNodes()` for collapsing whitespace inside `DocParagraph` subtrees
|
||
|
|
- Extract the `DocNode.excerpt` property into a new abstract base class `DocNodeLeaf`
|
||
|
|
|
||
|
|
## 0.4.1
|
||
|
|
Fri, 31 Aug 2018 03:32:18 GMT
|
||
|
|
|
||
|
|
### Patches
|
||
|
|
|
||
|
|
- Improve the error location reporting for DocErrorText objects
|
||
|
|
- 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
|
||
|
|
|
||
|
|
## 0.4.0
|
||
|
|
Tue, 28 Aug 2018 03:17:20 GMT
|
||
|
|
|
||
|
|
### Minor changes
|
||
|
|
|
||
|
|
- Rename `DocCodeSpan.text` to `DocCodeSpan.code` and model the delimiters using particles
|
||
|
|
- Add support for code fences (`DocCodeFence`)
|
||
|
|
- `DocSection` content is now grouped into `DocParagraph` nodes; blank lines are used to indicate paragraph boundaries
|
||
|
|
- Rename `DocComment.deprecated` to `deprecatedBlock`
|
||
|
|
|
||
|
|
## 0.3.0
|
||
|
|
Sat, 25 Aug 2018 05:53:56 GMT
|
||
|
|
|
||
|
|
### Minor changes
|
||
|
|
|
||
|
|
- Add TextRange.isEmpty()
|
||
|
|
- Improve the ModifierTagSet API
|
||
|
|
- Implement the @privateRemarks and @deprecated tags
|
||
|
|
|
||
|
|
## 0.2.0
|
||
|
|
Fri, 24 Aug 2018 01:19:56 GMT
|
||
|
|
|
||
|
|
### Minor changes
|
||
|
|
|
||
|
|
- Rename `CoreTags` to `StandardTags` so we can include non-core tags in the standard definitions
|
||
|
|
- Rename `CoreModifierTagSet` to `StandardModifierTagSet` and convert properties to functions
|
||
|
|
- Categorize the standard tags according to a `Standardization` enum, and document them
|
||
|
|
- Add more standard tag definitions: `@deprecated`, `@eventProperty`, `@example`, `@inheritDoc`, `@link`, `@override`, `@packageDocumentation`, `@public`, `@privateRemarks`, `@sealed`, `@virtual`
|
||
|
|
- Replace TSDocTagDefinition.singleton with TSDocTagDefinition.allowMultiple, since in practice most tags are single-usage
|
||
|
|
|
||
|
|
## 0.1.0
|
||
|
|
Thu, 16 Aug 2018 18:18:02 GMT
|
||
|
|
|
||
|
|
### Minor changes
|
||
|
|
|
||
|
|
- Initial release of the TSDoc library! :-)
|
||
|
|
|