Merge pull request #3543 from zelliott/inheritance-docs-api-documenter

[api-documenter] Add new `showInheritedMembers` config for api-documenter and new api-documenter-scenarios test project
microsoft · Jul 21, 2022 · 4077079 · 4077079
2 parents 183d212 + baa19e9
commit 4077079
Show file tree

Hide file tree

Showing 196 changed files with 2,449 additions and 75 deletions.
diff --git a/README.md b/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 |

diff --git a/apps/api-documenter/src/documenters/DocumenterConfig.ts b/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';
 

diff --git a/apps/api-documenter/src/documenters/IConfigFile.ts b/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;
 }