Skip to content

Commit eb185ef

Browse files
committed
Squash a few Javadoc warnings
1 parent 750388d commit eb185ef

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

src/main/java/com/rabbitmq/stream/BackOffDelayPolicy.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public interface BackOffDelayPolicy {
3232
* A policy with a constant delay.
3333
*
3434
* @param delay
35-
* @return
35+
* @return the constant delay policy
3636
*/
3737
static BackOffDelayPolicy fixed(Duration delay) {
3838
return new FixedWithInitialDelayBackOffPolicy(delay, delay);
@@ -43,7 +43,7 @@ static BackOffDelayPolicy fixed(Duration delay) {
4343
*
4444
* @param initialDelay
4545
* @param delay
46-
* @return
46+
* @return the policy with an initial delay
4747
*/
4848
static BackOffDelayPolicy fixedWithInitialDelay(Duration initialDelay, Duration delay) {
4949
return new FixedWithInitialDelayBackOffPolicy(initialDelay, delay);
@@ -55,7 +55,7 @@ static BackOffDelayPolicy fixedWithInitialDelay(Duration initialDelay, Duration
5555
* @param initialDelay
5656
* @param delay
5757
* @param timeout
58-
* @return
58+
* @return the policy with an initial delay
5959
*/
6060
static BackOffDelayPolicy fixedWithInitialDelay(
6161
Duration initialDelay, Duration delay, Duration timeout) {

src/main/java/com/rabbitmq/stream/EnvironmentBuilder.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,7 @@ interface TlsConfiguration {
329329
* <p>Use {@link SslContextBuilder#forClient()} to configure and create an instance.
330330
*
331331
* @param sslContext
332-
* @return
332+
* @return the TLS configuration helper
333333
*/
334334
TlsConfiguration sslContext(SslContext sslContext);
335335

src/main/java/com/rabbitmq/stream/MessageHandler.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ interface Context {
3636
/**
3737
* The offset of the message in the stream.
3838
*
39-
* @return
39+
* @return the offset of the current message
4040
*/
4141
long offset();
4242

@@ -50,7 +50,7 @@ interface Context {
5050
/**
5151
* The consumer that receives the message.
5252
*
53-
* @return
53+
* @return the consumer instance
5454
* @see Consumer#store(long)
5555
*/
5656
Consumer consumer();

src/main/java/com/rabbitmq/stream/sasl/SaslMechanism.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ public interface SaslMechanism {
2020
/**
2121
* The name of the SASL mechanism.
2222
*
23-
* @return
23+
* @return the name of the SASL mechanism
2424
*/
2525
String getName();
2626

src/main/java/com/rabbitmq/stream/sasl/UsernamePasswordCredentialsProvider.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@ public interface UsernamePasswordCredentialsProvider extends CredentialsProvider
2020
/**
2121
* The username
2222
*
23-
* @return
23+
* @return the username
2424
*/
2525
String getUsername();
2626

2727
/**
2828
* The password
2929
*
30-
* @return
30+
* @return the password
3131
*/
3232
String getPassword();
3333
}

0 commit comments

Comments
 (0)