Skip to content

Commit 5a280f5

Browse files
octogonzoctogonz
committed
Update to use revised TSDoc API
1 parent d772f41 commit 5a280f5

File tree

9 files changed

+27
-27
lines changed

9 files changed

+27
-27
lines changed

‎apps/api-extractor-model/src/model/ApiCallSignature.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ export class ApiCallSignature extends ApiTypeParameterListMixin(ApiParameterList
7878
// .withMeaning() requires some kind of component
7979
: DeclarationReference.empty().addNavigationStep(Navigation.Members, '(parent)');
8080
return parent
81-
.withMeaning(Meaning.Signature)
81+
.withMeaning(Meaning.CallSignature)
8282
.withOverloadIndex(this.overloadIndex);
8383
}
8484
}

‎apps/api-extractor-model/src/model/ApiConstructSignature.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ export class ApiConstructSignature extends ApiTypeParameterListMixin(ApiParamete
9191
// .withMeaning() requires some kind of component
9292
: DeclarationReference.empty().addNavigationStep(Navigation.Members, '(parent)');
9393
return parent
94-
.withMeaning(Meaning.Signature)
94+
.withMeaning(Meaning.ConstructSignature)
9595
.withOverloadIndex(this.overloadIndex);
9696
}
9797
}

‎apps/api-extractor-model/src/model/ApiEnumMember.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,6 @@ export class ApiEnumMember extends ApiNameMixin(ApiReleaseTagMixin(ApiDeclaredIt
9292
public buildCanonicalReference(): DeclarationReference {
9393
return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty())
9494
.addNavigationStep(Navigation.Exports, this._getCanonicalReferenceName())
95-
.withMeaning(Meaning.EnumMember);
95+
.withMeaning(Meaning.Member);
9696
}
9797
}

‎apps/api-extractor-model/src/model/ApiIndexSignature.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ export class ApiIndexSignature extends ApiParameterListMixin(ApiReleaseTagMixin(
6868
// .withMeaning() requires some kind of component
6969
: DeclarationReference.empty().addNavigationStep(Navigation.Members, '(parent)');
7070
return parent
71-
.withMeaning(Meaning.Signature)
71+
.withMeaning(Meaning.IndexSignature)
7272
.withOverloadIndex(this.overloadIndex);
7373
}
7474
}

