Skip to content

Commit fa1c184

Browse files
committed
fix all javadoc warnings/errors
1 parent 8f38b89 commit fa1c184

File tree

4 files changed

+20
-20
lines changed

4 files changed

+20
-20
lines changed

src/com/rabbitmq/client/Channel.java

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -369,9 +369,9 @@ Exchange.DeclareOk exchangeDeclare(String exchange,
369369
* Bind an exchange to an exchange, with no extra arguments.
370370
* @see com.rabbitmq.client.AMQP.Exchange.Bind
371371
* @see com.rabbitmq.client.AMQP.Exchange.BindOk
372-
* @param destination: the name of the exchange to which messages flow across the binding
373-
* @param source: the name of the exchange from which messages flow across the binding
374-
* @param routingKey: the routine key to use for the binding
372+
* @param destination the name of the exchange to which messages flow across the binding
373+
* @param source the name of the exchange from which messages flow across the binding
374+
* @param routingKey the routine key to use for the binding
375375
* @return a binding-confirm method if the binding was successfully created
376376
* @throws java.io.IOException if an error is encountered
377377
*/
@@ -381,10 +381,10 @@ Exchange.DeclareOk exchangeDeclare(String exchange,
381381
* Bind an exchange to an exchange.
382382
* @see com.rabbitmq.client.AMQP.Exchange.Bind
383383
* @see com.rabbitmq.client.AMQP.Exchange.BindOk
384-
* @param destination: the name of the exchange to which messages flow across the binding
385-
* @param source: the name of the exchange from which messages flow across the binding
386-
* @param routingKey: the routine key to use for the binding
387-
* @param arguments: other properties (binding parameters)
384+
* @param destination the name of the exchange to which messages flow across the binding
385+
* @param source the name of the exchange from which messages flow across the binding
386+
* @param routingKey the routine key to use for the binding
387+
* @param arguments other properties (binding parameters)
388388
* @return a binding-confirm method if the binding was successfully created
389389
* @throws java.io.IOException if an error is encountered
390390
*/
@@ -394,9 +394,9 @@ Exchange.DeclareOk exchangeDeclare(String exchange,
394394
* Unbind an exchange from an exchange, with no extra arguments.
395395
* @see com.rabbitmq.client.AMQP.Exchange.Bind
396396
* @see com.rabbitmq.client.AMQP.Exchange.BindOk
397-
* @param destination: the name of the exchange to which messages flow across the binding
398-
* @param source: the name of the exchange from which messages flow across the binding
399-
* @param routingKey: the routine key to use for the binding
397+
* @param destination the name of the exchange to which messages flow across the binding
398+
* @param source the name of the exchange from which messages flow across the binding
399+
* @param routingKey the routine key to use for the binding
400400
* @return a binding-confirm method if the binding was successfully created
401401
* @throws java.io.IOException if an error is encountered
402402
*/
@@ -406,10 +406,10 @@ Exchange.DeclareOk exchangeDeclare(String exchange,
406406
* Unbind an exchange from an exchange.
407407
* @see com.rabbitmq.client.AMQP.Exchange.Bind
408408
* @see com.rabbitmq.client.AMQP.Exchange.BindOk
409-
* @param destination: the name of the exchange to which messages flow across the binding
410-
* @param source: the name of the exchange from which messages flow across the binding
411-
* @param routingKey: the routine key to use for the binding
412-
* @param arguments: other properties (binding parameters)
409+
* @param destination the name of the exchange to which messages flow across the binding
410+
* @param source the name of the exchange from which messages flow across the binding
411+
* @param routingKey the routine key to use for the binding
412+
* @param arguments other properties (binding parameters)
413413
* @return a binding-confirm method if the binding was successfully created
414414
* @throws java.io.IOException if an error is encountered
415415
*/

src/com/rabbitmq/client/ConnectionFactory.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@ public void setClientProperties(Map<String, Object> clientProperties) {
350350

351351
/**
352352
* Gets the sasl config to use when authenticating
353-
* @return
353+
* @return the sasl config
354354
* @see com.rabbitmq.client.SaslConfig
355355
*/
356356
public SaslConfig getSaslConfig() {

src/com/rabbitmq/client/SaslMechanism.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
public interface SaslMechanism {
2626
/**
2727
* The name of this mechanism (e.g. PLAIN)
28-
* @return
28+
* @return the name
2929
*/
3030
String getName();
3131

src/com/rabbitmq/tools/Tracer.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
* port (out-port). Relays frames from the in-port to the out-port.
4747
* Commands are decoded and printed to a supplied {@link Logger}.
4848
* <p/>
49-
* The stand-alone program ({@link #main()}) prints to <code>System.out</code>,
49+
* The stand-alone program ({@link #main(String[])}) prints to <code>System.out</code>,
5050
* using a private {@link AsyncLogger} instance. When the connection closes
5151
* the program listens for a subsequent connection and traces that to the same {@link Logger}.
5252
* This continues until the program is interrupted.
@@ -388,7 +388,7 @@ public interface Logger {
388388
* A {@link Tracer.Logger} designed to print {@link String}s to a designated {@link OutputStream}
389389
* on a private thread.
390390
* <p/>{@link String}s are read from a private queue and <i>printed</i> to a buffered {@link PrintStream}
391-
* which is periodically flushed, determined by a {@link #flushInterval}.
391+
* which is periodically flushed.
392392
* <p/>
393393
* When instantiated the private queue is created (an in-memory {@link ArrayBlockingQueue} in this
394394
* implementation) and when {@link #start()}ed the private thread is created and started unless it is
@@ -400,7 +400,7 @@ public interface Logger {
400400
* If the private thread is interrupted, the thread will also end, and the count set to zero,
401401
* This will cause subsequent {@link #stop()}s to be ignored, and the next {@link #start()} will create a new thread.
402402
* <p/>
403-
* {@link #log()} never blocks unless the private queue is full; this may never un-block if the {@link Logger} is stopped.
403+
* {@link #log(String)} never blocks unless the private queue is full; this may never un-block if the {@link Logger} is stopped.
404404
*/
405405
public static class AsyncLogger implements Logger {
406406
private static final int MIN_FLUSH_INTERVAL = 100;
@@ -435,7 +435,7 @@ private enum LogCmd {
435435
LOG_QUEUE_SIZE, true);
436436

437437
/**
438-
* Same as {@link #AsyncLogger(os, flushInterval)} with a one-second flush interval.
438+
* Same as {@link #Tracer.AsyncLogger(OutputStream, int)} with a one-second flush interval.
439439
* @param os OutputStream to print to.
440440
*/
441441
public AsyncLogger(OutputStream os) {

0 commit comments

Comments
 (0)