diff --git a/pgpainless-core/src/main/java/org/pgpainless/PGPainless.java b/pgpainless-core/src/main/java/org/pgpainless/PGPainless.java
index 1577abb7..2507aef9 100644
--- a/pgpainless-core/src/main/java/org/pgpainless/PGPainless.java
+++ b/pgpainless-core/src/main/java/org/pgpainless/PGPainless.java
@@ -111,7 +111,9 @@ public class PGPainless {
*
* @param data input data.
* @param password password.
+ * @param algorithm symmetric encryption algorithm.
* @return symmetrically OpenPGP encrypted data.
+ *
* @throws IOException IO is dangerous.
* @throws PGPException PGP is brittle.
*/
diff --git a/pgpainless-core/src/main/java/org/pgpainless/algorithm/SignatureType.java b/pgpainless-core/src/main/java/org/pgpainless/algorithm/SignatureType.java
index 0b3b6797..aaeb2038 100644
--- a/pgpainless-core/src/main/java/org/pgpainless/algorithm/SignatureType.java
+++ b/pgpainless-core/src/main/java/org/pgpainless/algorithm/SignatureType.java
@@ -22,7 +22,7 @@ import java.util.concurrent.ConcurrentHashMap;
* Enum that enlists all the Signature Types defined in rfc4880 section 5.2.1
* See {@link org.bouncycastle.openpgp.PGPSignature} for comparison.
*
- * @see rfc4880 §5.2.1. Signature Types
*/
public enum SignatureType {
@@ -37,7 +37,7 @@ public enum SignatureType {
* Signature of a canonical text document.
* This means the signer owns it, created it, or certifies that it
* has not been modified. The signature is calculated over the text
- * data with its line endings converted to .
+ * data with its line endings converted to {@code }.
*/
CANONICAL_TEXT_DOCUMENT(0x01),
diff --git a/pgpainless-core/src/main/java/org/pgpainless/key/generation/KeyRingBuilder.java b/pgpainless-core/src/main/java/org/pgpainless/key/generation/KeyRingBuilder.java
index 34b085fc..5fe553df 100644
--- a/pgpainless-core/src/main/java/org/pgpainless/key/generation/KeyRingBuilder.java
+++ b/pgpainless-core/src/main/java/org/pgpainless/key/generation/KeyRingBuilder.java
@@ -83,10 +83,6 @@ public class KeyRingBuilder implements KeyRingBuilderInterface {
* @param length length in bits.
*
* @return {@link PGPSecretKeyRing} containing the KeyPair.
- *
- * @throws PGPException
- * @throws NoSuchAlgorithmException
- * @throws InvalidAlgorithmParameterException
*/
public PGPKeyRing simpleRsaKeyRing(@Nonnull String userId, @Nonnull RsaLength length)
throws InvalidAlgorithmParameterException, NoSuchAlgorithmException, PGPException {
@@ -107,10 +103,6 @@ public class KeyRingBuilder implements KeyRingBuilderInterface {
* @param password Password of the key. Can be null for unencrypted keys.
*
* @return {@link PGPSecretKeyRing} containing the KeyPair.
- *
- * @throws PGPException
- * @throws NoSuchAlgorithmException
- * @throws InvalidAlgorithmParameterException
*/
public PGPKeyRing simpleRsaKeyRing(@Nonnull String userId, @Nonnull RsaLength length, String password)
throws PGPException, NoSuchAlgorithmException, InvalidAlgorithmParameterException {
@@ -141,10 +133,6 @@ public class KeyRingBuilder implements KeyRingBuilderInterface {
* @param userId user-id
*
* @return {@link PGPSecretKeyRing} containing the key pairs.
- *
- * @throws PGPException
- * @throws NoSuchAlgorithmException
- * @throws InvalidAlgorithmParameterException
*/
public PGPKeyRing simpleEcKeyRing(@Nonnull String userId)
throws InvalidAlgorithmParameterException, NoSuchAlgorithmException, PGPException {
@@ -165,10 +153,6 @@ public class KeyRingBuilder implements KeyRingBuilderInterface {
* @param password Password of the private key. Can be null for an unencrypted key.
*
* @return {@link PGPSecretKeyRing} containing the key pairs.
- *
- * @throws PGPException
- * @throws NoSuchAlgorithmException
- * @throws InvalidAlgorithmParameterException
*/
public PGPKeyRing simpleEcKeyRing(@Nonnull String userId, String password)
throws PGPException, NoSuchAlgorithmException, InvalidAlgorithmParameterException {
diff --git a/pgpainless-core/src/main/java/org/pgpainless/key/modification/secretkeyring/SecretKeyRingEditorInterface.java b/pgpainless-core/src/main/java/org/pgpainless/key/modification/secretkeyring/SecretKeyRingEditorInterface.java
index 36949aa4..b0f39591 100644
--- a/pgpainless-core/src/main/java/org/pgpainless/key/modification/secretkeyring/SecretKeyRingEditorInterface.java
+++ b/pgpainless-core/src/main/java/org/pgpainless/key/modification/secretkeyring/SecretKeyRingEditorInterface.java
@@ -43,6 +43,7 @@ public interface SecretKeyRingEditorInterface {
* Add a user-id to the primary key of the key ring.
*
* @param userId user-id
+ * @param secretKeyRingProtector protector to unlock the secret key
* @return the builder
*/
SecretKeyRingEditorInterface addUserId(String userId, SecretKeyRingProtector secretKeyRingProtector) throws PGPException;
@@ -65,6 +66,7 @@ public interface SecretKeyRingEditorInterface {
* Remove a user-id from the primary key of the key ring.
*
* @param userId exact user-id to be removed
+ * @param secretKeyRingProtector protector to unlock the secret key
* @return the builder
*/
SecretKeyRingEditorInterface deleteUserId(String userId, SecretKeyRingProtector secretKeyRingProtector);
@@ -80,6 +82,8 @@ public interface SecretKeyRingEditorInterface {
* The subkey will be generated from the provided {@link KeySpec}.
*
* @param keySpec key specification
+ * @param subKeyPassphrase passphrase to encrypt the sub key
+ * @param secretKeyRingProtector protector to unlock the secret key of the key ring
* @return the builder
*/
SecretKeyRingEditorInterface addSubKey(@Nonnull KeySpec keySpec,
@@ -96,6 +100,7 @@ public interface SecretKeyRingEditorInterface {
* If no suitable subkey is found, a {@link java.util.NoSuchElementException} will be thrown.
*
* @param fingerprint fingerprint of the subkey to be removed
+ * @param secretKeyRingProtector protector to unlock the secret key ring
* @return the builder
*/
SecretKeyRingEditorInterface deleteSubKey(OpenPgpV4Fingerprint fingerprint, SecretKeyRingProtector secretKeyRingProtector);
@@ -106,6 +111,7 @@ public interface SecretKeyRingEditorInterface {
* If no suitable subkey is found, a {@link java.util.NoSuchElementException} will be thrown.
*
* @param subKeyId id of the subkey
+ * @param secretKeyRingProtector protector to unlock the secret key ring
* @return the builder
*/
SecretKeyRingEditorInterface deleteSubKey(long subKeyId, SecretKeyRingProtector secretKeyRingProtector);
@@ -138,6 +144,7 @@ public interface SecretKeyRingEditorInterface {
* If no suitable subkey is found, a {@link java.util.NoSuchElementException} will be thrown.
*
* @param fingerprint fingerprint of the subkey to be revoked
+ * @param secretKeyRingProtector protector to unlock the secret key ring
* @return the builder
*/
default SecretKeyRingEditorInterface revokeSubKey(OpenPgpV4Fingerprint fingerprint,
@@ -167,6 +174,7 @@ public interface SecretKeyRingEditorInterface {
* If no suitable subkey is found, q {@link java.util.NoSuchElementException} will be thrown.
*
* @param subKeyId id of the subkey
+ * @param secretKeyRingProtector protector to unlock the secret key ring
* @return the builder
*/
default SecretKeyRingEditorInterface revokeSubKey(long subKeyId,