From 6e2e0d4ae3f625f373a609e19b09557a330fba38 Mon Sep 17 00:00:00 2001
From: Erick Zhao <erick@hotmail.ca>
Date: Thu, 13 Oct 2022 00:40:48 -0700
Subject: [PATCH] docs: additional typedoc improvements (#2961)

* docs: additional typedoc improvements

* more internals
---
 packages/maker/base/src/Maker.ts         | 1 +
 packages/plugin/base/src/Plugin.ts       | 1 +
 packages/publisher/base/src/Publisher.ts | 1 +
 packages/utils/types/src/index.ts        | 3 +++
 tools/gen-docs.ts                        | 5 ++++-
 5 files changed, 10 insertions(+), 1 deletion(-)

diff --git a/packages/maker/base/src/Maker.ts b/packages/maker/base/src/Maker.ts
index 49aa91687..35549718a 100644
--- a/packages/maker/base/src/Maker.ts
+++ b/packages/maker/base/src/Maker.ts
@@ -46,6 +46,7 @@ export default abstract class Maker<C> implements IForgeMaker {
 
   public requiredExternalBinaries: string[] = [];
 
+  /** @internal */
   __isElectronForgeMaker!: true;
 
   constructor(private configFetcher: C | ((arch: ForgeArch) => C) = {} as C, protected providedPlatforms?: ForgePlatform[]) {
diff --git a/packages/plugin/base/src/Plugin.ts b/packages/plugin/base/src/Plugin.ts
index ac167437c..38dcade95 100644
--- a/packages/plugin/base/src/Plugin.ts
+++ b/packages/plugin/base/src/Plugin.ts
@@ -5,6 +5,7 @@ export { StartOptions };
 export default abstract class Plugin<C> implements IForgePlugin {
   public abstract name: string;
 
+  /** @internal */
   __isElectronForgePlugin!: true;
 
   constructor(public config: C) {
diff --git a/packages/publisher/base/src/Publisher.ts b/packages/publisher/base/src/Publisher.ts
index 83bc6421b..634b0c5f8 100644
--- a/packages/publisher/base/src/Publisher.ts
+++ b/packages/publisher/base/src/Publisher.ts
@@ -22,6 +22,7 @@ export default abstract class Publisher<C> implements IForgePublisher {
 
   public defaultPlatforms?: ForgePlatform[];
 
+  /** @internal */
   __isElectronForgePublisher!: true;
 
   constructor(public config: C, protected providedPlatforms?: ForgePlatform[]) {
diff --git a/packages/utils/types/src/index.ts b/packages/utils/types/src/index.ts
index ce4960f70..c5faf6f40 100644
--- a/packages/utils/types/src/index.ts
+++ b/packages/utils/types/src/index.ts
@@ -60,6 +60,7 @@ export interface ForgeMakeResult {
 }
 
 export interface IForgePlugin {
+  /** @internal */
   __isElectronForgePlugin: boolean;
   name: string;
 
@@ -76,6 +77,7 @@ export interface IForgeResolvableMaker {
 }
 
 export interface IForgeMaker {
+  /** @internal */
   __isElectronForgeMaker: boolean;
   readonly platforms?: ForgePlatform[];
 }
@@ -87,6 +89,7 @@ export interface IForgeResolvablePublisher {
 }
 
 export interface IForgePublisher {
+  /** @internal */
   __isElectronForgePublisher: boolean;
   readonly platforms?: ForgePlatform[];
 }
diff --git a/tools/gen-docs.ts b/tools/gen-docs.ts
index f52ea0118..ea7445a83 100644
--- a/tools/gen-docs.ts
+++ b/tools/gen-docs.ts
@@ -10,10 +10,13 @@ import * as typedoc from 'typedoc';
     entryPointStrategy: 'packages',
     entryPoints: packages.map((pkg) => pkg.path),
     excludeExternals: true,
+    excludeInternal: true,
     excludePrivate: true,
     excludeProtected: true,
-    hideGenerator: true,
     externalPattern: ['**/node_modules/@types/node/**'],
+    hideGenerator: true,
+    includeVersion: true,
+    name: 'Electron Forge',
     plugin: ['typedoc-plugin-rename-defaults', 'typedoc-plugin-missing-exports'],
   });