Skip to content

Commit 4b81853

Browse files
octogonzoctogonz
committed
rush build
1 parent 2832d59 commit 4b81853

24 files changed

Lines changed: 24 additions & 204 deletions

File tree

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

Lines changed: 1 addition & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,19 @@
22
"metadata": {
33
"toolPackage": "@microsoft/api-extractor",
44
"toolVersion": "[test mode]",
5-
"schemaVersion": 1001,
5+
"schemaVersion": 1002,
66
"oldestForwardsCompatibleVersion": 1001
77
},
88
"kind": "Package",
9-
"containerKey": "api-documenter-test",
109
"docComment": "/**\n * api-extractor-test-05\n *\n * This project tests various documentation generation scenarios and doc comment syntaxes.\n *\n * @packageDocumentation\n */\n",
1110
"name": "api-documenter-test",
1211
"members": [
1312
{
1413
"kind": "EntryPoint",
15-
"containerKey": "",
1614
"name": "",
1715
"members": [
1816
{
1917
"kind": "Variable",
20-
"containerKey": "constVariable|Variable",
2118
"docComment": "/**\n * An exported variable declaration.\n *\n * @public\n */\n",
2219
"excerptTokens": [
2320
{
@@ -42,7 +39,6 @@
4239
},
4340
{
4441
"kind": "Class",
45-
"containerKey": "DocBaseClass|Class",
4642
"docComment": "/**\n * Example base class\n *\n * {@docCategory DocBaseClass}\n *\n * @public\n */\n",
4743
"excerptTokens": [
4844
{
@@ -63,7 +59,6 @@
6359
"members": [
6460
{
6561
"kind": "Constructor",
66-
"containerKey": "|Constructor|1",
6762
"docComment": "/**\n * The simple constructor for `DocBaseClass`\n */\n",
6863
"excerptTokens": [
6964
{
@@ -77,7 +72,6 @@
7772
},
7873
{
7974
"kind": "Constructor",
80-
"containerKey": "|Constructor|2",
8175
"docComment": "/**\n * The overloaded constructor for `DocBaseClass`\n */\n",
8276
"excerptTokens": [
8377
{
@@ -118,7 +112,6 @@
118112
},
119113
{
120114
"kind": "Class",
121-
"containerKey": "DocClass1|Class",
122115
"docComment": "/**\n * This is an example class.\n *\n * @remarks\n *\n * These are some remarks.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `DocClass1` class.\n *\n * @defaultValue\n *\n * a default value for this function\n *\n * {@docCategory DocClass1}\n *\n * @public\n */\n",
123116
"excerptTokens": [
124117
{
@@ -167,7 +160,6 @@
167160
"members": [
168161
{
169162
"kind": "Method",
170-
"containerKey": "deprecatedExample|Method|instance|0",
171163
"docComment": "/**\n * @deprecated\n *\n * Use `otherThing()` instead.\n */\n",
172164
"excerptTokens": [
173165
{
@@ -199,7 +191,6 @@
199191
},
200192
{
201193
"kind": "Method",
202-
"containerKey": "exampleFunction|Method|instance|1",
203194
"docComment": "/**\n * This is an overloaded function.\n *\n * @param a - the first string\n *\n * @param b - the second string\n */\n",
204195
"excerptTokens": [
205196
{
@@ -278,7 +269,6 @@
278269
},
279270
{
280271
"kind": "Method",
281-
"containerKey": "exampleFunction|Method|instance|2",
282272
"docComment": "/**\n * This is also an overloaded function.\n *\n * @param x - the number\n */\n",
283273
"excerptTokens": [
284274
{
@@ -334,7 +324,6 @@
334324
},
335325
{
336326
"kind": "Method",
337-
"containerKey": "interestingEdgeCases|Method|instance|0",
338327
"docComment": "/**\n * Example: \"\\{ \\\\\"maxItemsToShow\\\\\": 123 \\}\"\n *\n * The regular expression used to validate the constraints is /^[a-zA-Z0-9\\\\-_]+$/\n */\n",
339328
"excerptTokens": [
340329
{
@@ -366,7 +355,6 @@
366355
},
367356
{
368357
"kind": "Property",
369-
"containerKey": "malformedEvent|Property|instance",
370358
"docComment": "/**\n * This event should have been marked as readonly.\n *\n * @eventProperty\n */\n",
371359
"excerptTokens": [
372360
{
@@ -396,7 +384,6 @@
396384
},
397385
{
398386
"kind": "Property",
399-
"containerKey": "modifiedEvent|Property|instance",
400387
"docComment": "/**\n * This event is fired whenever the object is modified.\n *\n * @eventProperty\n */\n",
401388
"excerptTokens": [
402389
{
@@ -430,7 +417,6 @@
430417
},
431418
{
432419
"kind": "Property",
433-
"containerKey": "regularProperty|Property|instance",
434420
"docComment": "/**\n * This is a regular property that happens to use the SystemEvent type.\n */\n",
435421
"excerptTokens": [
436422
{
@@ -460,7 +446,6 @@
460446
},
461447
{
462448
"kind": "Method",
463-
"containerKey": "sumWithExample|Method|static|0",
464449
"docComment": "/**\n * Returns the sum of two numbers.\n *\n * @remarks\n *\n * This illustrates usage of the `@example` block tag.\n *\n * @param x - the first number to add\n *\n * @param y - the second number to add\n *\n * @returns the sum of the two numbers\n *\n * @example\n *\n * Here's a simple example:\n * ```\n * // Prints \"2\":\n * console.log(DocClass1.sumWithExample(1,1));\n * ```\n *\n * @example\n *\n * Here's an example with negative numbers:\n * ```\n * // Prints \"0\":\n * console.log(DocClass1.sumWithExample(1,-1));\n * ```\n *\n */\n",
465450
"excerptTokens": [
466451
{
@@ -543,7 +528,6 @@
543528
},
544529
{
545530
"kind": "Method",
546-
"containerKey": "tableExample|Method|instance|0",
547531
"docComment": "/**\n * An example with tables:\n *\n * @remarks\n *\n * <table> <tr> <td>John</td> <td>Doe</td> </tr> </table>\n */\n",
548532
"excerptTokens": [
549533
{
@@ -591,7 +575,6 @@
591575
},
592576
{
593577
"kind": "Enum",
594-
"containerKey": "DocEnum|Enum",
595578
"docComment": "/**\n * Docs for DocEnum\n *\n * {@docCategory SystemEvent}\n *\n * @public\n */\n",
596579
"excerptTokens": [
597580
{
@@ -612,7 +595,6 @@
612595
"members": [
613596
{
614597
"kind": "EnumMember",
615-
"containerKey": "One",
616598
"docComment": "/**\n * These are some docs for One\n */\n",
617599
"excerptTokens": [
618600
{
@@ -637,7 +619,6 @@
637619
},
638620
{
639621
"kind": "EnumMember",
640-
"containerKey": "Two",
641622
"docComment": "/**\n * These are some docs for Two\n */\n",
642623
"excerptTokens": [
643624
{
@@ -662,7 +643,6 @@
662643
},
663644
{
664645
"kind": "EnumMember",
665-
"containerKey": "Zero",
666646
"docComment": "/**\n * These are some docs for Zero\n */\n",
667647
"excerptTokens": [
668648
{
@@ -689,7 +669,6 @@
689669
},
690670
{
691671
"kind": "TypeAlias",
692-
"containerKey": "ExampleTypeAlias|TypeAlias",
693672
"docComment": "/**\n * A type alias\n *\n * @public\n */\n",
694673
"excerptTokens": [
695674
{
@@ -726,7 +705,6 @@
726705
},
727706
{
728707
"kind": "Class",
729-
"containerKey": "Generic|Class",
730708
"docComment": "/**\n * Generic class.\n *\n * @public\n */\n",
731709
"excerptTokens": [
732710
{
@@ -770,7 +748,6 @@
770748
},
771749
{
772750
"kind": "Function",
773-
"containerKey": "globalFunction|Function|0",
774751
"docComment": "/**\n * An exported function\n *\n * @public\n */\n",
775752
"excerptTokens": [
776753
{
@@ -829,7 +806,6 @@
829806
},
830807
{
831808
"kind": "Interface",
832-
"containerKey": "IDocInterface1|Interface",
833809
"docComment": "/**\n * {@docCategory DocBaseClass}\n *\n * @public\n */\n",
834810
"excerptTokens": [
835811
{
@@ -850,7 +826,6 @@
850826
"members": [
851827
{
852828
"kind": "PropertySignature",
853-
"containerKey": "regularProperty|PropertySignature",
854829
"docComment": "/**\n * Does something\n */\n",
855830
"excerptTokens": [
856831
{
@@ -882,7 +857,6 @@
882857
},
883858
{
884859
"kind": "Interface",
885-
"containerKey": "IDocInterface2|Interface",
886860
"docComment": "/**\n * {@docCategory DocBaseClass}\n *\n * @public\n */\n",
887861
"excerptTokens": [
888862
{
@@ -911,7 +885,6 @@
911885
"members": [
912886
{
913887
"kind": "MethodSignature",
914-
"containerKey": "deprecatedExample|MethodSignature|0",
915888
"docComment": "/**\n * @deprecated\n *\n * Use `otherThing()` instead.\n */\n",
916889
"excerptTokens": [
917890
{
@@ -950,7 +923,6 @@
950923
},
951924
{
952925
"kind": "Interface",
953-
"containerKey": "IDocInterface3|Interface",
954926
"docComment": "/**\n * Some less common TypeScript declaration kinds.\n *\n * {@docCategory DocClass1}\n *\n * @public\n */\n",
955927
"excerptTokens": [
956928
{
@@ -971,7 +943,6 @@
971943
"members": [
972944
{
973945
"kind": "CallSignature",
974-
"containerKey": "|CallSignature|0",
975946
"docComment": "/**\n * Call signature\n *\n * @param x - the parameter\n */\n",
976947
"excerptTokens": [
977948
{
@@ -1021,7 +992,6 @@
1021992
},
1022993
{
1023994
"kind": "ConstructSignature",
1024-
"containerKey": "|ConstructSignature|0",
1025995
"docComment": "/**\n * Construct signature\n */\n",
1026996
"excerptTokens": [
1027997
{
@@ -1047,7 +1017,6 @@
10471017
},
10481018
{
10491019
"kind": "IndexSignature",
1050-
"containerKey": "|IndexSignature|0",
10511020
"docComment": "/**\n * Indexer\n *\n * @param x - the parameter\n */\n",
10521021
"excerptTokens": [
10531022
{
@@ -1100,7 +1069,6 @@
11001069
},
11011070
{
11021071
"kind": "Interface",
1103-
"containerKey": "IDocInterface4|Interface",
11041072
"docComment": "/**\n * Type union in an interface.\n *\n * {@docCategory DocClass1}\n *\n * @public\n */\n",
11051073
"excerptTokens": [
11061074
{
@@ -1121,7 +1089,6 @@
11211089
"members": [
11221090
{
11231091
"kind": "PropertySignature",
1124-
"containerKey": "Context|PropertySignature",
11251092
"docComment": "/**\n * Test newline rendering when code blocks are used in tables\n */\n",
11261093
"excerptTokens": [
11271094
{
@@ -1166,7 +1133,6 @@
11661133
},
11671134
{
11681135
"kind": "PropertySignature",
1169-
"containerKey": "generic|PropertySignature",
11701136
"docComment": "/**\n * make sure html entities are escaped in tables.\n */\n",
11711137
"excerptTokens": [
11721138
{
@@ -1199,7 +1165,6 @@
11991165
},
12001166
{
12011167
"kind": "PropertySignature",
1202-
"containerKey": "numberOrFunction|PropertySignature",
12031168
"docComment": "/**\n * a union type with a function\n */\n",
12041169
"excerptTokens": [
12051170
{
@@ -1228,7 +1193,6 @@
12281193
},
12291194
{
12301195
"kind": "PropertySignature",
1231-
"containerKey": "stringOrNumber|PropertySignature",
12321196
"docComment": "/**\n * a union type\n */\n",
12331197
"excerptTokens": [
12341198
{
@@ -1260,7 +1224,6 @@
12601224
},
12611225
{
12621226
"kind": "Interface",
1263-
"containerKey": "IDocInterface5|Interface",
12641227
"docComment": "/**\n * Interface without inline tag to test custom TOC\n *\n * @public\n */\n",
12651228
"excerptTokens": [
12661229
{
@@ -1281,7 +1244,6 @@
12811244
"members": [
12821245
{
12831246
"kind": "PropertySignature",
1284-
"containerKey": "regularProperty|PropertySignature",
12851247
"docComment": "/**\n * Property of type string that does something\n */\n",
12861248
"excerptTokens": [
12871249
{
@@ -1313,7 +1275,6 @@
13131275
},
13141276
{
13151277
"kind": "Interface",
1316-
"containerKey": "IDocInterface6|Interface",
13171278
"docComment": "/**\n * Interface without inline tag to test custom TOC with injection\n *\n * @public\n */\n",
13181279
"excerptTokens": [
13191280
{
@@ -1334,7 +1295,6 @@
13341295
"members": [
13351296
{
13361297
"kind": "PropertySignature",
1337-
"containerKey": "regularProperty|PropertySignature",
13381298
"docComment": "/**\n * Property of type number that does something\n */\n",
13391299
"excerptTokens": [
13401300
{
@@ -1366,7 +1326,6 @@
13661326
},
13671327
{
13681328
"kind": "Namespace",
1369-
"containerKey": "OuterNamespace|Namespace",
13701329
"docComment": "/**\n * A top-level namespace\n *\n * @public\n */\n",
13711330
"excerptTokens": [
13721331
{
@@ -1387,7 +1346,6 @@
13871346
"members": [
13881347
{
13891348
"kind": "Namespace",
1390-
"containerKey": "InnerNamespace|Namespace",
13911349
"docComment": "/**\n * A nested namespace\n */\n",
13921350
"excerptTokens": [
13931351
{
@@ -1408,7 +1366,6 @@
14081366
"members": [
14091367
{
14101368
"kind": "Function",
1411-
"containerKey": "nestedFunction|Function|0",
14121369
"docComment": "/**\n * A function inside a namespace\n */\n",
14131370
"excerptTokens": [
14141371
{
@@ -1469,7 +1426,6 @@
14691426
},
14701427
{
14711428
"kind": "Variable",
1472-
"containerKey": "nestedVariable|Variable",
14731429
"docComment": "/**\n * A variable exported from within a namespace.\n */\n",
14741430
"excerptTokens": [
14751431
{
@@ -1496,7 +1452,6 @@
14961452
},
14971453
{
14981454
"kind": "Class",
1499-
"containerKey": "SystemEvent|Class",
15001455
"docComment": "/**\n * A class used to exposed events.\n *\n * {@docCategory SystemEvent}\n *\n * @public\n */\n",
15011456
"excerptTokens": [
15021457
{
@@ -1517,7 +1472,6 @@
15171472
"members": [
15181473
{
15191474
"kind": "Method",
1520-
"containerKey": "addHandler|Method|instance|0",
15211475
"docComment": "/**\n * Adds an handler for the event.\n */\n",
15221476
"excerptTokens": [
15231477
{

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

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,19 @@
22
"metadata": {
33
"toolPackage": "@microsoft/api-extractor",
44
"toolVersion": "[test mode]",
5-
"schemaVersion": 1001,
5+
"schemaVersion": 1002,
66
"oldestForwardsCompatibleVersion": 1001
77
},
88
"kind": "Package",
9-
"containerKey": "api-extractor-scenarios",
109
"docComment": "",
1110
"name": "api-extractor-scenarios",
1211
"members": [
1312
{
1413
"kind": "EntryPoint",
15-
"containerKey": "",
1614
"name": "",
1715
"members": [
1816
{
1917
"kind": "Function",
20-
"containerKey": "ambientNameConflict|Function|0",
2118
"docComment": "/**\n * @public\n */\n",
2219
"excerptTokens": [
2320
{

0 commit comments

Comments
 (0)