Skip to content

Commit a867b4e

Browse files
pgonzalpgonzal
authored
Merge pull request microsoft#930 from Microsoft/pgonzal/tsdoc-0.12.0
[api-extractor] Upgrade to @microsoft/tsdoc 0.12.0
2 parents 9718ce9 + c54dca5 commit a867b4e

5 files changed

Lines changed: 25 additions & 10 deletions

File tree

‎apps/api-extractor/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
"dependencies": {
3434
"@microsoft/node-core-library": "3.5.0",
3535
"@microsoft/ts-command-line": "4.2.2",
36-
"@microsoft/tsdoc": "0.9.3",
36+
"@microsoft/tsdoc": "0.12.0",
3737
"@types/node": "8.5.8",
3838
"@types/z-schema": "3.16.31",
3939
"colors": "~1.2.1",

‎apps/api-extractor/src/aedoc/AedocDefinitions.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// See LICENSE in the project root for license information.
33

44
import {
5-
TSDocParserConfiguration,
5+
TSDocConfiguration,
66
TSDocTagDefinition,
77
TSDocTagSyntaxKind,
88
StandardTags
@@ -24,9 +24,9 @@ export class AedocDefinitions {
2424
syntaxKind: TSDocTagSyntaxKind.ModifierTag
2525
});
2626

27-
public static get parserConfiguration(): TSDocParserConfiguration {
27+
public static get parserConfiguration(): TSDocConfiguration {
2828
if (!AedocDefinitions._parserConfiguration) {
29-
const configuration: TSDocParserConfiguration = new TSDocParserConfiguration();
29+
const configuration: TSDocConfiguration = new TSDocConfiguration();
3030
configuration.addTagDefinitions([
3131
AedocDefinitions.betaDocumentation,
3232
AedocDefinitions.internalRemarks,
@@ -63,5 +63,5 @@ export class AedocDefinitions {
6363
return AedocDefinitions._parserConfiguration;
6464
}
6565

66-
private static _parserConfiguration: TSDocParserConfiguration | undefined;
66+
private static _parserConfiguration: TSDocConfiguration | undefined;
6767
}

‎apps/api-extractor/src/aedoc/ApiDocumentation.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,7 @@ export class ApiDocumentation {
344344
'a return value description', false);
345345
}
346346

347-
for (const paramBlock of this._docComment.paramBlocks) {
347+
for (const paramBlock of this._docComment.params.blocks) {
348348
const aedocParameter: IAedocParameter = {
349349
name: paramBlock.parameterName,
350350
description: []

‎common/changes/@microsoft/api-extractor/pgonzal-tsdoc-0.12.0_2018-11-03-02-16.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"changes": [
3+
{
4+
"packageName": "@microsoft/api-extractor",
5+
"comment": "Upgrade to @microsoft/tsdoc 0.12.0",
6+
"type": "patch"
7+
}
8+
],
9+
"packageName": "@microsoft/api-extractor",
10+
"email": "pgonzal@users.noreply.github.com"
11+
}

‎common/config/rush/shrinkwrap.yaml‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
dependencies:
22
'@microsoft/api-extractor': 6.0.9
33
'@microsoft/node-library-build': 6.0.6
4-
'@microsoft/tsdoc': 0.9.3
4+
'@microsoft/tsdoc': 0.12.0
55
'@pnpm/link-bins': 1.0.3
66
'@pnpm/logger': 1.0.2
77
'@rush-temp/api-documenter': 'file:projects/api-documenter.tgz'
@@ -334,6 +334,10 @@ packages:
334334
dev: false
335335
resolution:
336336
integrity: sha512-CLLVG+zWmUvD6jZD5oq7QCFYj3WOvrBSc3H6KejXCH6q2ntP5/ZHlmKVzQVvN1cEOSWP+jN9ml2AvUcDY/l6Tw==
337+
/@microsoft/tsdoc/0.12.0:
338+
dev: false
339+
resolution:
340+
integrity: sha512-c1mABULA2biVJ+AdoWD6k975wMnMeet25hC1VCTill6qyguermhSwmGClhCjzoxJJLvMk0zUzK9FVUNtRuNpfA==
337341
/@microsoft/tsdoc/0.9.3:
338342
dev: false
339343
resolution:
@@ -9760,7 +9764,7 @@ packages:
97609764
dependencies:
97619765
'@microsoft/node-library-build': 6.0.6
97629766
'@microsoft/rush-stack-compiler': 0.4.3
9763-
'@microsoft/tsdoc': 0.9.3
9767+
'@microsoft/tsdoc': 0.12.0
97649768
'@types/jest': 21.1.10
97659769
'@types/lodash': 4.14.116
97669770
'@types/node': 8.5.8
@@ -9775,7 +9779,7 @@ packages:
97759779
dev: false
97769780
name: '@rush-temp/api-extractor'
97779781
resolution:
9778-
integrity: sha512-ilKBn1Ma2o5fakuhcG5zvZSUBz3djLQ211HVp9HzQqUbub/v36xd6fde2623mdpug8MsAf6bpWMUfMzTPX+42g==
9782+
integrity: sha512-7tcrURYE+2jNqeqFn7phqraKEHhXKnBrwMFWwpDUBZ8igNiKOUOnqytIAh6Ir4CoFJpar9u2yqwooQYoUgZTYA==
97799783
tarball: 'file:projects/api-extractor.tgz'
97809784
version: 0.0.0
97819785
'file:projects/gulp-core-build-karma.tgz':
@@ -10280,7 +10284,7 @@ shrinkwrapVersion: 3
1028010284
specifiers:
1028110285
'@microsoft/api-extractor': 6.0.9
1028210286
'@microsoft/node-library-build': 6.0.6
10283-
'@microsoft/tsdoc': 0.9.3
10287+
'@microsoft/tsdoc': 0.12.0
1028410288
'@pnpm/link-bins': ~1.0.1
1028510289
'@pnpm/logger': ~1.0.1
1028610290
'@rush-temp/api-documenter': 'file:./projects/api-documenter.tgz'

0 commit comments

Comments
 (0)