You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tuweni.apache.org by to...@apache.org on 2019/04/23 23:09:18 UTC

[incubator-tuweni] 37/43: fix minor javadoc warnings

This is an automated email from the ASF dual-hosted git repository.

toulmean pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-tuweni.git

commit db0d167d6ded4daa6faf915b90c1a2bd9cab40ec
Author: lmccay <lm...@apache.org>
AuthorDate: Mon Apr 22 22:35:12 2019 -0400

    fix minor javadoc warnings
---
 .../tuweni/scuttlebutt/handshake/SecureScuttlebuttHandshakeClient.java   | 1 +
 .../apache/tuweni/scuttlebutt/handshake/vertx/ClientHandlerFactory.java  | 1 +
 .../tuweni/scuttlebutt/handshake/vertx/SecureScuttlebuttVertxClient.java | 1 +
 .../apache/tuweni/scuttlebutt/handshake/vertx/ServerHandlerFactory.java  | 1 +
 4 files changed, 4 insertions(+)

diff --git a/scuttlebutt-handshake/src/main/java/org/apache/tuweni/scuttlebutt/handshake/SecureScuttlebuttHandshakeClient.java b/scuttlebutt-handshake/src/main/java/org/apache/tuweni/scuttlebutt/handshake/SecureScuttlebuttHandshakeClient.java
index f07a428..8bc9e46 100644
--- a/scuttlebutt-handshake/src/main/java/org/apache/tuweni/scuttlebutt/handshake/SecureScuttlebuttHandshakeClient.java
+++ b/scuttlebutt-handshake/src/main/java/org/apache/tuweni/scuttlebutt/handshake/SecureScuttlebuttHandshakeClient.java
@@ -65,6 +65,7 @@ public final class SecureScuttlebuttHandshakeClient {
   /**
    * Create a new handshake client to connect to the server specified in the invite
    *
+   * @param networkIdentifier the networkIdentifier
    * @param invite the invite
    * @return a new Secure Scuttlebutt handshake client
    */
diff --git a/scuttlebutt-handshake/src/main/java/org/apache/tuweni/scuttlebutt/handshake/vertx/ClientHandlerFactory.java b/scuttlebutt-handshake/src/main/java/org/apache/tuweni/scuttlebutt/handshake/vertx/ClientHandlerFactory.java
index e947f49..3b04d5c 100644
--- a/scuttlebutt-handshake/src/main/java/org/apache/tuweni/scuttlebutt/handshake/vertx/ClientHandlerFactory.java
+++ b/scuttlebutt-handshake/src/main/java/org/apache/tuweni/scuttlebutt/handshake/vertx/ClientHandlerFactory.java
@@ -26,6 +26,7 @@ public interface ClientHandlerFactory {
    *
    * @param sender the function to send bytes to the server
    * @param terminationFunction a function to terminate the stream properly
+   * @return the created ClientHandler
    */
   ClientHandler createHandler(Consumer<Bytes> sender, Runnable terminationFunction);
 }
diff --git a/scuttlebutt-handshake/src/main/java/org/apache/tuweni/scuttlebutt/handshake/vertx/SecureScuttlebuttVertxClient.java b/scuttlebutt-handshake/src/main/java/org/apache/tuweni/scuttlebutt/handshake/vertx/SecureScuttlebuttVertxClient.java
index c7f69e5..242eedd 100644
--- a/scuttlebutt-handshake/src/main/java/org/apache/tuweni/scuttlebutt/handshake/vertx/SecureScuttlebuttVertxClient.java
+++ b/scuttlebutt-handshake/src/main/java/org/apache/tuweni/scuttlebutt/handshake/vertx/SecureScuttlebuttVertxClient.java
@@ -158,6 +158,7 @@ public final class SecureScuttlebuttVertxClient {
   /**
    * Default constructor.
    *
+   * @param loggerProvider the LoggerProvider
    * @param vertx the Vert.x instance
    * @param keyPair the identity of the server according to the Secure Scuttlebutt protocol
    * @param networkIdentifier the network identifier of the server according to the Secure Scuttlebutt protocol
diff --git a/scuttlebutt-handshake/src/main/java/org/apache/tuweni/scuttlebutt/handshake/vertx/ServerHandlerFactory.java b/scuttlebutt-handshake/src/main/java/org/apache/tuweni/scuttlebutt/handshake/vertx/ServerHandlerFactory.java
index cf9aaf8..987f3f7 100644
--- a/scuttlebutt-handshake/src/main/java/org/apache/tuweni/scuttlebutt/handshake/vertx/ServerHandlerFactory.java
+++ b/scuttlebutt-handshake/src/main/java/org/apache/tuweni/scuttlebutt/handshake/vertx/ServerHandlerFactory.java
@@ -26,6 +26,7 @@ public interface ServerHandlerFactory {
    *
    * @param sender the function to send bytes to the client
    * @param terminationFunction a function to terminate the stream properly
+   * @return the ServerHandler
    */
   ServerHandler createHandler(Consumer<Bytes> sender, Runnable terminationFunction);
 }


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@tuweni.apache.org
For additional commands, e-mail: commits-help@tuweni.apache.org