Skip to content

Commit

Permalink
use @link jsdoc syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
mmaietta committed Sep 13, 2024
1 parent 99128d6 commit 31eee78
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions packages/app-builder-lib/src/options/winOptions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,29 +25,29 @@ export interface WindowsConfiguration extends PlatformSpecificBuildOptions {

/**
* Array of signing algorithms used. For AppX `sha256` is always used.
* @deprecated Please use win.signtoolOptions.signingHashAlgorithms
* @deprecated Please use {@link signtoolOptions.signingHashAlgorithms}
*/
readonly signingHashAlgorithms?: Array<"sha1" | "sha256"> | null
/**
* The custom function (or path to file or module id) to sign Windows executables
* @deprecated Please use win.signtoolOptions.sign
* @deprecated Please use {@link signtoolOptions.sign}
*/
readonly sign?: CustomWindowsSign | string | null
/**
* The path to the *.pfx certificate you want to sign with. Please use it only if you cannot use env variable `CSC_LINK` (`WIN_CSC_LINK`) for some reason.
* Please see [Code Signing](/code-signing).
* @deprecated Please use win.signtoolOptions.certificateFile
* @deprecated Please use {@link signtoolOptions.certificateFile}
*/
readonly certificateFile?: string | null
/**
* The password to the certificate provided in `certificateFile`. Please use it only if you cannot use env variable `CSC_KEY_PASSWORD` (`WIN_CSC_KEY_PASSWORD`) for some reason.
* Please see [Code Signing](/code-signing).
* @deprecated Please use win.signtoolOptions.certificatePassword
* @deprecated Please use {@link signtoolOptions.certificatePassword}
*/
readonly certificatePassword?: string | null
/**
* The name of the subject of the signing certificate, which is often labeled with the field name `issued to`. Required only for EV Code Signing and works only on Windows (or on macOS if [Parallels Desktop](https://www.parallels.com/products/desktop/) Windows 10 virtual machines exits).
* @deprecated Please use win.signtoolOptions.certificateSubjectName
* @deprecated Please use {@link signtoolOptions.certificateSubjectName}
*/
readonly certificateSubjectName?: string | null
/**
Expand All @@ -57,26 +57,26 @@ export interface WindowsConfiguration extends PlatformSpecificBuildOptions {
readonly certificateSha1?: string | null
/**
* The path to an additional certificate file you want to add to the signature block.
* @deprecated Please use win.signtoolOptions.additionalCertificateFile
* @deprecated Please use {@link signtoolOptions.additionalCertificateFile}
*/
readonly additionalCertificateFile?: string | null
/**
* The URL of the RFC 3161 time stamp server.
* @default http://timestamp.digicert.com
* @deprecated Please use win.signtoolOptions.rfc3161TimeStampServer
* @deprecated Please use {@link signtoolOptions.rfc3161TimeStampServer}
*/
readonly rfc3161TimeStampServer?: string | null
/**
* The URL of the time stamp server.
* @default http://timestamp.digicert.com
* @deprecated Please use win.signtoolOptions.timeStampServer
* @deprecated Please use {@link signtoolOptions.timeStampServer}
*/
readonly timeStampServer?: string | null

/**
* [The publisher name](https:/electron-userland/electron-builder/issues/1187#issuecomment-278972073), exactly as in your code signed certificate. Several names can be provided.
* Defaults to common name from your code signing certificate.
* @deprecated Please use win.signtoolOptions.publisherName
* @deprecated Please use {@link signtoolOptions.publisherName}
*/
readonly publisherName?: string | Array<string> | null

Expand Down Expand Up @@ -115,7 +115,7 @@ export interface WindowsConfiguration extends PlatformSpecificBuildOptions {
* Whether to sign DLL files. Advanced option.
* @see https:/electron-userland/electron-builder/issues/3101#issuecomment-404212384
* @default false
* @deprecated Use `signExts` instead for more explicit control
* @deprecated Use {@link signExts} instead for more explicit control
*/
readonly signDlls?: boolean

Expand Down

0 comments on commit 31eee78

Please sign in to comment.