@microsoft/api-documenter 7.18.4 → 7.19.2

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.28.4"
+      "packageVersion": "7.28.7"
     }
   ]
 }

package/lib/documenters/DocumenterConfig.d.ts

@@ -14,11 +14,11 @@ export declare class DocumenterConfig {
      */
     readonly newlineKind: NewlineKind;
     /**
-     * The JSON Schema for API Extractor config file (api-extractor.schema.json).
+     * The JSON Schema for API Documenter config file (api-documenter.schema.json).
      */
     static readonly jsonSchema: JsonSchema;
     /**
-     * The config file name "api-extractor.json".
+     * The config file name "api-documenter.json".
      */
     static readonly FILENAME: string;
     private constructor();

package/lib/documenters/DocumenterConfig.js

@@ -59,11 +59,11 @@ class DocumenterConfig {
 }
 exports.DocumenterConfig = DocumenterConfig;
 /**
- * The JSON Schema for API Extractor config file (api-extractor.schema.json).
+ * The JSON Schema for API Documenter config file (api-documenter.schema.json).
  */
 DocumenterConfig.jsonSchema = node_core_library_1.JsonSchema.fromFile(path.join(__dirname, '..', 'schemas', 'api-documenter.schema.json'));
 /**
- * The config file name "api-extractor.json".
+ * The config file name "api-documenter.json".
  */
 DocumenterConfig.FILENAME = 'api-documenter.json';
 //# sourceMappingURL=DocumenterConfig.js.map

package/lib/documenters/DocumenterConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"DocumenterConfig.js","sourceRoot":"","sources":["../../src/documenters/DocumenterConfig.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,2CAA6B;AAC7B,oEAAiF;AAGjF;;;;GAIG;AACH,MAAa,gBAAgB;IAsB3B,YAAoB,QAAgB,EAAE,UAAuB;QAC3D,IAAI,CAAC,cAAc,GAAG,QAAQ,CAAC;QAC/B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAE7B,QAAQ,UAAU,CAAC,WAAW,EAAE;YAC9B,KAAK,IAAI;gBACP,IAAI,CAAC,WAAW,GAAG,+BAAW,CAAC,EAAE,CAAC;gBAClC,MAAM;YACR,KAAK,IAAI;gBACP,IAAI,CAAC,WAAW,GAAG,+BAAW,CAAC,SAAS,CAAC;gBACzC,MAAM;YACR;gBACE,IAAI,CAAC,WAAW,GAAG,+BAAW,CAAC,IAAI,CAAC;gBACpC,MAAM;SACT;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,cAAsB;QAC3C,MAAM,UAAU,GAAgB,4BAAQ,CAAC,eAAe,CAAC,cAAc,EAAE,gBAAgB,CAAC,UAAU,CAAC,CAAC;QAEtG,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,UAAU,CAAC,CAAC;IACxE,CAAC;;AA9CH,4CA+CC;AArCC;;GAEG;AACoB,2BAAU,GAAe,8BAAU,CAAC,QAAQ,CACjE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,4BAA4B,CAAC,CACpE,CAAC;AAEF;;GAEG;AACoB,yBAAQ,GAAW,qBAAqB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport * as path from 'path';\nimport { JsonSchema, JsonFile, NewlineKind } from '@rushstack/node-core-library';\nimport { IConfigFile } from './IConfigFile';\n\n/**\n * Helper for loading the api-documenter.json file format.  Later when the schema is more mature,\n * this class will be used to represent the validated and normalized configuration, whereas `IConfigFile`\n * represents the raw JSON file structure.\n */\nexport class DocumenterConfig {\n  public readonly configFilePath: string;\n  public readonly configFile: IConfigFile;\n\n  /**\n   * Specifies what type of newlines API Documenter should use when writing output files.  By default, the output files\n   * will be written with Windows-style newlines.\n   */\n  public readonly newlineKind: NewlineKind;\n\n  /**\n   * The JSON Schema for API Extractor config file (api-extractor.schema.json).\n   */\n  public static readonly jsonSchema: JsonSchema = JsonSchema.fromFile(\n    path.join(__dirname, '..', 'schemas', 'api-documenter.schema.json')\n  );\n\n  /**\n   * The config file name \"api-extractor.json\".\n   */\n  public static readonly FILENAME: string = 'api-documenter.json';\n\n  private constructor(filePath: string, configFile: IConfigFile) {\n    this.configFilePath = filePath;\n    this.configFile = configFile;\n\n    switch (configFile.newlineKind) {\n      case 'lf':\n        this.newlineKind = NewlineKind.Lf;\n        break;\n      case 'os':\n        this.newlineKind = NewlineKind.OsDefault;\n        break;\n      default:\n        this.newlineKind = NewlineKind.CrLf;\n        break;\n    }\n  }\n\n  /**\n   * Load and validate an api-documenter.json file.\n   */\n  public static loadFile(configFilePath: string): DocumenterConfig {\n    const configFile: IConfigFile = JsonFile.loadAndValidate(configFilePath, DocumenterConfig.jsonSchema);\n\n    return new DocumenterConfig(path.resolve(configFilePath), configFile);\n  }\n}\n"]}
+{"version":3,"file":"DocumenterConfig.js","sourceRoot":"","sources":["../../src/documenters/DocumenterConfig.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,2CAA6B;AAC7B,oEAAiF;AAGjF;;;;GAIG;AACH,MAAa,gBAAgB;IAsB3B,YAAoB,QAAgB,EAAE,UAAuB;QAC3D,IAAI,CAAC,cAAc,GAAG,QAAQ,CAAC;QAC/B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAE7B,QAAQ,UAAU,CAAC,WAAW,EAAE;YAC9B,KAAK,IAAI;gBACP,IAAI,CAAC,WAAW,GAAG,+BAAW,CAAC,EAAE,CAAC;gBAClC,MAAM;YACR,KAAK,IAAI;gBACP,IAAI,CAAC,WAAW,GAAG,+BAAW,CAAC,SAAS,CAAC;gBACzC,MAAM;YACR;gBACE,IAAI,CAAC,WAAW,GAAG,+BAAW,CAAC,IAAI,CAAC;gBACpC,MAAM;SACT;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,cAAsB;QAC3C,MAAM,UAAU,GAAgB,4BAAQ,CAAC,eAAe,CAAC,cAAc,EAAE,gBAAgB,CAAC,UAAU,CAAC,CAAC;QAEtG,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,UAAU,CAAC,CAAC;IACxE,CAAC;;AA9CH,4CA+CC;AArCC;;GAEG;AACoB,2BAAU,GAAe,8BAAU,CAAC,QAAQ,CACjE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,4BAA4B,CAAC,CACpE,CAAC;AAEF;;GAEG;AACoB,yBAAQ,GAAW,qBAAqB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport * as path from 'path';\nimport { JsonSchema, JsonFile, NewlineKind } from '@rushstack/node-core-library';\nimport { IConfigFile } from './IConfigFile';\n\n/**\n * Helper for loading the api-documenter.json file format.  Later when the schema is more mature,\n * this class will be used to represent the validated and normalized configuration, whereas `IConfigFile`\n * represents the raw JSON file structure.\n */\nexport class DocumenterConfig {\n  public readonly configFilePath: string;\n  public readonly configFile: IConfigFile;\n\n  /**\n   * Specifies what type of newlines API Documenter should use when writing output files.  By default, the output files\n   * will be written with Windows-style newlines.\n   */\n  public readonly newlineKind: NewlineKind;\n\n  /**\n   * The JSON Schema for API Documenter config file (api-documenter.schema.json).\n   */\n  public static readonly jsonSchema: JsonSchema = JsonSchema.fromFile(\n    path.join(__dirname, '..', 'schemas', 'api-documenter.schema.json')\n  );\n\n  /**\n   * The config file name \"api-documenter.json\".\n   */\n  public static readonly FILENAME: string = 'api-documenter.json';\n\n  private constructor(filePath: string, configFile: IConfigFile) {\n    this.configFilePath = filePath;\n    this.configFile = configFile;\n\n    switch (configFile.newlineKind) {\n      case 'lf':\n        this.newlineKind = NewlineKind.Lf;\n        break;\n      case 'os':\n        this.newlineKind = NewlineKind.OsDefault;\n        break;\n      default:\n        this.newlineKind = NewlineKind.CrLf;\n        break;\n    }\n  }\n\n  /**\n   * Load and validate an api-documenter.json file.\n   */\n  public static loadFile(configFilePath: string): DocumenterConfig {\n    const configFile: IConfigFile = JsonFile.loadAndValidate(configFilePath, DocumenterConfig.jsonSchema);\n\n    return new DocumenterConfig(path.resolve(configFilePath), configFile);\n  }\n}\n"]}

