docs: additional typedoc improvements (#2961)
* docs: additional typedoc improvements * more internals
This commit is contained in:
Родитель
e22e5b2566
Коммит
6e2e0d4ae3
|
@ -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[]) {
|
||||
|
|
|
@ -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) {
|
||||
|
|
|
@ -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[]) {
|
||||
|
|
|
@ -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[];
|
||||
}
|
||||
|
|
|
@ -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'],
|
||||
});
|
||||
|
||||
|
|
Загрузка…
Ссылка в новой задаче