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

robbie pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/qpid-protonj2.git


The following commit(s) were added to refs/heads/main by this push:
     new bf3459a  fix some javadoc errors
bf3459a is described below

commit bf3459aa01d0537f8611a265c1fa362741b780f8
Author: Robbie Gemmell <robbie.gemm...@gmail.com>
AuthorDate: Thu Apr 22 14:48:17 2021 +0100

    fix some javadoc errors
---
 .../apache/qpid/protonj2/client/StreamSenderMessage.java  |  3 ---
 .../protonj2/client/impl/ClientTransactionContext.java    |  3 +--
 .../qpid/protonj2/types/transport/ConnectionError.java    | 11 +++++------
 .../apache/qpid/protonj2/types/transport/LinkError.java   | 15 +++++++--------
 4 files changed, 13 insertions(+), 19 deletions(-)

diff --git 
a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/StreamSenderMessage.java
 
b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/StreamSenderMessage.java
index 8cfbed3..15c89df 100644
--- 
a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/StreamSenderMessage.java
+++ 
b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/StreamSenderMessage.java
@@ -80,9 +80,6 @@ public interface StreamSenderMessage extends 
AdvancedMessage<OutputStream> {
      * Marks the currently streaming message as being aborted. Once aborted no 
further
      * writes regardless of whether any writes have yet been performed or not.
      *
-     * @param aborted
-     *      Should the message be marked as having been aborted.
-     *
      * @return this {@link StreamSenderMessage} instance.
      *
      * @throws ClientException if an error occurs while initiating the abort 
operation.
diff --git 
a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientTransactionContext.java
 
b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientTransactionContext.java
index b0af3de..be7c8c7 100644
--- 
a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientTransactionContext.java
+++ 
b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientTransactionContext.java
@@ -51,8 +51,7 @@ public interface ClientTransactionContext {
      * @param startNew
      *      Should the context immediately initiate a new transaction
      *
-     * @return this {@@Override
-    link ClientTransactionContext} instance.
+     * @return this {@link ClientTransactionContext} instance.
      *
      * @throws ClientIllegalStateException if an error occurs do to the 
transaction state.
      */
diff --git 
a/protonj2/src/main/java/org/apache/qpid/protonj2/types/transport/ConnectionError.java
 
b/protonj2/src/main/java/org/apache/qpid/protonj2/types/transport/ConnectionError.java
index b331e1b..8cbd8f7 100644
--- 
a/protonj2/src/main/java/org/apache/qpid/protonj2/types/transport/ConnectionError.java
+++ 
b/protonj2/src/main/java/org/apache/qpid/protonj2/types/transport/ConnectionError.java
@@ -35,20 +35,19 @@ public interface ConnectionError {
      * attempt reconnection to the container using the details provided in the 
info map.
      * <br>
      * <ul>
-     *   <li>hostname</li>
+     *   <li>hostname:
      *     <ul>
      *       <li>the hostname of the container hosting the terminus. This is 
the value that SHOULD be
      *           supplied in the hostname field of the open frame, and during 
SASL and TLS negotiation
      *           (if used).
-     *       </li>
      *     </ul>
-     *   <li>network-host</li>
+     *   <li>network-host:
      *     <ul>
-     *       <li>the DNS hostname or IP address of the machine hosting the 
container.</li>
+     *       <li>the DNS hostname or IP address of the machine hosting the 
container.
      *     </ul>
-     *   <li>port</li>
+     *   <li>port:
      *     <ul>
-     *       <li>the port number on the machine hosting the container.</li>
+     *       <li>the port number on the machine hosting the container.
      *     </ul>
      * </ul>
      */
diff --git 
a/protonj2/src/main/java/org/apache/qpid/protonj2/types/transport/LinkError.java
 
b/protonj2/src/main/java/org/apache/qpid/protonj2/types/transport/LinkError.java
index f2e31a9..533e390 100644
--- 
a/protonj2/src/main/java/org/apache/qpid/protonj2/types/transport/LinkError.java
+++ 
b/protonj2/src/main/java/org/apache/qpid/protonj2/types/transport/LinkError.java
@@ -40,24 +40,23 @@ public interface LinkError {
      * MAY contain the following information to allow the client to locate the 
attach to the terminus.
      * <br>
      * <ul>
-     *   <li>hostname</li>
+     *   <li>hostname:
      *     <ul>
      *       <li>the hostname of the container hosting the terminus. This is 
the value that SHOULD be
      *           supplied in the hostname field of the open frame, and during 
SASL and TLS negotiation
      *           (if used).
-     *       </li>
      *     </ul>
-     *   <li>network-host</li>
+     *   <li>network-host:
      *     <ul>
-     *       <li>the DNS hostname or IP address of the machine hosting the 
container.</li>
+     *       <li>the DNS hostname or IP address of the machine hosting the 
container.
      *     </ul>
-     *   <li>port</li>
+     *   <li>port:
      *     <ul>
-     *       <li>the port number on the machine hosting the container.</li>
+     *       <li>the port number on the machine hosting the container.
      *     </ul>
-     *   <li>address</li>
+     *   <li>address:
      *     <ul>
-     *       <li>the address of the terminus at the container.</li>
+     *       <li>the address of the terminus at the container.
      *     </ul>
      * </ul>
      */

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org
For additional commands, e-mail: commits-h...@qpid.apache.org

Reply via email to