Fix more API Extractor warnings

octogonz · octogonz · commit 92156f2745b7 · 2019-04-02T20:31:25.000-07:00
diff --git a/apps/api-extractor-model/src/items/ApiDeclaredItem.ts b/apps/api-extractor-model/src/items/ApiDeclaredItem.ts
@@ -5,7 +5,7 @@ import { ApiDocumentedItem, IApiDocumentedItemJson, IApiDocumentedItemOptions }
 import { Excerpt, ExcerptToken, IExcerptTokenRange, IExcerptToken } from '../mixins/Excerpt';
 
 /**
- * Constructor options for {@link (ApiDeclaredItem:interface)}.
+ * Constructor options for {@link ApiDeclaredItem}.
  * @public
  */
 export interface IApiDeclaredItemOptions extends IApiDocumentedItemOptions {
diff --git a/apps/api-extractor-model/src/mixins/ApiItemContainerMixin.ts b/apps/api-extractor-model/src/mixins/ApiItemContainerMixin.ts
@@ -36,7 +36,8 @@ const _membersByName: unique symbol = Symbol('ApiItemContainerMixin._membersByNa
  *
  * Examples of `ApiItemContainerMixin` child classes include `ApiModel`, `ApiPackage`, `ApiEntryPoint`,
  * and `ApiEnum`.  But note that `Parameter` is not considered a "member" of an `ApiMethod`; this relationship
- * is modeled using {@link ApiParameterListMixin.parameters} instead of {@link ApiItemContainerMixin.members}.
+ * is modeled using {@link (ApiParameterListMixin:interface).parameters} instead
+ * of {@link (ApiItemContainerMixin:interface).members}.
  *
  * @public
  */
@@ -70,7 +71,7 @@ export interface ApiItemContainerMixin extends ApiItem {
 }
 
 /**
- * Mixin function for {@link (ApiDeclaredItem:interface)}.
+ * Mixin function for {@link ApiDeclaredItem}.
  *
  * @param baseClass - The base class to be extended
  * @returns A child class that extends baseClass, adding the {@link (ApiItemContainerMixin:interface)} functionality.
diff --git a/apps/api-extractor-model/src/mixins/Excerpt.ts b/apps/api-extractor-model/src/mixins/Excerpt.ts
@@ -47,7 +47,7 @@ export class ExcerptToken {
 }
 
 /**
- * This class is used by {@link (ApiDeclaredItem:interface)} to represent a source code excerpt containing
+ * This class is used by {@link ApiDeclaredItem} to represent a source code excerpt containing
  * a TypeScript declaration.
  *
  * @remarks
diff --git a/apps/api-extractor-model/src/model/ApiModel.ts b/apps/api-extractor-model/src/model/ApiModel.ts
@@ -17,8 +17,8 @@ import { DocDeclarationReference } from '@microsoft/tsdoc';
  * important information needed to generate documentation, without any reliance on the TypeScript compiler engine.
  *
  * An `ApiModel` acts as the root of a tree of objects that all inherit from the `ApiItem` base class.
- * The tree children are determined by the {@link ApiItemContainerMixin} mixin base class.  The model contains
- * packages.  Packages have an entry point (today, only one).  And the entry point can contain various types
+ * The tree children are determined by the {@link (ApiItemContainerMixin:interface)} mixin base class.  The model
+ * contains packages.  Packages have an entry point (today, only one).  And the entry point can contain various types
  * of API declarations.  The container relationships might look like this:
  *
  * ```
diff --git a/apps/api-extractor-model/src/model/Parameter.ts b/apps/api-extractor-model/src/model/Parameter.ts
@@ -30,7 +30,7 @@ export interface IParameterOptions {
  * }
  * ```
  *
- * `Parameter` objects belong to the {@link ApiParameterListMixin.parameters} collection.
+ * `Parameter` objects belong to the {@link (ApiParameterListMixin:interface).parameters} collection.
  *
  * @public
  */
diff --git a/apps/api-extractor/src/api/IExtractorConfig.ts b/apps/api-extractor/src/api/IExtractorConfig.ts
@@ -268,7 +268,7 @@ export interface IExtractorTsdocMetadataConfig {
 }
 
 /**
- * Used with {@link IExtractorMessageRoutingConfig.logLevel}.
+ * Used with {@link IExtractorMessageReportingRuleConfig.logLevel}.
  *
  * @public
  */
diff --git a/common/reviews/api/node-core-library.api.md b/common/reviews/api/node-core-library.api.md
@@ -309,7 +309,6 @@ export class InternalError extends Error {
 
 // @public
 export interface IPackageJson extends INodePackageJson {
-    // (undocumented)
     version: string;
 }
 
diff --git a/libraries/node-core-library/src/IPackageJson.ts b/libraries/node-core-library/src/IPackageJson.ts
@@ -175,6 +175,6 @@ export interface IPackageJsonTsdocConfiguration {
  */
 export interface IPackageJson extends INodePackageJson {
   // Make the "version" field non-optional.
-  /** {@inheritDoc IPackageJson.version} */
+  /** {@inheritDoc INodePackageJson.version} */
   version: string;
 }
diff --git a/libraries/node-core-library/src/PackageJsonLookup.ts b/libraries/node-core-library/src/PackageJsonLookup.ts
@@ -178,8 +178,8 @@ export class PackageJsonLookup {
   }
 
   /**
-   * This function is similar to {@link tryLoadPackageJsonFor}, except that it does not report an error if the
-   * `version` field is missing from the package.json file.
+   * This function is similar to {@link PackageJsonLookup.tryLoadPackageJsonFor}, except that it does not report
+   * an error if the `version` field is missing from the package.json file.
    */
   public tryLoadNodePackageJsonFor(fileOrFolderPath: string): INodePackageJson | undefined {
     const packageJsonFilePath: string | undefined = this.tryGetPackageJsonFilePathFor(fileOrFolderPath);
@@ -212,8 +212,8 @@ export class PackageJsonLookup {
   }
 
   /**
-   * This function is similar to {@link loadPackageJson}, except that it does not report an error if the
-   * `version` field is missing from the package.json file.
+   * This function is similar to {@link PackageJsonLookup.loadPackageJson}, except that it does not report an error
+   * if the `version` field is missing from the package.json file.
    */
   public loadNodePackageJson(jsonFilename: string): INodePackageJson {
     if (!FileSystem.exists(jsonFilename)) {

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,8 @@ const _membersByName: unique symbol = Symbol('ApiItemContainerMixin._membersByNa`
`36`	`36`	`*`
`37`	`37`	* Examples of `ApiItemContainerMixin` child classes include `ApiModel`, `ApiPackage`, `ApiEntryPoint`,
`38`	`38`	* 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}.`
`40`	`41`	`*`
`41`	`42`	`* @public`
`42`	`43`	`*/`
`@@ -70,7 +71,7 @@ export interface ApiItemContainerMixin extends ApiItem {`
`70`	`71`	`}`
`71`	`72`
`72`	`73`	`/**`
`73`		`- * Mixin function for {@link (ApiDeclaredItem:interface)}.`
	`74`	`+ * Mixin function for {@link ApiDeclaredItem}.`
`74`	`75`	`*`
`75`	`76`	`* @param baseClass - The base class to be extended`
`76`	`77`	`* @returns A child class that extends baseClass, adding the {@link (ApiItemContainerMixin:interface)} functionality.`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ export class ExcerptToken {`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`/**`
`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`
`51`	`51`	`* a TypeScript declaration.`
`52`	`52`	`*`
`53`	`53`	`* @remarks`
Original file line number	Diff line number	Diff line change
`@@ -17,8 +17,8 @@ import { DocDeclarationReference } from '@microsoft/tsdoc';`
`17`	`17`	`* important information needed to generate documentation, without any reliance on the TypeScript compiler engine.`
`18`	`18`	`*`
`19`	`19`	* 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`
`22`	`22`	`* of API declarations. The container relationships might look like this:`
`23`	`23`	`*`
`24`	`24`	* ```
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ export interface IParameterOptions {`
`30`	`30`	`* }`
`31`	`31`	* ```
`32`	`32`	`*`
`33`		- * `Parameter` objects belong to the {@link ApiParameterListMixin.parameters} collection.
	`33`	+ * `Parameter` objects belong to the {@link (ApiParameterListMixin:interface).parameters} collection.
`34`	`34`	`*`
`35`	`35`	`* @public`
`36`	`36`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -268,7 +268,7 @@ export interface IExtractorTsdocMetadataConfig {`
`268`	`268`	`}`
`269`	`269`
`270`	`270`	`/**`
`271`		`- * Used with {@link IExtractorMessageRoutingConfig.logLevel}.`
	`271`	`+ * Used with {@link IExtractorMessageReportingRuleConfig.logLevel}.`
`272`	`272`	`*`
`273`	`273`	`* @public`
`274`	`274`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -309,7 +309,6 @@ export class InternalError extends Error {`
`309`	`309`
`310`	`310`	`// @public`
`311`	`311`	`export interface IPackageJson extends INodePackageJson {`
`312`		`- // (undocumented)`
`313`	`312`	`version: string;`
`314`	`313`	`}`
`315`	`314`
Original file line number	Diff line number	Diff line change
`@@ -175,6 +175,6 @@ export interface IPackageJsonTsdocConfiguration {`
`175`	`175`	`*/`
`176`	`176`	`export interface IPackageJson extends INodePackageJson {`
`177`	`177`	`// Make the "version" field non-optional.`
`178`		`- /** {@inheritDoc IPackageJson.version} */`
	`178`	`+ /** {@inheritDoc INodePackageJson.version} */`
`179`	`179`	`version: string;`
`180`	`180`	`}`