From 15fea6f02ff0c40bd88355b55c6530f89837c447 Mon Sep 17 00:00:00 2001 From: "Jason A. Donenfeld" Date: Tue, 20 Oct 2020 16:31:40 +0200 Subject: [PATCH] tunnel: clean up some docstring wording Signed-off-by: Jason A. Donenfeld --- .../java/com/wireguard/android/backend/WgQuickBackend.java | 3 ++- tunnel/src/main/java/com/wireguard/crypto/Curve25519.java | 2 +- tunnel/src/main/java/com/wireguard/crypto/Ed25519.java | 4 +++- 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. *

* 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. + * + *

This implementation is based on the ed25519/ref10 implementation in NaCl.

* *

It implements this twisted Edwards curve: *