Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@microsoft/tsdoc
Advanced tools
@microsoft/tsdoc - npm Package Compare versions
Comparing version 0.12.22 to 0.12.23
@@ -5,2 +5,14 @@ { | ||
| { | ||
| "version": "0.12.23", | ||
| "tag": "@microsoft/tsdoc_v0.12.23", | ||
| "date": "Thu, 03 Dec 2020 04:31:52 GMT", | ||
| "comments": { | ||
| "patch": [ | ||
| { | ||
| "comment": "Add a definition for the `@decorator` block tag (RFC 271)" | ||
| } | ||
| ] | ||
| } | ||
| }, | ||
| { | ||
| "version": "0.12.22", | ||
@@ -7,0 +19,0 @@ "tag": "@microsoft/tsdoc_v0.12.22", |
| # Change Log - @microsoft/tsdoc | ||
| This log was last generated on Mon, 30 Nov 2020 06:16:21 GMT and should not be manually modified. | ||
| This log was last generated on Thu, 03 Dec 2020 04:31:52 GMT and should not be manually modified. | ||
| ## 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 | ||
@@ -6,0 +13,0 @@ Mon, 30 Nov 2020 06:16:21 GMT |
@@ -47,13 +47,29 @@ "use strict"; | ||
| /** | ||
| * (Core) | ||
| * (Extended) | ||
| * | ||
| * This block tag communicates that an API item is no longer supported and may be removed | ||
| * in a future release. The `@deprecated` tag is followed by a sentence describing | ||
| * the recommended alternative. It recursively applies to members of the container. | ||
| * For example, if a class is deprecated, then so are all of its members. | ||
| * ECMAScript decorators are sometimes an important part of an API contract. | ||
| * However, today the TypeScript compiler does not represent decorators in the | ||
| * .d.ts output files used by API consumers. The `@decorator` tag provides a workaround, | ||
| * enabling a decorator expressions to be quoted in a doc comment. | ||
| * | ||
| * @example | ||
| * ```ts | ||
| * class Book { | ||
| * /** | ||
| * * The title of the book. | ||
| * * @decorator `@jsonSerialized` | ||
| * * @decorator `@jsonFormat(JsonFormats.Url)` | ||
| * * | ||
| *+/ | ||
| * @jsonSerialized | ||
| * @jsonFormat(JsonFormats.Url) | ||
| * public website: string; | ||
| * } | ||
| * ``` | ||
| */ | ||
| StandardTags.deprecated = StandardTags._defineTag({ | ||
| tagName: '@deprecated', | ||
| StandardTags.decorator = StandardTags._defineTag({ | ||
| tagName: '@decorator', | ||
| syntaxKind: TSDocTagDefinition_1.TSDocTagSyntaxKind.BlockTag, | ||
| standardization: "Core" /* Core */ | ||
| allowMultiple: true, | ||
| standardization: "Extended" /* Extended */ | ||
| }); | ||
@@ -75,2 +91,15 @@ /** | ||
| /** | ||
| * (Core) | ||
| * | ||
| * This block tag communicates that an API item is no longer supported and may be removed | ||
| * in a future release. The `@deprecated` tag is followed by a sentence describing | ||
| * the recommended alternative. It recursively applies to members of the container. | ||
| * For example, if a class is deprecated, then so are all of its members. | ||
| */ | ||
| StandardTags.deprecated = StandardTags._defineTag({ | ||
| tagName: '@deprecated', | ||
| syntaxKind: TSDocTagDefinition_1.TSDocTagSyntaxKind.BlockTag, | ||
| standardization: "Core" /* Core */ | ||
| }); | ||
| /** | ||
| * (Extended) | ||
@@ -431,4 +460,5 @@ * | ||
| StandardTags.beta, | ||
| StandardTags.defaultValue, | ||
| StandardTags.decorator, | ||
| StandardTags.deprecated, | ||
| StandardTags.defaultValue, | ||
| StandardTags.eventProperty, | ||
@@ -435,0 +465,0 @@ StandardTags.example, |
@@ -31,10 +31,25 @@ import { TSDocTagDefinition } from '../configuration/TSDocTagDefinition'; | ||
| /** | ||
| * (Core) | ||
| * (Extended) | ||
| * | ||
| * This block tag communicates that an API item is no longer supported and may be removed | ||
| * in a future release. The `@deprecated` tag is followed by a sentence describing | ||
| * the recommended alternative. It recursively applies to members of the container. | ||
| * For example, if a class is deprecated, then so are all of its members. | ||
| * ECMAScript decorators are sometimes an important part of an API contract. | ||
| * However, today the TypeScript compiler does not represent decorators in the | ||
| * .d.ts output files used by API consumers. The `@decorator` tag provides a workaround, | ||
| * enabling a decorator expressions to be quoted in a doc comment. | ||
| * | ||
| * @example | ||
| * ```ts | ||
| * class Book { | ||
| * /** | ||
| * * The title of the book. | ||
| * * @decorator `@jsonSerialized` | ||
| * * @decorator `@jsonFormat(JsonFormats.Url)` | ||
| * * | ||
| *+/ | ||
| * @jsonSerialized | ||
| * @jsonFormat(JsonFormats.Url) | ||
| * public website: string; | ||
| * } | ||
| * ``` | ||
| */ | ||
| static readonly deprecated: TSDocTagDefinition; | ||
| static readonly decorator: TSDocTagDefinition; | ||
| /** | ||
@@ -51,2 +66,11 @@ * (Extended) | ||
| /** | ||
| * (Core) | ||
| * | ||
| * This block tag communicates that an API item is no longer supported and may be removed | ||
| * in a future release. The `@deprecated` tag is followed by a sentence describing | ||
| * the recommended alternative. It recursively applies to members of the container. | ||
| * For example, if a class is deprecated, then so are all of its members. | ||
| */ | ||
| static readonly deprecated: TSDocTagDefinition; | ||
| /** | ||
| * (Extended) | ||
@@ -53,0 +77,0 @@ * |
@@ -44,13 +44,29 @@ import { TSDocTagDefinition, TSDocTagSyntaxKind } from '../configuration/TSDocTagDefinition'; | ||
| /** | ||
| * (Core) | ||
| * (Extended) | ||
| * | ||
| * This block tag communicates that an API item is no longer supported and may be removed | ||
| * in a future release. The `@deprecated` tag is followed by a sentence describing | ||
| * the recommended alternative. It recursively applies to members of the container. | ||
| * For example, if a class is deprecated, then so are all of its members. | ||
| * ECMAScript decorators are sometimes an important part of an API contract. | ||
| * However, today the TypeScript compiler does not represent decorators in the | ||
| * .d.ts output files used by API consumers. The `@decorator` tag provides a workaround, | ||
| * enabling a decorator expressions to be quoted in a doc comment. | ||
| * | ||
| * @example | ||
| * ```ts | ||
| * class Book { | ||
| * /** | ||
| * * The title of the book. | ||
| * * @decorator `@jsonSerialized` | ||
| * * @decorator `@jsonFormat(JsonFormats.Url)` | ||
| * * | ||
| *+/ | ||
| * @jsonSerialized | ||
| * @jsonFormat(JsonFormats.Url) | ||
| * public website: string; | ||
| * } | ||
| * ``` | ||
| */ | ||
| StandardTags.deprecated = StandardTags._defineTag({ | ||
| tagName: '@deprecated', | ||
| StandardTags.decorator = StandardTags._defineTag({ | ||
| tagName: '@decorator', | ||
| syntaxKind: TSDocTagSyntaxKind.BlockTag, | ||
| standardization: "Core" /* Core */ | ||
| allowMultiple: true, | ||
| standardization: "Extended" /* Extended */ | ||
| }); | ||
@@ -72,2 +88,15 @@ /** | ||
| /** | ||
| * (Core) | ||
| * | ||
| * This block tag communicates that an API item is no longer supported and may be removed | ||
| * in a future release. The `@deprecated` tag is followed by a sentence describing | ||
| * the recommended alternative. It recursively applies to members of the container. | ||
| * For example, if a class is deprecated, then so are all of its members. | ||
| */ | ||
| StandardTags.deprecated = StandardTags._defineTag({ | ||
| tagName: '@deprecated', | ||
| syntaxKind: TSDocTagSyntaxKind.BlockTag, | ||
| standardization: "Core" /* Core */ | ||
| }); | ||
| /** | ||
| * (Extended) | ||
@@ -428,4 +457,5 @@ * | ||
| StandardTags.beta, | ||
| StandardTags.defaultValue, | ||
| StandardTags.decorator, | ||
| StandardTags.deprecated, | ||
| StandardTags.defaultValue, | ||
| StandardTags.eventProperty, | ||
@@ -432,0 +462,0 @@ StandardTags.example, |
| { | ||
| "name": "@microsoft/tsdoc", | ||
| "version": "0.12.22", | ||
| "version": "0.12.23", | ||
| "description": "A parser for the TypeScript doc comment syntax", | ||
@@ -5,0 +5,0 @@ "keywords": [ |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.22%
2512456
- Lines of code
- increased by0.41%
23460
No dependency changes