You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by ta...@apache.org on 2021/05/04 17:21:40 UTC
[qpid-protonj2] 01/02: Additional fixes for javadocs warnings
spotted in CI
This is an automated email from the ASF dual-hosted git repository.
tabish pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/qpid-protonj2.git
commit ed0b15975140afd95522b6e8833ad64ee5611659
Author: Timothy Bish <ta...@gmail.com>
AuthorDate: Tue May 4 13:10:45 2021 -0400
Additional fixes for javadocs warnings spotted in CI
---
.../java/org/apache/qpid/protonj2/client/OutputStreamOptions.java | 1 +
.../test/driver/matchers/messaging/AbstractMessageSectionMatcher.java | 3 +++
.../src/main/java/org/apache/qpid/protonj2/codec/StreamDecoder.java | 4 ++--
.../org/apache/qpid/protonj2/codec/decoders/ProtonDecoderState.java | 2 ++
.../apache/qpid/protonj2/codec/decoders/ProtonStreamDecoderState.java | 3 +++
.../org/apache/qpid/protonj2/codec/encoders/ProtonEncoderState.java | 2 ++
.../main/java/org/apache/qpid/protonj2/engine/IncomingDelivery.java | 2 +-
.../main/java/org/apache/qpid/protonj2/engine/OutgoingDelivery.java | 4 ++--
8 files changed, 16 insertions(+), 5 deletions(-)
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/OutputStreamOptions.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/OutputStreamOptions.java
index 6cf756e..5dc2da1 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/OutputStreamOptions.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/OutputStreamOptions.java
@@ -91,6 +91,7 @@ public class OutputStreamOptions {
* caller.
*
* @param streamSize
+ * The fixed number of bytes that must be written in order for the stream to be complete.
*
* @return this {@link OutputStreamOptions} instance.
*/
diff --git a/protonj2-test-driver/src/main/java/org/apache/qpid/protonj2/test/driver/matchers/messaging/AbstractMessageSectionMatcher.java b/protonj2-test-driver/src/main/java/org/apache/qpid/protonj2/test/driver/matchers/messaging/AbstractMessageSectionMatcher.java
index 791beeb..d5b74e3 100644
--- a/protonj2-test-driver/src/main/java/org/apache/qpid/protonj2/test/driver/matchers/messaging/AbstractMessageSectionMatcher.java
+++ b/protonj2-test-driver/src/main/java/org/apache/qpid/protonj2/test/driver/matchers/messaging/AbstractMessageSectionMatcher.java
@@ -132,6 +132,9 @@ public abstract class AbstractMessageSectionMatcher {
* Intended to be overridden in most cases that use the above method (but
* not necessarily all - hence not marked as abstract)
*
+ * @param fieldIndex
+ * the field index in the list of section fields whose {@link Enum} constant is being looked up.
+ *
* @return the field enumeration value mapped to the provided index.
*/
protected Enum<?> getField(int fieldIndex) {
diff --git a/protonj2/src/main/java/org/apache/qpid/protonj2/codec/StreamDecoder.java b/protonj2/src/main/java/org/apache/qpid/protonj2/codec/StreamDecoder.java
index e79738c..c7aae5b 100644
--- a/protonj2/src/main/java/org/apache/qpid/protonj2/codec/StreamDecoder.java
+++ b/protonj2/src/main/java/org/apache/qpid/protonj2/codec/StreamDecoder.java
@@ -176,7 +176,7 @@ public interface StreamDecoder {
*
* @return a {@link StreamTypeDecoder} instance that can read the next type in the buffer.
*
- * @throws DecodeException
+ * @throws DecodeException if an error occurs while reading the next type decoder.
*/
StreamTypeDecoder<?> readNextTypeDecoder(InputStream stream, StreamDecoderState state) throws DecodeException;
@@ -195,7 +195,7 @@ public interface StreamDecoder {
*
* @return a {@link TypeDecoder} instance that can provide insight into the next type in the stream.
*
- * @throws DecodeException if an error occurs during decoding.
+ * @throws DecodeException if an error occurs while peeking ahead for the next type decoder.
*/
StreamTypeDecoder<?> peekNextTypeDecoder(InputStream stream, StreamDecoderState state) throws DecodeException;
diff --git a/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/ProtonDecoderState.java b/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/ProtonDecoderState.java
index 6278b4d..de33785 100644
--- a/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/ProtonDecoderState.java
+++ b/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/ProtonDecoderState.java
@@ -43,7 +43,9 @@ public final class ProtonDecoderState implements DecoderState {
/**
* Create a new {@link DecoderState} instance that is joined forever to the given {@link Decoder}.
+ *
* @param decoder
+ * The {@link Decoder} that this state instance is assigned to.
*/
public ProtonDecoderState(ProtonDecoder decoder) {
this.decoder = decoder;
diff --git a/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/ProtonStreamDecoderState.java b/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/ProtonStreamDecoderState.java
index 0571ffa..6faa418 100644
--- a/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/ProtonStreamDecoderState.java
+++ b/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/ProtonStreamDecoderState.java
@@ -28,6 +28,7 @@ import java.nio.charset.StandardCharsets;
import org.apache.qpid.protonj2.codec.DecodeException;
import org.apache.qpid.protonj2.codec.Decoder;
+import org.apache.qpid.protonj2.codec.StreamDecoder;
import org.apache.qpid.protonj2.codec.StreamDecoderState;
/**
@@ -45,7 +46,9 @@ public final class ProtonStreamDecoderState implements StreamDecoderState {
/**
* Create a new {@link StreamDecoderState} instance that is joined forever to the given {@link Decoder}.
+ *
* @param decoder
+ * The {@link StreamDecoder} that this state instance is assigned to.
*/
public ProtonStreamDecoderState(ProtonStreamDecoder decoder) {
this.decoder = decoder;
diff --git a/protonj2/src/main/java/org/apache/qpid/protonj2/codec/encoders/ProtonEncoderState.java b/protonj2/src/main/java/org/apache/qpid/protonj2/codec/encoders/ProtonEncoderState.java
index d226587..4fb066e 100644
--- a/protonj2/src/main/java/org/apache/qpid/protonj2/codec/encoders/ProtonEncoderState.java
+++ b/protonj2/src/main/java/org/apache/qpid/protonj2/codec/encoders/ProtonEncoderState.java
@@ -31,7 +31,9 @@ public final class ProtonEncoderState implements EncoderState {
/**
* Creates a new {@link ProtonEncoderState} that is linked to the given {@link ProtonEncoder}.
+ *
* @param encoder
+ * The {@link Encoder} that this encoder state instance is assigned to.
*/
public ProtonEncoderState(ProtonEncoder encoder) {
this.encoder = encoder;
diff --git a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/IncomingDelivery.java b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/IncomingDelivery.java
index 7723fc5..3ac0c10 100644
--- a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/IncomingDelivery.java
+++ b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/IncomingDelivery.java
@@ -163,7 +163,7 @@ public interface IncomingDelivery {
/**
* Gets the message-format for this Delivery, representing the 32bit value using an int.
* <p>
- * The default value is 0 as per the message format defined in the core AMQP 1.0 specification.<p>
+ * The default value is 0 as per the message format defined in the core AMQP 1.0 specification.
* <p>
* See the following for more details:<br>
* <a href="http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-transport-v1.0-os.html#type-transfer">
diff --git a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/OutgoingDelivery.java b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/OutgoingDelivery.java
index 14152a3..ed6a3a0 100644
--- a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/OutgoingDelivery.java
+++ b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/OutgoingDelivery.java
@@ -70,7 +70,7 @@ public interface OutgoingDelivery {
/**
* Gets the message-format for this Delivery, representing the 32bit value using an int.
* <p>
- * The default value is 0 as per the message format defined in the core AMQP 1.0 specification.<p>
+ * The default value is 0 as per the message format defined in the core AMQP 1.0 specification.
* <p>
* See the following for more details:<br>
* <a href="http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-transport-v1.0-os.html#type-transfer">
@@ -91,7 +91,7 @@ public interface OutgoingDelivery {
* only be set@Override prior to the first {@link Transfer} of delivery payload having been written. If one of the delivery
* write methods is called prior to the message format being set then it defaults to the AMQP default format of zero.
* <p>
- * The default value is 0 as per the message format defined in the core AMQP 1.0 specification.<p>
+ * The default value is 0 as per the message format defined in the core AMQP 1.0 specification.
* <p>
* See the following for more details:<br>
* <a href="http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-transport-v1.0-os.html#type-transfer">
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org