PGPainless/pgpainless
PGPainless/pgpainless
1
0
Fork 0
mirror of https://github.com/pgpainless/pgpainless.git synced 2024-12-25 04:17:59 +01:00
Code Issues Releases Wiki Activity

Small documentation additions

Browse source
This commit is contained in:
Paul Schaub 2024-02-21 12:19:18 +01:00
parent d6aa003008
commit 902d5f2973
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
pgpainless-core/src/main/kotlin/org/pgpainless/key/generation/OpenPgpKeyGenerator.kt
View file

@ -138,10 +138,14 @@ internal constructor(val policy: Policy, val creationTime: Date, val preferences
): PGPKeyPair ): PGPKeyPair
/** /**
* Define the primary key for the OpenPGP key. Example: * Define the primary key for the OpenPGP key.
* The [applyToPrimaryKey] function block can be used to add UserIDs and preferences to
* the key.
* Example:
* ``` * ```
* setPrimaryKey(KeyType.EDDSA(EdDSACurve._Ed25519)) { * setPrimaryKey(KeyType.EDDSA(EdDSACurve._Ed25519)) {
* addUserId("Alice <alice@example.com>") * addDirectKeySignature(...)
* addUserId("Alice <alice@example.com>") // first user-id is primary
* addUserId("Bob <bob@example.com>") * addUserId("Bob <bob@example.com>")
* } * }
* ``` * ```