diff --git a/pgpainless-core/src/main/kotlin/org/pgpainless/key/generation/OpenPgpKeyGenerator.kt b/pgpainless-core/src/main/kotlin/org/pgpainless/key/generation/OpenPgpKeyGenerator.kt index 7449bb0c..72b27bff 100644 --- a/pgpainless-core/src/main/kotlin/org/pgpainless/key/generation/OpenPgpKeyGenerator.kt +++ b/pgpainless-core/src/main/kotlin/org/pgpainless/key/generation/OpenPgpKeyGenerator.kt @@ -138,10 +138,14 @@ internal constructor(val policy: Policy, val creationTime: Date, val preferences ): 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)) { - * addUserId("Alice ") + * addDirectKeySignature(...) + * addUserId("Alice ") // first user-id is primary * addUserId("Bob ") * } * ```