Skip to content

Commit 6e2e0d4

Browse files
authored
docs: additional typedoc improvements (electron#2961)
* docs: additional typedoc improvements * more internals
1 parent e22e5b2 commit 6e2e0d4

File tree

5 files changed

+10
-1
lines changed

5 files changed

+10
-1
lines changed

packages/maker/base/src/Maker.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ export default abstract class Maker<C> implements IForgeMaker {
4646

4747
public requiredExternalBinaries: string[] = [];
4848

49+
/** @internal */
4950
__isElectronForgeMaker!: true;
5051

5152
constructor(private configFetcher: C | ((arch: ForgeArch) => C) = {} as C, protected providedPlatforms?: ForgePlatform[]) {

packages/plugin/base/src/Plugin.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ export { StartOptions };
55
export default abstract class Plugin<C> implements IForgePlugin {
66
public abstract name: string;
77

8+
/** @internal */
89
__isElectronForgePlugin!: true;
910

1011
constructor(public config: C) {

packages/publisher/base/src/Publisher.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ export default abstract class Publisher<C> implements IForgePublisher {
2222

2323
public defaultPlatforms?: ForgePlatform[];
2424

25+
/** @internal */
2526
__isElectronForgePublisher!: true;
2627

2728
constructor(public config: C, protected providedPlatforms?: ForgePlatform[]) {

packages/utils/types/src/index.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ export interface ForgeMakeResult {
6060
}
6161

6262
export interface IForgePlugin {
63+
/** @internal */
6364
__isElectronForgePlugin: boolean;
6465
name: string;
6566

@@ -76,6 +77,7 @@ export interface IForgeResolvableMaker {
7677
}
7778

7879
export interface IForgeMaker {
80+
/** @internal */
7981
__isElectronForgeMaker: boolean;
8082
readonly platforms?: ForgePlatform[];
8183
}
@@ -87,6 +89,7 @@ export interface IForgeResolvablePublisher {
8789
}
8890

8991
export interface IForgePublisher {
92+
/** @internal */
9093
__isElectronForgePublisher: boolean;
9194
readonly platforms?: ForgePlatform[];
9295
}

tools/gen-docs.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,13 @@ import * as typedoc from 'typedoc';
1010
entryPointStrategy: 'packages',
1111
entryPoints: packages.map((pkg) => pkg.path),
1212
excludeExternals: true,
13+
excludeInternal: true,
1314
excludePrivate: true,
1415
excludeProtected: true,
15-
hideGenerator: true,
1616
externalPattern: ['**/node_modules/@types/node/**'],
17+
hideGenerator: true,
18+
includeVersion: true,
19+
name: 'Electron Forge',
1720
plugin: ['typedoc-plugin-rename-defaults', 'typedoc-plugin-missing-exports'],
1821
});
1922

0 commit comments

Comments
 (0)