[api-documenter] Add new showInheritedMembers config for api-documenter and new api-documenter-scenarios test project

README.md

@@ -108,6 +108,7 @@ These GitHub repositories provide supplementary resources for Rush Stack:
 | [/build-tests-samples/heft-web-rig-library-tutorial](./build-tests-samples/heft-web-rig-library-tutorial/) | (Copy of sample project) Building this project is a regression test for Heft |
 | [/build-tests-samples/heft-webpack-basic-tutorial](./build-tests-samples/heft-webpack-basic-tutorial/) | (Copy of sample project) Building this project is a regression test for Heft |
 | [/build-tests-samples/packlets-tutorial](./build-tests-samples/packlets-tutorial/) | (Copy of sample project) Building this project is a regression test for @rushstack/eslint-plugin-packlets |
+| [/build-tests/api-documenter-scenarios](./build-tests/api-documenter-scenarios/) | Building this project is a regression test for api-documenter |
 | [/build-tests/api-documenter-test](./build-tests/api-documenter-test/) | Building this project is a regression test for api-documenter |
 | [/build-tests/api-extractor-lib1-test](./build-tests/api-extractor-lib1-test/) | Building this project is a regression test for api-extractor |
 | [/build-tests/api-extractor-lib2-test](./build-tests/api-extractor-lib2-test/) | Building this project is a regression test for api-extractor |

apps/api-documenter/CHANGELOG.json

@@ -1,6 +1,24 @@
 {
   "name": "@microsoft/api-documenter",
   "entries": [
+    {
+      "version": "7.18.4",
+      "tag": "@microsoft/api-documenter_v7.18.4",
+      "date": "Thu, 21 Jul 2022 00:16:14 GMT",
+      "comments": {
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@microsoft/api-extractor-model\" to `7.22.0`"
+          },
+          {
+            "comment": "Updating dependency \"@rushstack/heft\" to `0.46.5`"
+          },
+          {
+            "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.9.21`"
+          }
+        ]
+      }
+    },
     {
       "version": "7.18.3",
       "tag": "@microsoft/api-documenter_v7.18.3",

apps/api-documenter/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Change Log - @microsoft/api-documenter
 
-This log was last generated on Wed, 13 Jul 2022 21:31:13 GMT and should not be manually modified.
+This log was last generated on Thu, 21 Jul 2022 00:16:14 GMT and should not be manually modified.
+
+## 7.18.4
+Thu, 21 Jul 2022 00:16:14 GMT
+
+_Version update only_
 
 ## 7.18.3
 Wed, 13 Jul 2022 21:31:13 GMT

apps/api-documenter/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/api-documenter",
-  "version": "7.18.3",
+  "version": "7.18.4",
   "description": "Read JSON files from api-extractor, generate documentation pages",
   "repository": {
     "type": "git",

apps/api-documenter/src/documenters/DocumenterConfig.ts

@@ -21,14 +21,14 @@ export class DocumenterConfig {
   public 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).
    */
   public static readonly jsonSchema: JsonSchema = JsonSchema.fromFile(
     path.join(__dirname, '..', 'schemas', 'api-documenter.schema.json')
   );
 
   /**
-   * The config file name "api-extractor.json".
+   * The config file name "api-documenter.json".
    */
   public static readonly FILENAME: string = 'api-documenter.json';
 

apps/api-documenter/src/documenters/IConfigFile.ts

@@ -103,4 +103,9 @@ export interface IConfigFile {
 
   /** {@inheritDoc IConfigTableOfContents} */
   tableOfContents?: IConfigTableOfContents;
+
+  /**
+   * Specifies whether inherited members should also be shown on an API item's page.
+   */
+  showInheritedMembers?: boolean;
 }