Skip to content

Commit 9f41072

Browse files
octogonzoctogonz
authored
Merge pull request microsoft#1205 from Microsoft/octogonz/bump-cyclics
Bump cyclic dependencies
2 parents 6128f21 + 4d71489 commit 9f41072

49 files changed

Lines changed: 335 additions & 358 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎apps/api-extractor-model/package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222
"@types/node": "8.5.8"
2323
},
2424
"devDependencies": {
25-
"@microsoft/node-library-build": "6.0.44",
26-
"@microsoft/rush-stack-compiler-3.2": "0.2.17",
25+
"@microsoft/node-library-build": "6.0.49",
26+
"@microsoft/rush-stack-compiler-3.2": "0.3.1",
2727
"@types/jest": "23.3.11",
2828
"gulp": "~3.9.1",
2929
"tslint-microsoft-contrib": "~5.2.1"

‎apps/api-extractor-model/src/items/ApiDeclaredItem.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { ApiDocumentedItem, IApiDocumentedItemJson, IApiDocumentedItemOptions }
55
import { Excerpt, ExcerptToken, IExcerptTokenRange, IExcerptToken } from '../mixins/Excerpt';
66

77
/**
8-
* Constructor options for {@link (ApiDeclaredItem:interface)}.
8+
* Constructor options for {@link ApiDeclaredItem}.
99
* @public
1010
*/
1111
export interface IApiDeclaredItemOptions extends IApiDocumentedItemOptions {

‎apps/api-extractor-model/src/mixins/ApiItemContainerMixin.ts‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ const _membersByName: unique symbol = Symbol('ApiItemContainerMixin._membersByNa
3636
*
3737
* Examples of `ApiItemContainerMixin` child classes include `ApiModel`, `ApiPackage`, `ApiEntryPoint`,
3838
* and `ApiEnum`. But note that `Parameter` is not considered a "member" of an `ApiMethod`; this relationship
39-
* is modeled using {@link ApiParameterListMixin.parameters} instead of {@link ApiItemContainerMixin.members}.
39+
* is modeled using {@link (ApiParameterListMixin:interface).parameters} instead
40+
* of {@link (ApiItemContainerMixin:interface).members}.
4041
*
4142
* @public
4243
*/
@@ -70,7 +71,7 @@ export interface ApiItemContainerMixin extends ApiItem {
7071
}
7172

7273
/**
73-
* Mixin function for {@link (ApiDeclaredItem:interface)}.
74+
* Mixin function for {@link ApiDeclaredItem}.
7475
*
7576
* @param baseClass - The base class to be extended
7677
* @returns A child class that extends baseClass, adding the {@link (ApiItemContainerMixin:interface)} functionality.

‎apps/api-extractor-model/src/mixins/Excerpt.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export class ExcerptToken {
4747
}
4848

4949
/**
50-
* This class is used by {@link (ApiDeclaredItem:interface)} to represent a source code excerpt containing
50+
* This class is used by {@link ApiDeclaredItem} to represent a source code excerpt containing
5151
* a TypeScript declaration.
5252
*
5353
* @remarks

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ import { DocDeclarationReference } from '@microsoft/tsdoc';
1717
* important information needed to generate documentation, without any reliance on the TypeScript compiler engine.
1818
*
1919
* An `ApiModel` acts as the root of a tree of objects that all inherit from the `ApiItem` base class.
20-
* The tree children are determined by the {@link ApiItemContainerMixin} mixin base class. The model contains
21-
* packages. Packages have an entry point (today, only one). And the entry point can contain various types
20+
* The tree children are determined by the {@link (ApiItemContainerMixin:interface)} mixin base class. The model
21+
* contains packages. Packages have an entry point (today, only one). And the entry point can contain various types
2222
* of API declarations. The container relationships might look like this:
2323
*
2424
* ```

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,13 @@ export interface IApiPackageSaveOptions extends IJsonFileSaveOptions {
6868
*/
6969
toolVersion?: string;
7070

71-
/** {@inheritDoc IExtractorConfig.testMode} */
71+
/**
72+
* Set to true only when invoking API Extractor's test harness.
73+
*
74+
* @remarks
75+
* When `testMode` is true, the `toolVersion` field in the .api.json file is assigned an empty string
76+
* to prevent spurious diffs in output files tracked for tests.
77+
*/
7278
testMode?: boolean;
7379
}
7480

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export interface IParameterOptions {
3030
* }
3131
* ```
3232
*
33-
* `Parameter` objects belong to the {@link ApiParameterListMixin.parameters} collection.
33+
* `Parameter` objects belong to the {@link (ApiParameterListMixin:interface).parameters} collection.
3434
*
3535
* @public
3636
*/

‎apps/api-extractor/package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@
4646
"typescript": "~3.1.6"
4747
},
4848
"devDependencies": {
49-
"@microsoft/node-library-build": "6.0.44",
50-
"@microsoft/rush-stack-compiler-3.2": "0.2.17",
49+
"@microsoft/node-library-build": "6.0.49",
50+
"@microsoft/rush-stack-compiler-3.2": "0.3.1",
5151
"@types/jest": "23.3.11",
5252
"@types/lodash": "4.14.116",
5353
"@types/node": "8.5.8",

‎apps/api-extractor/src/api/IExtractorConfig.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ export interface IExtractorTsdocMetadataConfig {
268268
}
269269

270270
/**
271-
* Used with {@link IExtractorMessageRoutingConfig.logLevel}.
271+
* Used with {@link IExtractorMessageReportingRuleConfig.logLevel}.
272272
*
273273
* @public
274274
*/

‎common/changes/@microsoft/api-extractor-model/octogonz-bump-cyclics_2019-04-03-03-31.json‎

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

0 commit comments

Comments
 (0)