From 17f90eb721600c95a89b76deaa96edf87fb4c1e5 Mon Sep 17 00:00:00 2001
From: Paul Schaub <vanitasvitae@fsfe.org>
Date: Thu, 29 Sep 2022 13:14:32 +0200
Subject: [PATCH] Convert links in javadoc to html

---
 .../java/org/pgpainless/algorithm/PublicKeyAlgorithm.java   | 6 +++---
 .../decryption_verification/MissingPublicKeyCallback.java   | 4 +++-
 .../key/util/PublicKeyParameterValidationUtil.java          | 2 +-
 .../test/java/org/bouncycastle/PGPPublicKeyRingTest.java    | 2 +-
 .../src/test/java/org/pgpainless/key/WeirdKeys.java         | 2 +-
 .../key/generation/GenerateWithEmptyPassphraseTest.java     | 2 +-
 6 files changed, 10 insertions(+), 8 deletions(-)

diff --git a/pgpainless-core/src/main/java/org/pgpainless/algorithm/PublicKeyAlgorithm.java b/pgpainless-core/src/main/java/org/pgpainless/algorithm/PublicKeyAlgorithm.java
index baa8f92e..c7599db9 100644
--- a/pgpainless-core/src/main/java/org/pgpainless/algorithm/PublicKeyAlgorithm.java
+++ b/pgpainless-core/src/main/java/org/pgpainless/algorithm/PublicKeyAlgorithm.java
@@ -28,7 +28,7 @@ public enum PublicKeyAlgorithm {
     /**
      * RSA with usage encryption.
      *
-     * @deprecated see https://tools.ietf.org/html/rfc4880#section-13.5
+     * @deprecated see <a href="https://tools.ietf.org/html/rfc4880#section-13.5">Deprecation notice</a>
      */
     @Deprecated
     RSA_ENCRYPT     (PublicKeyAlgorithmTags.RSA_ENCRYPT, false, true),
@@ -36,7 +36,7 @@ public enum PublicKeyAlgorithm {
     /**
      * RSA with usage of creating signatures.
      *
-     * @deprecated see https://tools.ietf.org/html/rfc4880#section-13.5
+     * @deprecated see <a href="https://tools.ietf.org/html/rfc4880#section-13.5">Deprecation notice</a>
      */
     @Deprecated
     RSA_SIGN        (PublicKeyAlgorithmTags.RSA_SIGN, true, false),
@@ -71,7 +71,7 @@ public enum PublicKeyAlgorithm {
     /**
      * ElGamal General.
      *
-     * @deprecated see https://tools.ietf.org/html/rfc4880#section-13.8
+     * @deprecated see <a href="https://tools.ietf.org/html/rfc4880#section-13.8">Deprecation notice</a>
      */
     @Deprecated
     ELGAMAL_GENERAL (PublicKeyAlgorithmTags.ELGAMAL_GENERAL, true, true),
diff --git a/pgpainless-core/src/main/java/org/pgpainless/decryption_verification/MissingPublicKeyCallback.java b/pgpainless-core/src/main/java/org/pgpainless/decryption_verification/MissingPublicKeyCallback.java
index f3eb949b..9b6f4a1e 100644
--- a/pgpainless-core/src/main/java/org/pgpainless/decryption_verification/MissingPublicKeyCallback.java
+++ b/pgpainless-core/src/main/java/org/pgpainless/decryption_verification/MissingPublicKeyCallback.java
@@ -20,11 +20,13 @@ public interface MissingPublicKeyCallback {
      * you may not only search for the key-id on the key rings primary key!
      *
      * It would be super cool to provide the OpenPgp fingerprint here, but unfortunately one-pass-signatures
-     * only contain the key id (see https://datatracker.ietf.org/doc/html/rfc4880#section-5.4)
+     * only contain the key id.
      *
      * @param keyId ID of the missing signing (sub)key
      *
      * @return keyring containing the key or null
+     *
+     * @see <a href="https://datatracker.ietf.org/doc/html/rfc4880#section-5.4">RFC</a>
      */
     @Nullable PGPPublicKeyRing onMissingPublicKeyEncountered(@Nonnull Long keyId);
 
diff --git a/pgpainless-core/src/main/java/org/pgpainless/key/util/PublicKeyParameterValidationUtil.java b/pgpainless-core/src/main/java/org/pgpainless/key/util/PublicKeyParameterValidationUtil.java
index d3c7fe68..69940691 100644
--- a/pgpainless-core/src/main/java/org/pgpainless/key/util/PublicKeyParameterValidationUtil.java
+++ b/pgpainless-core/src/main/java/org/pgpainless/key/util/PublicKeyParameterValidationUtil.java
@@ -237,7 +237,7 @@ public class PublicKeyParameterValidationUtil {
      * Validate ElGamal public key parameters.
      *
      * Original implementation by the openpgpjs authors:
-     * https://github.com/openpgpjs/openpgpjs/blob/main/src/crypto/public_key/elgamal.js#L76-L143
+     * <a href="https://github.com/openpgpjs/openpgpjs/blob/main/src/crypto/public_key/elgamal.js#L76-L143>OpenPGP.js source</a>
      * @param secretKey secret key
      * @param publicKey public key
      * @return true if supposedly valid, false if invalid
diff --git a/pgpainless-core/src/test/java/org/bouncycastle/PGPPublicKeyRingTest.java b/pgpainless-core/src/test/java/org/bouncycastle/PGPPublicKeyRingTest.java
index 411e81e5..ebb344b0 100644
--- a/pgpainless-core/src/test/java/org/bouncycastle/PGPPublicKeyRingTest.java
+++ b/pgpainless-core/src/test/java/org/bouncycastle/PGPPublicKeyRingTest.java
@@ -28,7 +28,7 @@ public class PGPPublicKeyRingTest {
      * Learning test to see if BC also makes userids available on subkeys.
      * It does not.
      *
-     * see also https://security.stackexchange.com/questions/92635/is-it-possible-to-assign-different-uids-to-subkeys-for-the-purpose-of-having-mul
+     * @see <a href="https://security.stackexchange.com/questions/92635/is-it-possible-to-assign-different-uids-to-subkeys-for-the-purpose-of-having-mul>Stackexchange link</a>
      */
     @Test
     public void subkeysDoNotHaveUserIDsTest() throws InvalidAlgorithmParameterException, NoSuchAlgorithmException, PGPException {
diff --git a/pgpainless-core/src/test/java/org/pgpainless/key/WeirdKeys.java b/pgpainless-core/src/test/java/org/pgpainless/key/WeirdKeys.java
index b02b07c5..7500bab4 100644
--- a/pgpainless-core/src/test/java/org/pgpainless/key/WeirdKeys.java
+++ b/pgpainless-core/src/test/java/org/pgpainless/key/WeirdKeys.java
@@ -13,7 +13,7 @@ import org.pgpainless.PGPainless;
  * This class contains a set of slightly out of spec or weird keys.
  * Those are used to test whether implementations behave correctly when dealing with such keys.
  *
- * Original source: https://gitlab.com/sequoia-pgp/weird-keys
+ * @see <a href="https://gitlab.com/sequoia-pgp/weird-keys">Original Source</a>
  */
 public class WeirdKeys {
 
diff --git a/pgpainless-core/src/test/java/org/pgpainless/key/generation/GenerateWithEmptyPassphraseTest.java b/pgpainless-core/src/test/java/org/pgpainless/key/generation/GenerateWithEmptyPassphraseTest.java
index dbb3f49b..c1375883 100644
--- a/pgpainless-core/src/test/java/org/pgpainless/key/generation/GenerateWithEmptyPassphraseTest.java
+++ b/pgpainless-core/src/test/java/org/pgpainless/key/generation/GenerateWithEmptyPassphraseTest.java
@@ -20,7 +20,7 @@ import org.pgpainless.util.TestAllImplementations;
 import org.pgpainless.util.Passphrase;
 
 /**
- * Reproduce behavior of https://github.com/pgpainless/pgpainless/issues/16
+ * Reproduce behavior of <a href="https://github.com/pgpainless/pgpainless/issues/16>this issue</a>
  * and verify that the fix is working.
  *
  * The issue is that the implementation of {@link Passphrase#emptyPassphrase()} would set the underlying