docs: additional typedoc improvements (#2961)

* docs: additional typedoc improvements

* more internals
This commit is contained in:
Erick Zhao 2022-10-13 00:40:48 -07:00 коммит произвёл GitHub
Родитель e22e5b2566
Коммит 6e2e0d4ae3
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
5 изменённых файлов: 10 добавлений и 1 удалений

Просмотреть файл

@ -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'],
});