summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorJason A. Donenfeld <Jason@zx2c4.com>2020-10-20 16:31:40 +0200
committerJason A. Donenfeld <Jason@zx2c4.com>2020-10-20 16:35:05 +0200
commit15fea6f02ff0c40bd88355b55c6530f89837c447 (patch)
tree1542e683b2ddd430ca3f77d11bdbc63e5cc1d370
parentcb2842e8ef39015086465eb6d9d219740c6d4e8d (diff)
tunnel: clean up some docstring wording
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
-rw-r--r--tunnel/src/main/java/com/wireguard/android/backend/WgQuickBackend.java3
-rw-r--r--tunnel/src/main/java/com/wireguard/crypto/Curve25519.java2
-rw-r--r--tunnel/src/main/java/com/wireguard/crypto/Ed25519.java4
3 files changed, 6 insertions, 3 deletions
diff --git a/tunnel/src/main/java/com/wireguard/android/backend/WgQuickBackend.java b/tunnel/src/main/java/com/wireguard/android/backend/WgQuickBackend.java
index e2d87653..711cdca4 100644
--- a/tunnel/src/main/java/com/wireguard/android/backend/WgQuickBackend.java
+++ b/tunnel/src/main/java/com/wireguard/android/backend/WgQuickBackend.java
@@ -34,7 +34,8 @@ import java.util.Set;
import androidx.annotation.Nullable;
/**
- * WireGuard backend that uses {@code wg-quick} to implement tunnel configuration.
+ * Implementation of {@link Backend} that uses the kernel module and {@code wg-quick} to provide
+ * WireGuard tunnels.
*/
@NonNullForAll
diff --git a/tunnel/src/main/java/com/wireguard/crypto/Curve25519.java b/tunnel/src/main/java/com/wireguard/crypto/Curve25519.java
index efc22d6e..b3856b99 100644
--- a/tunnel/src/main/java/com/wireguard/crypto/Curve25519.java
+++ b/tunnel/src/main/java/com/wireguard/crypto/Curve25519.java
@@ -13,7 +13,7 @@ import java.util.Arrays;
import androidx.annotation.Nullable;
/**
- * Implementation of the Curve25519 elliptic curve algorithm.
+ * Implementation of Curve25519 ECDH.
* <p>
* This implementation was imported to WireGuard from noise-java:
* https://github.com/rweather/noise-java
diff --git a/tunnel/src/main/java/com/wireguard/crypto/Ed25519.java b/tunnel/src/main/java/com/wireguard/crypto/Ed25519.java
index 9eccca19..a60babfb 100644
--- a/tunnel/src/main/java/com/wireguard/crypto/Ed25519.java
+++ b/tunnel/src/main/java/com/wireguard/crypto/Ed25519.java
@@ -13,7 +13,9 @@ import java.security.MessageDigest;
import java.util.Arrays;
/**
- * This implementation is based on the ed25519/ref10 implementation in NaCl.
+ * Implementation of Ed25519 signature verification.
+ *
+ * <p>This implementation is based on the ed25519/ref10 implementation in NaCl.</p>
*
* <p>It implements this twisted Edwards curve:
*