‎build-tests/api-documenter-test/etc/api-documenter-test.api.json‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"members": [
1818
{
1919
"kind": "Variable",
20-
"canonicalReference": "api-documenter-test!constVariable:variable",
20+
"canonicalReference": "api-documenter-test!constVariable:var",
2121
"docComment": "/**\n * An exported variable declaration.\n *\n * @public\n */\n",
2222
"excerptTokens": [
2323
{
@@ -612,7 +612,7 @@
612612
"members": [
613613
{
614614
"kind": "EnumMember",
615-
"canonicalReference": "api-documenter-test!DocEnum.One:enummember",
615+
"canonicalReference": "api-documenter-test!DocEnum.One:member",
616616
"docComment": "/**\n * These are some docs for One\n */\n",
617617
"excerptTokens": [
618618
{
@@ -637,7 +637,7 @@
637637
},
638638
{
639639
"kind": "EnumMember",
640-
"canonicalReference": "api-documenter-test!DocEnum.Two:enummember",
640+
"canonicalReference": "api-documenter-test!DocEnum.Two:member",
641641
"docComment": "/**\n * These are some docs for Two\n */\n",
642642
"excerptTokens": [
643643
{
@@ -662,7 +662,7 @@
662662
},
663663
{
664664
"kind": "EnumMember",
665-
"canonicalReference": "api-documenter-test!DocEnum.Zero:enummember",
665+
"canonicalReference": "api-documenter-test!DocEnum.Zero:member",
666666
"docComment": "/**\n * These are some docs for Zero\n */\n",
667667
"excerptTokens": [
668668
{
@@ -689,7 +689,7 @@
689689
},
690690
{
691691
"kind": "TypeAlias",
692-
"canonicalReference": "api-documenter-test!ExampleTypeAlias:typealias",
692+
"canonicalReference": "api-documenter-test!ExampleTypeAlias:type",
693693
"docComment": "/**\n * A type alias\n *\n * @public\n */\n",
694694
"excerptTokens": [
695695
{
@@ -971,7 +971,7 @@
971971
"members": [
972972
{
973973
"kind": "CallSignature",
974-
"canonicalReference": "api-documenter-test!IDocInterface3:signature(1)",
974+
"canonicalReference": "api-documenter-test!IDocInterface3:call(1)",
975975
"docComment": "/**\n * Call signature\n *\n * @param x - the parameter\n */\n",
976976
"excerptTokens": [
977977
{
@@ -1021,7 +1021,7 @@
10211021
},
10221022
{
10231023
"kind": "ConstructSignature",
1024-
"canonicalReference": "api-documenter-test!IDocInterface3:signature(1)",
1024+
"canonicalReference": "api-documenter-test!IDocInterface3:new(1)",
10251025
"docComment": "/**\n * Construct signature\n */\n",
10261026
"excerptTokens": [
10271027
{
@@ -1047,7 +1047,7 @@
10471047
},
10481048
{
10491049
"kind": "IndexSignature",
1050-
"canonicalReference": "api-documenter-test!IDocInterface3:signature(1)",
1050+
"canonicalReference": "api-documenter-test!IDocInterface3:index(1)",
10511051
"docComment": "/**\n * Indexer\n *\n * @param x - the parameter\n */\n",
10521052
"excerptTokens": [
10531053
{
@@ -1469,7 +1469,7 @@
14691469
},
14701470
{
14711471
"kind": "Variable",
1472-
"canonicalReference": "api-documenter-test!OuterNamespace.nestedVariable:variable",
1472+
"canonicalReference": "api-documenter-test!OuterNamespace.nestedVariable:var",
14731473
"docComment": "/**\n * A variable exported from within a namespace.\n */\n",
14741474
"excerptTokens": [
14751475
{

‎build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@
250250
"members": [
251251
{
252252
"kind": "EnumMember",
253-
"canonicalReference": "api-extractor-scenarios!ConstEnum.One:enummember",
253+
"canonicalReference": "api-extractor-scenarios!ConstEnum.One:member",
254254
"docComment": "",
255255
"excerptTokens": [
256256
{
@@ -275,7 +275,7 @@
275275
},
276276
{
277277
"kind": "EnumMember",
278-
"canonicalReference": "api-extractor-scenarios!ConstEnum.Two:enummember",
278+
"canonicalReference": "api-extractor-scenarios!ConstEnum.Two:member",
279279
"docComment": "",
280280
"excerptTokens": [
281281
{
@@ -300,7 +300,7 @@
300300
},
301301
{
302302
"kind": "EnumMember",
303-
"canonicalReference": "api-extractor-scenarios!ConstEnum.Zero:enummember",
303+
"canonicalReference": "api-extractor-scenarios!ConstEnum.Zero:member",
304304
"docComment": "",
305305
"excerptTokens": [
306306
{
@@ -401,7 +401,7 @@
401401
"members": [
402402
{
403403
"kind": "Variable",
404-
"canonicalReference": "api-extractor-scenarios!NamespaceContainingVariable.constVariable:variable",
404+
"canonicalReference": "api-extractor-scenarios!NamespaceContainingVariable.constVariable:var",
405405
"docComment": "",
406406
"excerptTokens": [
407407
{
@@ -426,7 +426,7 @@
426426
},
427427
{
428428
"kind": "Variable",
429-
"canonicalReference": "api-extractor-scenarios!NamespaceContainingVariable.variable:variable",
429+
"canonicalReference": "api-extractor-scenarios!NamespaceContainingVariable.variable:var",
430430
"docComment": "",
431431
"excerptTokens": [
432432
{
@@ -474,7 +474,7 @@
474474
"members": [
475475
{
476476
"kind": "EnumMember",
477-
"canonicalReference": "api-extractor-scenarios!RegularEnum.One:enummember",
477+
"canonicalReference": "api-extractor-scenarios!RegularEnum.One:member",
478478
"docComment": "/**\n * These are some docs for One\n */\n",
479479
"excerptTokens": [
480480
{
@@ -499,7 +499,7 @@
499499
},
500500
{
501501
"kind": "EnumMember",
502-
"canonicalReference": "api-extractor-scenarios!RegularEnum.Two:enummember",
502+
"canonicalReference": "api-extractor-scenarios!RegularEnum.Two:member",
503503
"docComment": "/**\n * These are some docs for Two\n */\n",
504504
"excerptTokens": [
505505
{
@@ -524,7 +524,7 @@
524524
},
525525
{
526526
"kind": "EnumMember",
527-
"canonicalReference": "api-extractor-scenarios!RegularEnum.Zero:enummember",
527+
"canonicalReference": "api-extractor-scenarios!RegularEnum.Zero:member",
528528
"docComment": "/**\n * These are some docs for Zero\n */\n",
529529
"excerptTokens": [
530530
{
@@ -607,7 +607,7 @@
607607
},
608608
{
609609
"kind": "Variable",
610-
"canonicalReference": "api-extractor-scenarios!VARIABLE:variable",
610+
"canonicalReference": "api-extractor-scenarios!VARIABLE:var",
611611
"docComment": "/**\n * @public\n */\n",
612612
"excerptTokens": [
613613
{

‎build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"members": [
1818
{
1919
"kind": "Variable",
20-
"canonicalReference": "api-extractor-scenarios!defaultFunctionStatement:variable",
20+
"canonicalReference": "api-extractor-scenarios!defaultFunctionStatement:var",
2121
"docComment": "/**\n * @public\n */\n",
2222
"excerptTokens": [
2323
{

‎build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"members": [
1818
{
1919
"kind": "Variable",
20-
"canonicalReference": "api-extractor-scenarios!_default:variable",
20+
"canonicalReference": "api-extractor-scenarios!_default:var",
2121
"docComment": "",
2222
"excerptTokens": [
2323
{

‎build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,7 @@
342342
},
343343
{
344344
"kind": "TypeAlias",
345-
"canonicalReference": "api-extractor-scenarios!GenericTypeAlias:typealias",
345+
"canonicalReference": "api-extractor-scenarios!GenericTypeAlias:type",
346346
"docComment": "/**\n * @public\n */\n",
347347
"excerptTokens": [
348348
{
@@ -417,7 +417,7 @@
417417
"members": [
418418
{
419419
"kind": "CallSignature",
420-
"canonicalReference": "api-extractor-scenarios!InterfaceWithGenericCallSignature:signature(1)",
420+
"canonicalReference": "api-extractor-scenarios!InterfaceWithGenericCallSignature:call(1)",
421421
"docComment": "",
422422
"excerptTokens": [
423423
{
@@ -488,7 +488,7 @@
488488
"members": [
489489
{
490490
"kind": "ConstructSignature",
491-
"canonicalReference": "api-extractor-scenarios!InterfaceWithGenericConstructSignature:signature(1)",
491+
"canonicalReference": "api-extractor-scenarios!InterfaceWithGenericConstructSignature:new(1)",
492492
"docComment": "",
493493
"excerptTokens": [
494494
{

0 commit comments

Comments
 (0)