Peer, NioClient, BlockingClientManager: fix some JavaDoc errors

This commit is contained in:
Andreas Schildbach 2023-03-10 22:42:17 +01:00
parent 7e70541658
commit d25c77cf24
3 changed files with 7 additions and 7 deletions

View file

@ -204,7 +204,7 @@ public class Peer extends PeerSocketHandler {
* connection. If you want to create a one-off connection, create a Peer and pass it to
* {@link NioClientManager#openConnection(SocketAddress, StreamConnection)}
* or
* {@link NioClient#NioClient(SocketAddress, StreamConnection, int)}.</p>
* {@link NioClient#NioClient(SocketAddress, StreamConnection, Duration)}.</p>
*
* <p>The remoteAddress provided should match the remote address of the peer which is being connected to, and is
* used to keep track of which peers relayed transactions and offer more descriptive logging.</p>
@ -223,7 +223,7 @@ public class Peer extends PeerSocketHandler {
* connection. If you want to create a one-off connection, create a Peer and pass it to
* {@link NioClientManager#openConnection(SocketAddress, StreamConnection)}
* or
* {@link NioClient#NioClient(SocketAddress, StreamConnection, int)}.</p>
* {@link NioClient#NioClient(SocketAddress, StreamConnection, Duration)}.</p>
*
* <p>The remoteAddress provided should match the remote address of the peer which is being connected to, and is
* used to keep track of which peers relayed transactions and offer more descriptive logging.</p>
@ -257,7 +257,7 @@ public class Peer extends PeerSocketHandler {
* connection. If you want to create a one-off connection, create a Peer and pass it to
* {@link NioClientManager#openConnection(SocketAddress, StreamConnection)}
* or
* {@link NioClient#NioClient(SocketAddress, StreamConnection, int)}.</p>
* {@link NioClient#NioClient(SocketAddress, StreamConnection, Duration)}.</p>
*
* <p>The remoteAddress provided should match the remote address of the peer which is being connected to, and is
* used to keep track of which peers relayed transactions and offer more descriptive logging.</p>

View file

@ -68,7 +68,7 @@ public class BlockingClientManager extends AbstractIdleService implements Client
/**
* Sets the number of milliseconds to wait before giving up on a connect attempt
* @param timeout timeout for establishing a connection to the client
* @param connectTimeout timeout for establishing a connection to the client
*/
public void setConnectTimeout(Duration connectTimeout) {
this.connectTimeout = connectTimeout;

View file

@ -107,9 +107,9 @@ public class NioClient implements MessageWriteTarget {
* The given connection <b>MUST</b> be unique to this object. This does not block while waiting for the connection to
* open, but will call either the {@link StreamConnection#connectionOpened()} or
* {@link StreamConnection#connectionClosed()} callback on the created network event processing thread.</p>
*
* @param connectTimeoutMillis The connect timeout set on the connection (in milliseconds). 0 is interpreted as no
* timeout.
* @param serverAddress socket address of the server to connect to
* @param parser parses data from the server
* @param connectTimeout timeout for establishing a connection to the server, or ZERO for no timeout
*/
public NioClient(final SocketAddress serverAddress, final StreamConnection parser,
final Duration connectTimeout) throws IOException {