package/lib/documenters/IConfigFile.d.ts

@@ -88,5 +88,9 @@ export interface IConfigFile {
     plugins?: IConfigPlugin[];
     /** {@inheritDoc IConfigTableOfContents} */
     tableOfContents?: IConfigTableOfContents;
+    /**
+     * Specifies whether inherited members should also be shown on an API item's page.
+     */
+    showInheritedMembers?: boolean;
 }
 //# sourceMappingURL=IConfigFile.d.ts.map

package/lib/documenters/IConfigFile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IConfigFile.d.ts","sourceRoot":"","sources":["../../src/documenters/IConfigFile.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;;;OAMG;IACH,SAAS,EAAE,YAAY,CAAC;IAExB;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,MAAM,EAAE,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,mBAAmB,EAAE,MAAM,EAAE,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,YAAY,EAAE,OAAO,GAAG,UAAU,CAAC;IAEnC;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAC;IAEnC;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B,kCAAkC;IAClC,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAE1B,2CAA2C;IAC3C,eAAe,CAAC,EAAE,sBAAsB,CAAC;CAC1C"}
+{"version":3,"file":"IConfigFile.d.ts","sourceRoot":"","sources":["../../src/documenters/IConfigFile.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;;;OAMG;IACH,SAAS,EAAE,YAAY,CAAC;IAExB;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,MAAM,EAAE,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,mBAAmB,EAAE,MAAM,EAAE,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,YAAY,EAAE,OAAO,GAAG,UAAU,CAAC;IAEnC;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAC;IAEnC;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B,kCAAkC;IAClC,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAE1B,2CAA2C;IAC3C,eAAe,CAAC,EAAE,sBAAsB,CAAC;IAEzC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC"}

package/lib/documenters/IConfigFile.js.map

@@ -1 +1 @@
-{"version":3,"file":"IConfigFile.js","sourceRoot":"","sources":["../../src/documenters/IConfigFile.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { IYamlTocFile } from '../yaml/IYamlTocFile';\n\n/**\n * Typescript interface describing the config schema for toc.yml file format.\n */\nexport interface IConfigTableOfContents {\n  /**\n   * Represents the tree structure describing the toc.file format.\n   * Nodes that have an empty `items` array property or their name will be included in the\n   * {@link IConfigTableOfContents.nonEmptyCategoryNodeNames} will be filled with API items\n   * that are matched with the filters provided. Everything else will be placed under\n   * {@link IConfigTableOfContents.catchAllCategory} if provided, which is highly recommended.\n   */\n  tocConfig: IYamlTocFile;\n\n  /**\n   * Optional category name that is recommended to be included along with\n   * one of the configs: {@link IConfigTableOfContents.categorizeByName} or\n   * {@link IConfigTableOfContents.categoryInlineTag}.\n   * Any items that are not matched according to the mentioned configuration options will be placed under this\n   * catchAll category. If none provided the items will not be included in the final toc.yml file.\n   */\n  catchAllCategory?: string;\n\n  /**\n   * Toggle either categorization of the API items should be made based on category name presence\n   * in the API item's name. Useful when there are API items without an inline tag to categorize them,\n   * but still need to place the items under categories. Note: this type of categorization might place some items\n   * under wrong categories if the names are similar but belong to different categories.\n   * In case that {@link IConfigTableOfContents.categoryInlineTag} is provided it will try categorize by\n   * using it and only if it didn't, it will attempt to categorize by name.\n   */\n  categorizeByName?: boolean;\n\n  /**\n   * Inline tag that will be used to categorize the API items. Will take precedence over the\n   * {@link IConfigTableOfContents.categorizeByName} flag in trying to place the API item according to the\n   * custom inline tag present in documentation of the source code.\n   */\n  categoryInlineTag?: string;\n\n  /**\n   * Array of node names that might have already items injected at the time of creating the\n   * {@link IConfigTableOfContents.tocConfig} tree structure but are still needed to be included as category\n   * nodes where API items will be pushed during the categorization algorithm.\n   */\n  nonEmptyCategoryNodeNames?: string[];\n}\n\n/**\n * Describes plugin packages to be loaded, and which features to enable.\n */\nexport interface IConfigPlugin {\n  /**\n   * Specifies the name of an API Documenter plugin package to be loaded.  By convention, the NPM package name\n   * should have the prefix `doc-plugin-`.  Its main entry point should export an object named\n   * `apiDocumenterPluginManifest` which implements the {@link IApiDocumenterPluginManifest} interface.\n   */\n  packageName: string;\n\n  /**\n   * A list of features to be enabled.  The features are defined in {@link IApiDocumenterPluginManifest.features}.\n   * The `enabledFeatureNames` strings are matched with {@link IFeatureDefinition.featureName}.\n   */\n  enabledFeatureNames: string[];\n}\n\n/**\n * This interface represents the api-documenter.json file format.\n */\nexport interface IConfigFile {\n  /**\n   * Specifies the output target.\n   */\n  outputTarget: 'docfx' | 'markdown';\n\n  /**\n   * Specifies what type of newlines API Documenter should use when writing output files.\n   *\n   * @remarks\n   * By default, the output files will be written with Windows-style newlines.\n   * To use POSIX-style newlines, specify \"lf\" instead.\n   * To use the OS's default newline kind, specify \"os\".\n   */\n  newlineKind?: 'crlf' | 'lf' | 'os';\n\n  /**\n   * This enables an experimental feature that will be officially released with the next major version\n   * of API Documenter.  It requires DocFX 2.46 or newer.  It enables documentation for namespaces and\n   * adds them to the table of contents.  This will also affect file layout as namespaced items will be nested\n   * under a directory for the namespace instead of just within the package.\n   *\n   * This setting currently only affects the 'docfx' output target.  It is equivalent to the `--new-docfx-namespaces`\n   * command-line parameter.\n   */\n  newDocfxNamespaces?: boolean;\n\n  /** {@inheritDoc IConfigPlugin} */\n  plugins?: IConfigPlugin[];\n\n  /** {@inheritDoc IConfigTableOfContents} */\n  tableOfContents?: IConfigTableOfContents;\n}\n"]}
+{"version":3,"file":"IConfigFile.js","sourceRoot":"","sources":["../../src/documenters/IConfigFile.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { IYamlTocFile } from '../yaml/IYamlTocFile';\n\n/**\n * Typescript interface describing the config schema for toc.yml file format.\n */\nexport interface IConfigTableOfContents {\n  /**\n   * Represents the tree structure describing the toc.file format.\n   * Nodes that have an empty `items` array property or their name will be included in the\n   * {@link IConfigTableOfContents.nonEmptyCategoryNodeNames} will be filled with API items\n   * that are matched with the filters provided. Everything else will be placed under\n   * {@link IConfigTableOfContents.catchAllCategory} if provided, which is highly recommended.\n   */\n  tocConfig: IYamlTocFile;\n\n  /**\n   * Optional category name that is recommended to be included along with\n   * one of the configs: {@link IConfigTableOfContents.categorizeByName} or\n   * {@link IConfigTableOfContents.categoryInlineTag}.\n   * Any items that are not matched according to the mentioned configuration options will be placed under this\n   * catchAll category. If none provided the items will not be included in the final toc.yml file.\n   */\n  catchAllCategory?: string;\n\n  /**\n   * Toggle either categorization of the API items should be made based on category name presence\n   * in the API item's name. Useful when there are API items without an inline tag to categorize them,\n   * but still need to place the items under categories. Note: this type of categorization might place some items\n   * under wrong categories if the names are similar but belong to different categories.\n   * In case that {@link IConfigTableOfContents.categoryInlineTag} is provided it will try categorize by\n   * using it and only if it didn't, it will attempt to categorize by name.\n   */\n  categorizeByName?: boolean;\n\n  /**\n   * Inline tag that will be used to categorize the API items. Will take precedence over the\n   * {@link IConfigTableOfContents.categorizeByName} flag in trying to place the API item according to the\n   * custom inline tag present in documentation of the source code.\n   */\n  categoryInlineTag?: string;\n\n  /**\n   * Array of node names that might have already items injected at the time of creating the\n   * {@link IConfigTableOfContents.tocConfig} tree structure but are still needed to be included as category\n   * nodes where API items will be pushed during the categorization algorithm.\n   */\n  nonEmptyCategoryNodeNames?: string[];\n}\n\n/**\n * Describes plugin packages to be loaded, and which features to enable.\n */\nexport interface IConfigPlugin {\n  /**\n   * Specifies the name of an API Documenter plugin package to be loaded.  By convention, the NPM package name\n   * should have the prefix `doc-plugin-`.  Its main entry point should export an object named\n   * `apiDocumenterPluginManifest` which implements the {@link IApiDocumenterPluginManifest} interface.\n   */\n  packageName: string;\n\n  /**\n   * A list of features to be enabled.  The features are defined in {@link IApiDocumenterPluginManifest.features}.\n   * The `enabledFeatureNames` strings are matched with {@link IFeatureDefinition.featureName}.\n   */\n  enabledFeatureNames: string[];\n}\n\n/**\n * This interface represents the api-documenter.json file format.\n */\nexport interface IConfigFile {\n  /**\n   * Specifies the output target.\n   */\n  outputTarget: 'docfx' | 'markdown';\n\n  /**\n   * Specifies what type of newlines API Documenter should use when writing output files.\n   *\n   * @remarks\n   * By default, the output files will be written with Windows-style newlines.\n   * To use POSIX-style newlines, specify \"lf\" instead.\n   * To use the OS's default newline kind, specify \"os\".\n   */\n  newlineKind?: 'crlf' | 'lf' | 'os';\n\n  /**\n   * This enables an experimental feature that will be officially released with the next major version\n   * of API Documenter.  It requires DocFX 2.46 or newer.  It enables documentation for namespaces and\n   * adds them to the table of contents.  This will also affect file layout as namespaced items will be nested\n   * under a directory for the namespace instead of just within the package.\n   *\n   * This setting currently only affects the 'docfx' output target.  It is equivalent to the `--new-docfx-namespaces`\n   * command-line parameter.\n   */\n  newDocfxNamespaces?: boolean;\n\n  /** {@inheritDoc IConfigPlugin} */\n  plugins?: IConfigPlugin[];\n\n  /** {@inheritDoc IConfigTableOfContents} */\n  tableOfContents?: IConfigTableOfContents;\n\n  /**\n   * Specifies whether inherited members should also be shown on an API item's page.\n   */\n  showInheritedMembers?: boolean;\n}\n"]}

package/lib/documenters/MarkdownDocumenter.d.ts

@@ -65,6 +65,7 @@ export declare class MarkdownDocumenter {
     private _writeBetaWarning;
     private _appendSection;
     private _appendAndMergeSection;
+    private _getMembersAndWriteIncompleteWarning;
     private _getFilenameForApiItem;
     private _getLinkFilenameForApiItem;
     private _deleteOldOutputFiles;

package/lib/documenters/MarkdownDocumenter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MarkdownDocumenter.d.ts","sourceRoot":"","sources":["../../src/documenters/MarkdownDocumenter.ts"],"names":[],"mappings":"AAoBA,OAAO,EACL,QAAQ,EAyBT,MAAM,gCAAgC,CAAC;AAgBxC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAGtD,MAAM,WAAW,0BAA0B;IACzC,QAAQ,EAAE,QAAQ,CAAC;IACnB,gBAAgB,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAC/C,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAW;IACrC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA+B;IACjE,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAqB;IACzD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAwB;IACzD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IACvC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAe;gBAE1B,OAAO,EAAE,0BAA0B;IAU/C,aAAa,IAAI,IAAI;IAyB5B,OAAO,CAAC,iBAAiB;IAiNzB,OAAO,CAAC,mBAAmB;IAmF3B,OAAO,CAAC,oBAAoB;IA8B5B,OAAO,CAAC,mBAAmB;IAsB3B;;OAEG;IACH,OAAO,CAAC,gBAAgB;IA4BxB;;OAEG;IACH,OAAO,CAAC,8BAA8B;IA0HtC;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAiGzB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IA8BxB;;OAEG;IACH,OAAO,CAAC,qBAAqB;IA2E7B;;OAEG;IACH,OAAO,CAAC,qBAAqB;IA+D7B,OAAO,CAAC,8BAA8B;IActC,OAAO,CAAC,4BAA4B;IAMpC,OAAO,CAAC,iCAAiC;IAgCzC,OAAO,CAAC,gBAAgB;IAoBxB;;;;;;OAMG;IACH,OAAO,CAAC,sBAAsB;IAkC9B,OAAO,CAAC,oBAAoB;IAgC5B,OAAO,CAAC,uBAAuB;IAY/B,OAAO,CAAC,sBAAsB;IAgB9B,OAAO,CAAC,gBAAgB;IAmCxB,OAAO,CAAC,iBAAiB;IAYzB,OAAO,CAAC,cAAc;IAMtB,OAAO,CAAC,sBAAsB;IAgB9B,OAAO,CAAC,sBAAsB;IAgC9B,OAAO,CAAC,0BAA0B;IAIlC,OAAO,CAAC,qBAAqB;CAI9B"}
+{"version":3,"file":"MarkdownDocumenter.d.ts","sourceRoot":"","sources":["../../src/documenters/MarkdownDocumenter.ts"],"names":[],"mappings":"AAoBA,OAAO,EACL,QAAQ,EA0BT,MAAM,gCAAgC,CAAC;AAgBxC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAGtD,MAAM,WAAW,0BAA0B;IACzC,QAAQ,EAAE,QAAQ,CAAC;IACnB,gBAAgB,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAC/C,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAW;IACrC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA+B;IACjE,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAqB;IACzD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAwB;IACzD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IACvC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAe;gBAE1B,OAAO,EAAE,0BAA0B;IAU/C,aAAa,IAAI,IAAI;IAyB5B,OAAO,CAAC,iBAAiB;IAiNzB,OAAO,CAAC,mBAAmB;IAmF3B,OAAO,CAAC,oBAAoB;IAgC5B,OAAO,CAAC,mBAAmB;IAwB3B;;OAEG;IACH,OAAO,CAAC,gBAAgB;IA4BxB;;OAEG;IACH,OAAO,CAAC,8BAA8B;IA0HtC;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAmGzB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IA4BxB;;OAEG;IACH,OAAO,CAAC,qBAAqB;IA6E7B;;OAEG;IACH,OAAO,CAAC,qBAAqB;IA+D7B,OAAO,CAAC,8BAA8B;IActC,OAAO,CAAC,4BAA4B;IAMpC,OAAO,CAAC,iCAAiC;IAgCzC,OAAO,CAAC,gBAAgB;IAoBxB;;;;;;OAMG;IACH,OAAO,CAAC,sBAAsB;IAiD9B,OAAO,CAAC,oBAAoB;IAgC5B,OAAO,CAAC,uBAAuB;IAY/B,OAAO,CAAC,sBAAsB;IAgB9B,OAAO,CAAC,gBAAgB;IAqCxB,OAAO,CAAC,iBAAiB;IAYzB,OAAO,CAAC,cAAc;IAMtB,OAAO,CAAC,sBAAsB;IAgB9B,OAAO,CAAC,oCAAoC;IAkC5C,OAAO,CAAC,sBAAsB;IAgC9B,OAAO,CAAC,0BAA0B;IAIlC,OAAO,CAAC,qBAAqB;CAI9B"}

package/lib/documenters/MarkdownDocumenter.js

@@ -78,7 +78,7 @@ class MarkdownDocumenter {
     }
     _writeApiItemPage(apiItem) {
         const configuration = this._tsdocConfiguration;
-        const output = new tsdoc_1.DocSection({ configuration: this._tsdocConfiguration });
+        const output = new tsdoc_1.DocSection({ configuration });
         this._writeBreadcrumb(output, apiItem);
         const scopedName = apiItem.getScopedNameWithinPackage();
         switch (apiItem.kind) {
@@ -137,10 +137,10 @@ class MarkdownDocumenter {
             if (tsdocComment) {
                 decoratorBlocks.push(...tsdocComment.customBlocks.filter((block) => block.blockTag.tagNameWithUpperCase === tsdoc_1.StandardTags.decorator.tagNameWithUpperCase));
                 if (tsdocComment.deprecatedBlock) {
-                    output.appendNode(new DocNoteBox_1.DocNoteBox({ configuration: this._tsdocConfiguration }, [
-                        new tsdoc_1.DocParagraph({ configuration: this._tsdocConfiguration }, [
+                    output.appendNode(new DocNoteBox_1.DocNoteBox({ configuration }, [
+                        new tsdoc_1.DocParagraph({ configuration }, [
                             new tsdoc_1.DocPlainText({
-                                configuration: this._tsdocConfiguration,
+                                configuration,
                                 text: 'Warning: This API is now obsolete. '
                             })
                         ]),
@@ -262,7 +262,7 @@ class MarkdownDocumenter {
                 output.appendNode(extendsParagraph);
             }
             if (apiItem.implementsTypes.length > 0) {
-                const extendsParagraph = new tsdoc_1.DocParagraph({ configuration }, [
+                const implementsParagraph = new tsdoc_1.DocParagraph({ configuration }, [
                     new DocEmphasisSpan_1.DocEmphasisSpan({ configuration, bold: true }, [
                         new tsdoc_1.DocPlainText({ configuration, text: 'Implements: ' })
                     ])
@@ -270,12 +270,12 @@ class MarkdownDocumenter {
                 let needsComma = false;
                 for (const implementsType of apiItem.implementsTypes) {
                     if (needsComma) {
-                        extendsParagraph.appendNode(new tsdoc_1.DocPlainText({ configuration, text: ', ' }));
+                        implementsParagraph.appendNode(new tsdoc_1.DocPlainText({ configuration, text: ', ' }));
                     }
-                    this._appendExcerptWithHyperlinks(extendsParagraph, implementsType.excerpt);
+                    this._appendExcerptWithHyperlinks(implementsParagraph, implementsType.excerpt);
                     needsComma = true;
                 }
-                output.appendNode(extendsParagraph);
+                output.appendNode(implementsParagraph);
             }
         }
         if (apiItem instanceof api_extractor_model_1.ApiInterface) {
@@ -324,12 +324,13 @@ class MarkdownDocumenter {
         }
     }
     _writeRemarksSection(output, apiItem) {
+        const configuration = this._tsdocConfiguration;
         if (apiItem instanceof api_extractor_model_1.ApiDocumentedItem) {
             const tsdocComment = apiItem.tsdocComment;
             if (tsdocComment) {
                 // Write the @remarks block
                 if (tsdocComment.remarksBlock) {
-                    output.appendNode(new DocHeading_1.DocHeading({ configuration: this._tsdocConfiguration, title: 'Remarks' }));
+                    output.appendNode(new DocHeading_1.DocHeading({ configuration, title: 'Remarks' }));
                     this._appendSection(output, tsdocComment.remarksBlock.content);
                 }
                 // Write the @example blocks
@@ -337,7 +338,7 @@ class MarkdownDocumenter {
                 let exampleNumber = 1;
                 for (const exampleBlock of exampleBlocks) {
                     const heading = exampleBlocks.length > 1 ? `Example ${exampleNumber}` : 'Example';
-                    output.appendNode(new DocHeading_1.DocHeading({ configuration: this._tsdocConfiguration, title: heading }));
+                    output.appendNode(new DocHeading_1.DocHeading({ configuration, title: heading }));
                     this._appendSection(output, exampleBlock.content);
                     ++exampleNumber;
                 }
@@ -345,6 +346,7 @@ class MarkdownDocumenter {
         }
     }
     _writeThrowsSection(output, apiItem) {
+        const configuration = this._tsdocConfiguration;
         if (apiItem instanceof api_extractor_model_1.ApiDocumentedItem) {
             const tsdocComment = apiItem.tsdocComment;
             if (tsdocComment) {
@@ -352,7 +354,7 @@ class MarkdownDocumenter {
                 const throwsBlocks = tsdocComment.customBlocks.filter((x) => x.blockTag.tagNameWithUpperCase === tsdoc_1.StandardTags.throws.tagNameWithUpperCase);
                 if (throwsBlocks.length > 0) {
                     const heading = 'Exceptions';
-                    output.appendNode(new DocHeading_1.DocHeading({ configuration: this._tsdocConfiguration, title: heading }));
+                    output.appendNode(new DocHeading_1.DocHeading({ configuration, title: heading }));
                     for (const throwsBlock of throwsBlocks) {
                         this._appendSection(output, throwsBlock.content);
                     }
@@ -382,7 +384,7 @@ class MarkdownDocumenter {
             }
         }
         if (packagesTable.rows.length > 0) {
-            output.appendNode(new DocHeading_1.DocHeading({ configuration: this._tsdocConfiguration, title: 'Packages' }));
+            output.appendNode(new DocHeading_1.DocHeading({ configuration, title: 'Packages' }));
             output.appendNode(packagesTable);
         }
     }
@@ -459,31 +461,31 @@ class MarkdownDocumenter {
             }
         }
         if (classesTable.rows.length > 0) {
-            output.appendNode(new DocHeading_1.DocHeading({ configuration: this._tsdocConfiguration, title: 'Classes' }));
+            output.appendNode(new DocHeading_1.DocHeading({ configuration, title: 'Classes' }));
             output.appendNode(classesTable);
         }
         if (enumerationsTable.rows.length > 0) {
-            output.appendNode(new DocHeading_1.DocHeading({ configuration: this._tsdocConfiguration, title: 'Enumerations' }));
+            output.appendNode(new DocHeading_1.DocHeading({ configuration, title: 'Enumerations' }));
             output.appendNode(enumerationsTable);
         }
         if (functionsTable.rows.length > 0) {
-            output.appendNode(new DocHeading_1.DocHeading({ configuration: this._tsdocConfiguration, title: 'Functions' }));
+            output.appendNode(new DocHeading_1.DocHeading({ configuration, title: 'Functions' }));
             output.appendNode(functionsTable);
         }
         if (interfacesTable.rows.length > 0) {
-            output.appendNode(new DocHeading_1.DocHeading({ configuration: this._tsdocConfiguration, title: 'Interfaces' }));
+            output.appendNode(new DocHeading_1.DocHeading({ configuration, title: 'Interfaces' }));
             output.appendNode(interfacesTable);
         }
         if (namespacesTable.rows.length > 0) {
-            output.appendNode(new DocHeading_1.DocHeading({ configuration: this._tsdocConfiguration, title: 'Namespaces' }));
+            output.appendNode(new DocHeading_1.DocHeading({ configuration, title: 'Namespaces' }));
             output.appendNode(namespacesTable);
         }
         if (variablesTable.rows.length > 0) {
-            output.appendNode(new DocHeading_1.DocHeading({ configuration: this._tsdocConfiguration, title: 'Variables' }));
+            output.appendNode(new DocHeading_1.DocHeading({ configuration, title: 'Variables' }));
             output.appendNode(variablesTable);
         }
         if (typeAliasesTable.rows.length > 0) {
-            output.appendNode(new DocHeading_1.DocHeading({ configuration: this._tsdocConfiguration, title: 'Type Aliases' }));
+            output.appendNode(new DocHeading_1.DocHeading({ configuration, title: 'Type Aliases' }));
             output.appendNode(typeAliasesTable);
         }
     }
@@ -508,13 +510,15 @@ class MarkdownDocumenter {
             configuration,
             headerTitles: ['Method', 'Modifiers', 'Description']
         });
-        for (const apiMember of apiClass.members) {
+        const apiMembers = this._getMembersAndWriteIncompleteWarning(apiClass, output);
+        for (const apiMember of apiMembers) {
+            const isInherited = apiMember.parent !== apiClass;
             switch (apiMember.kind) {
                 case api_extractor_model_1.ApiItemKind.Constructor: {
                     constructorsTable.addRow(new DocTableRow_1.DocTableRow({ configuration }, [
                         this._createTitleCell(apiMember),
                         this._createModifiersCell(apiMember),
-                        this._createDescriptionCell(apiMember)
+                        this._createDescriptionCell(apiMember, isInherited)
                     ]));
                     this._writeApiItemPage(apiMember);
                     break;
@@ -523,7 +527,7 @@ class MarkdownDocumenter {
                     methodsTable.addRow(new DocTableRow_1.DocTableRow({ configuration }, [
                         this._createTitleCell(apiMember),
                         this._createModifiersCell(apiMember),
-                        this._createDescriptionCell(apiMember)
+                        this._createDescriptionCell(apiMember, isInherited)
                     ]));
                     this._writeApiItemPage(apiMember);
                     break;
@@ -534,7 +538,7 @@ class MarkdownDocumenter {
                             this._createTitleCell(apiMember),
                             this._createModifiersCell(apiMember),
                             this._createPropertyTypeCell(apiMember),
-                            this._createDescriptionCell(apiMember)
+                            this._createDescriptionCell(apiMember, isInherited)
                         ]));
                     }
                     else {
@@ -542,7 +546,7 @@ class MarkdownDocumenter {
                             this._createTitleCell(apiMember),
                             this._createModifiersCell(apiMember),
                             this._createPropertyTypeCell(apiMember),
-                            this._createDescriptionCell(apiMember)
+                            this._createDescriptionCell(apiMember, isInherited)
                         ]));
                     }
                     this._writeApiItemPage(apiMember);
@@ -551,19 +555,19 @@ class MarkdownDocumenter {
             }
         }
         if (eventsTable.rows.length > 0) {
-            output.appendNode(new DocHeading_1.DocHeading({ configuration: this._tsdocConfiguration, title: 'Events' }));
+            output.appendNode(new DocHeading_1.DocHeading({ configuration, title: 'Events' }));
             output.appendNode(eventsTable);
         }
         if (constructorsTable.rows.length > 0) {
-            output.appendNode(new DocHeading_1.DocHeading({ configuration: this._tsdocConfiguration, title: 'Constructors' }));
+            output.appendNode(new DocHeading_1.DocHeading({ configuration, title: 'Constructors' }));
             output.appendNode(constructorsTable);
         }
         if (propertiesTable.rows.length > 0) {
-            output.appendNode(new DocHeading_1.DocHeading({ configuration: this._tsdocConfiguration, title: 'Properties' }));
+            output.appendNode(new DocHeading_1.DocHeading({ configuration, title: 'Properties' }));
             output.appendNode(propertiesTable);
         }
         if (methodsTable.rows.length > 0) {
-            output.appendNode(new DocHeading_1.DocHeading({ configuration: this._tsdocConfiguration, title: 'Methods' }));
+            output.appendNode(new DocHeading_1.DocHeading({ configuration, title: 'Methods' }));
             output.appendNode(methodsTable);
         }
     }
@@ -588,14 +592,14 @@ class MarkdownDocumenter {
             ]));
         }
         if (enumMembersTable.rows.length > 0) {
-            output.appendNode(new DocHeading_1.DocHeading({ configuration: this._tsdocConfiguration, title: 'Enumeration Members' }));
+            output.appendNode(new DocHeading_1.DocHeading({ configuration, title: 'Enumeration Members' }));
             output.appendNode(enumMembersTable);
         }
     }
     /**
      * GENERATE PAGE: INTERFACE
      */
-    _writeInterfaceTables(output, apiClass) {
+    _writeInterfaceTables(output, apiInterface) {
         const configuration = this._tsdocConfiguration;
         const eventsTable = new DocTable_1.DocTable({
             configuration,
@@ -609,13 +613,15 @@ class MarkdownDocumenter {
             configuration,
             headerTitles: ['Method', 'Description']
         });
-        for (const apiMember of apiClass.members) {
+        const apiMembers = this._getMembersAndWriteIncompleteWarning(apiInterface, output);
+        for (const apiMember of apiMembers) {
+            const isInherited = apiMember.parent !== apiInterface;
             switch (apiMember.kind) {
                 case api_extractor_model_1.ApiItemKind.ConstructSignature:
                 case api_extractor_model_1.ApiItemKind.MethodSignature: {
                     methodsTable.addRow(new DocTableRow_1.DocTableRow({ configuration }, [
                         this._createTitleCell(apiMember),
-                        this._createDescriptionCell(apiMember)
+                        this._createDescriptionCell(apiMember, isInherited)
                     ]));
                     this._writeApiItemPage(apiMember);
                     break;
@@ -626,7 +632,7 @@ class MarkdownDocumenter {
                             this._createTitleCell(apiMember),
                             this._createModifiersCell(apiMember),
                             this._createPropertyTypeCell(apiMember),
-                            this._createDescriptionCell(apiMember)
+                            this._createDescriptionCell(apiMember, isInherited)
                         ]));
                     }
                     else {
@@ -634,7 +640,7 @@ class MarkdownDocumenter {
                             this._createTitleCell(apiMember),
                             this._createModifiersCell(apiMember),
                             this._createPropertyTypeCell(apiMember),
-                            this._createDescriptionCell(apiMember)
+                            this._createDescriptionCell(apiMember, isInherited)
                         ]));
                     }
                     this._writeApiItemPage(apiMember);
@@ -643,15 +649,15 @@ class MarkdownDocumenter {
             }
         }
         if (eventsTable.rows.length > 0) {
-            output.appendNode(new DocHeading_1.DocHeading({ configuration: this._tsdocConfiguration, title: 'Events' }));
+            output.appendNode(new DocHeading_1.DocHeading({ configuration, title: 'Events' }));
             output.appendNode(eventsTable);
         }
         if (propertiesTable.rows.length > 0) {
-            output.appendNode(new DocHeading_1.DocHeading({ configuration: this._tsdocConfiguration, title: 'Properties' }));
+            output.appendNode(new DocHeading_1.DocHeading({ configuration, title: 'Properties' }));
             output.appendNode(propertiesTable);
         }
         if (methodsTable.rows.length > 0) {
-            output.appendNode(new DocHeading_1.DocHeading({ configuration: this._tsdocConfiguration, title: 'Methods' }));
+            output.appendNode(new DocHeading_1.DocHeading({ configuration, title: 'Methods' }));
             output.appendNode(methodsTable);
         }
     }
@@ -690,7 +696,7 @@ class MarkdownDocumenter {
             ]));
         }
         if (parametersTable.rows.length > 0) {
-            output.appendNode(new DocHeading_1.DocHeading({ configuration: this._tsdocConfiguration, title: 'Parameters' }));
+            output.appendNode(new DocHeading_1.DocHeading({ configuration, title: 'Parameters' }));
             output.appendNode(parametersTable);
         }
         if (api_extractor_model_1.ApiReturnTypeMixin.isBaseClassOf(apiParameterListMixin)) {
@@ -770,7 +776,7 @@ class MarkdownDocumenter {
      * We mostly assume that the input is an ApiDocumentedItem, but it's easier to perform this as a runtime
      * check than to have each caller perform a type cast.
      */
-    _createDescriptionCell(apiItem) {
+    _createDescriptionCell(apiItem, isInherited = false) {
         const configuration = this._tsdocConfiguration;
         const section = new tsdoc_1.DocSection({ configuration });
         if (api_extractor_model_1.ApiReleaseTagMixin.isBaseClassOf(apiItem)) {
@@ -796,6 +802,18 @@ class MarkdownDocumenter {
                 this._appendAndMergeSection(section, apiItem.tsdocComment.summarySection);
             }
         }
+        if (isInherited && apiItem.parent) {
+            section.appendNode(new tsdoc_1.DocParagraph({ configuration }, [
+                new tsdoc_1.DocPlainText({ configuration, text: '(Inherited from ' }),
+                new tsdoc_1.DocLinkTag({
+                    configuration,
+                    tagName: '@link',
+                    linkText: apiItem.parent.displayName,
+                    urlDestination: this._getLinkFilenameForApiItem(apiItem.parent)
+                }),
+                new tsdoc_1.DocPlainText({ configuration, text: ')' })
+            ]));
+        }
         return new DocTableCell_1.DocTableCell({ configuration }, section.nodes);
     }
     _createModifiersCell(apiItem) {
@@ -837,8 +855,9 @@ class MarkdownDocumenter {
         return new DocTableCell_1.DocTableCell({ configuration }, section.nodes);
     }
     _writeBreadcrumb(output, apiItem) {
+        const configuration = this._tsdocConfiguration;
         output.appendNodeInParagraph(new tsdoc_1.DocLinkTag({
-            configuration: this._tsdocConfiguration,
+            configuration,
             tagName: '@link',
             linkText: 'Home',
             urlDestination: this._getLinkFilenameForApiItem(this._apiModel)
@@ -854,11 +873,11 @@ class MarkdownDocumenter {
                 default:
                     output.appendNodesInParagraph([
                         new tsdoc_1.DocPlainText({
-                            configuration: this._tsdocConfiguration,
+                            configuration,
                             text: ' > '
                         }),
                         new tsdoc_1.DocLinkTag({
-                            configuration: this._tsdocConfiguration,
+                            configuration,
                             tagName: '@link',
                             linkText: hierarchyItem.displayName,
                             urlDestination: this._getLinkFilenameForApiItem(hierarchyItem)
@@ -894,6 +913,31 @@ class MarkdownDocumenter {
             output.appendNode(node);
         }
     }
+    _getMembersAndWriteIncompleteWarning(apiClassOrInterface, output) {
+        var _a;
+        const configuration = this._tsdocConfiguration;
+        const showInheritedMembers = !!((_a = this._documenterConfig) === null || _a === void 0 ? void 0 : _a.configFile.showInheritedMembers);
+        if (!showInheritedMembers) {
+            return apiClassOrInterface.members;
+        }
+        const result = apiClassOrInterface.findMembersWithInheritance();
+        // If the result is potentially incomplete, write a short warning communicating this.
+        if (result.maybeIncompleteResult) {
+            output.appendNode(new tsdoc_1.DocParagraph({ configuration }, [
+                new DocEmphasisSpan_1.DocEmphasisSpan({ configuration, italic: true }, [
+                    new tsdoc_1.DocPlainText({
+                        configuration,
+                        text: '(Some inherited members may not be shown because they are not represented in the documentation.)'
+                    })
+                ])
+            ]));
+        }
+        // Log the messages for diagnostic purposes.
+        for (const message of result.messages) {
+            console.log(`Diagnostic message for findMembersWithInheritance: ${message.text}`);
+        }
+        return result.items;
+    }
     _getFilenameForApiItem(apiItem) {
         if (apiItem.kind === api_extractor_model_1.ApiItemKind.Model) {
             return 'index.md';