QPID-5980: yet more javadoc fixups

git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@1616796 13f79535-47bb-0310-9956-ffa450edef68

14 files changed, 40 insertions, 61 deletions

diff --git a/qpid/java/broker-core/src/main/java/org/apache/log4j/QpidCompositeRollingAppender.java b/qpid/java/broker-core/src/main/java/org/apache/log4j/QpidCompositeRollingAppender.java
index 1a34bd8063..dc7724bd71 100644
--- a/qpid/java/broker-core/src/main/java/org/apache/log4j/QpidCompositeRollingAppender.java
+++ b/qpid/java/broker-core/src/main/java/org/apache/log4j/QpidCompositeRollingAppender.java
@@ -51,7 +51,7 @@ import java.util.zip.GZIPOutputStream;
  * <p>A of few additional optional features have been added:<br> -- Attach date pattern for current log file (@see
  * staticLogFileName)<br> -- Backup number increments for newer files (@see countDirection)<br> -- Infinite number of
  * backups by file size (@see maxSizeRollBackups)<br> <br> <p>A few notes and warnings:  For large or infinite number of
- * backups countDirection > 0 is highly recommended, with staticLogFileName = false if time based rolling is also used
+ * backups countDirection {@literal >} 0 is highly recommended, with staticLogFileName = false if time based rolling is also used
  * -- this will reduce the number of file renamings to few or none.  Changing staticLogFileName or countDirection
  * without clearing the directory could have nasty side effects.  If Date/Time based rolling is enabled,
  * CompositeRollingAppender will attempt to roll existing files in the directory without a date/time tag based on the
@@ -358,9 +358,9 @@ public class QpidCompositeRollingAppender extends FileAppender
     }
 
     /**
-     * By default newer files have lower numbers. (countDirection < 0) ie. log.1 is most recent, log.5 is the 5th
-     * backup, etc... countDirection > 0 does the opposite ie. log.1 is the first backup made, log.5 is the 5th backup
-     * made, etc. For infinite backups use countDirection > 0 to reduce rollOver costs.
+     * By default newer files have lower numbers. (countDirection {@literal <} 0) ie. log.1 is most recent, log.5 is the 5th
+     * backup, etc... countDirection {@literal >} 0 does the opposite ie. log.1 is the first backup made, log.5 is the 5th backup
+     * made, etc. For infinite backups use countDirection {@literal >} 0 to reduce rollOver costs.
      */
     public int getCountDirection()
     {
@@ -686,9 +686,9 @@ public class QpidCompositeRollingAppender extends FileAppender
     /**
      * Implements roll overs base on file size.
      *
-     * <p>If the maximum number of size based backups is reached (<code>curSizeRollBackups == maxSizeRollBackups</code)
+     * <p>If the maximum number of size based backups is reached (<code>curSizeRollBackups {@literal ==} maxSizeRollBackups</code>)
      * then the oldest file is deleted -- it's index determined by the sign of countDirection.<br> If
-     * <code>countDirection</code> < 0, then files {<code>File.1</code>, ..., <code>File.curSizeRollBackups -1</code>}
+     * <code>countDirection</code> {@literal <} 0, then files {<code>File.1</code>, ..., <code>File.curSizeRollBackups -1</code>}
      * are renamed to {<code>File.2</code>, ..., <code>File.curSizeRollBackups</code>}.  Moreover, <code>File</code> is
      * renamed <code>File.1</code> and closed.<br>
      *
@@ -697,7 +697,7 @@ public class QpidCompositeRollingAppender extends FileAppender
      * <p>If <code>maxSizeRollBackups</code> is equal to zero, then the <code>File</code> is truncated with no backup
      * files created.
      *
-     * <p>If <code>maxSizeRollBackups</code> < 0, then <code>File</code> is renamed if needed and no files are deleted.
+     * <p>If <code>maxSizeRollBackups</code> {@literal <} 0, then <code>File</code> is renamed if needed and no files are deleted.
      */
 
     // synchronization not necessary since doAppend is already synched
diff --git a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/exchange/HeadersExchange.java b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/exchange/HeadersExchange.java
index 74c393c10f..83c6b9fd00 100644
--- a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/exchange/HeadersExchange.java
+++ b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/exchange/HeadersExchange.java
@@ -45,7 +45,7 @@ import org.apache.qpid.server.virtualhost.VirtualHostImpl;
  * An exchange that binds queues based on a set of required headers and header values
  * and routes messages to these queues by matching the headers of the message against
  * those with which the queues were bound.
- * <p/>
+ * <p>
  * <pre>
  * The Headers Exchange
  *
diff --git a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/logging/LogSubject.java b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/logging/LogSubject.java
index 09a277e520..462b45d678 100644
--- a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/logging/LogSubject.java
+++ b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/logging/LogSubject.java
@@ -30,7 +30,7 @@ public interface LogSubject
     /**
      * Provides the log message as as String.
      *
-     * @returns String the display representation of this LogSubject
+     * @return String the display representation of this LogSubject
      */
     public String toLogString();
 }
\ No newline at end of file
diff --git a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/logging/log4j/LoggingManagementFacade.java b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/logging/log4j/LoggingManagementFacade.java
index 5b411e2d8d..467cd15d2e 100644
--- a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/logging/log4j/LoggingManagementFacade.java
+++ b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/logging/log4j/LoggingManagementFacade.java
@@ -122,11 +122,11 @@ public class LoggingManagementFacade
     /** The log4j XML configuration file DTD defines three possible element
      * combinations for specifying optional logger+level settings.
      * Must account for the following:
-     *
-     * <category name="x"> <priority value="y"/> </category>    OR
-     * <category name="x"> <level value="y"/> </category>    OR
-     * <logger name="x"> <level value="y"/> </logger>
-     *
+     * <p>
+     * {@literal <category name="x"> <priority value="y"/> </category>} OR
+     * {@literal <category name="x"> <level value="y"/> </category>} OR
+     * {@literal <logger name="x"> <level value="y"/> </logger>}
+     * <p>
      * Noting also that the level/priority child element is optional too,
      * and not the only possible child element.
      */
@@ -171,10 +171,10 @@ public class LoggingManagementFacade
      * The log4j XML configuration file DTD defines 2 possible element
      * combinations for specifying the optional root logger level settings
      * Must account for the following:
-     *
-     * <root> <priority value="y"/> </root>    OR
-     * <root> <level value="y"/> </root>
-     *
+     * <p>
+     * {@literal <root> <priority value="y"/> </root> } OR
+     * {@literal <root> <level value="y"/> </root>}
+     * <p>
      * Noting also that the level/priority child element is optional too,
      * and not the only possible child element.
      */
diff --git a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/message/MessageSource.java b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/message/MessageSource.java
index 7f6629e33d..3f04ef6f78 100644
--- a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/message/MessageSource.java
+++ b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/message/MessageSource.java
@@ -54,13 +54,8 @@ public interface MessageSource extends TransactionLogResource, MessageNode
     /**
      * ExistingExclusiveConsumer signals a failure to create a consumer, because an exclusive consumer
      * already exists.
-     *
-     * <p/><table id="crc"><caption>CRC Card</caption>
-     * <tr><th> Responsibilities <th> Collaborations
-     * <tr><td> Represent failure to create a consumer, because an exclusive consumer already exists.
-     * </table>
-     *     *
-     * @todo Move to top level, used outside this class.
+     * <p>
+     * TODO Move to top level, used outside this class.
      */
     static final class ExistingExclusiveConsumer extends Exception
     {
@@ -73,13 +68,8 @@ public interface MessageSource extends TransactionLogResource, MessageNode
     /**
      * ExistingConsumerPreventsExclusive signals a failure to create an exclusive consumer, as a consumer
      * already exists.
-     *
-     * <p/><table id="crc"><caption>CRC Card</caption>
-     * <tr><th> Responsibilities <th> Collaborations
-     * <tr><td> Represent failure to create an exclusive consumer, as a consumer already exists.
-     * </table>
-     *     *
-     * @todo Move to top level, used outside this class.
+     * <p>
+     * TODO Move to top level, used outside this class.
      */
     static final class ExistingConsumerPreventsExclusive extends Exception
     {
diff --git a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/registry/ApplicationRegistry.java b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/registry/ApplicationRegistry.java
index 9711250bd7..acfe7856c3 100644
--- a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/registry/ApplicationRegistry.java
+++ b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/registry/ApplicationRegistry.java
@@ -41,7 +41,7 @@ import org.apache.qpid.util.SystemUtils;
 /**
  * An abstract application registry that provides access to configuration information and handles the
  * construction and caching of configurable objects.
- * <p/>
+ * <p>
  * Subclasses should handle the construction of the "registered objects" such as the exchange registry.
  */
 public class ApplicationRegistry implements IApplicationRegistry
diff --git a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/security/AuthorizationHolder.java b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/security/AuthorizationHolder.java
index 8243fc3f75..85fa80ec8e 100755
--- a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/security/AuthorizationHolder.java
+++ b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/security/AuthorizationHolder.java
@@ -32,7 +32,7 @@ public interface AuthorizationHolder
     /**
      * Returns the {@link Subject} of the authorized user.  This is guaranteed to
      * contain at least one {@link org.apache.qpid.server.security.auth.UsernamePrincipal}, representing the the identity
-     * used when the user logged on to the application, and zero or more {@link org.apache.qpid.server.security.auth.sasl.GroupPrincipal}
+     * used when the user logged on to the application, and zero or more {@link org.apache.qpid.server.security.group.GroupPrincipal}
      * representing the group(s) to which the user belongs.
      *
      * @return the Subject
diff --git a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/security/auth/manager/ldap/AbstractLDAPSSLSocketFactory.java b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/security/auth/manager/ldap/AbstractLDAPSSLSocketFactory.java
index 3e8b2e210e..d7db81c3dd 100644
--- a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/security/auth/manager/ldap/AbstractLDAPSSLSocketFactory.java
+++ b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/security/auth/manager/ldap/AbstractLDAPSSLSocketFactory.java
@@ -35,19 +35,16 @@ import javax.net.ssl.SSLSocketFactory;
  * <p>
  * Concrete implementations of this class are <b>generated dynamically</b> at runtime by
  * the {@link LDAPSSLSocketFactoryGenerator#createSubClass(String, SSLSocketFactory)} method.
- * </p>
  * <p>
  * Callers will create new instances of the concrete implementations by using the static
  * <code>#getDefault()</code> method. This will return an instance of the sub-class that is
  * associated with the {@link SSLSocketFactory}.
- * </p>
  * <p>
  * If callers are passing the sub-class to an API via class-name (i.e. String), the caller
  * <b>must</b> ensure that the context classloader of the thread to set to the classloader
  * of sub-class for the duration of the API call(s).
- * </p>
+ * <p>
  * For more details  see {@link LDAPSSLSocketFactoryGenerator}.
- * </p>
  */
 public abstract class AbstractLDAPSSLSocketFactory extends SSLSocketFactory
 {
diff --git a/qpid/java/broker-plugins/access-control/src/main/java/org/apache/qpid/server/security/access/config/Action.java b/qpid/java/broker-plugins/access-control/src/main/java/org/apache/qpid/server/security/access/config/Action.java
index 4fff0bebf5..e09935cf5c 100644
--- a/qpid/java/broker-plugins/access-control/src/main/java/org/apache/qpid/server/security/access/config/Action.java
+++ b/qpid/java/broker-plugins/access-control/src/main/java/org/apache/qpid/server/security/access/config/Action.java
@@ -33,8 +33,8 @@ import org.apache.qpid.server.security.access.Operation;
  *
  * An action consists of an {@link Operation} on an {@link ObjectType} with certain properties, stored in a {@link java.util.Map}.
  * The operation and object should be an allowable combination, based on the {@link ObjectType#isAllowed(Operation)}
- * method of the object, which is exposed as the {@link #isAllowed()} method here. The internal {@link #propertiesMatch(Map)}
- * and {@link #valueMatches(String, String)} methods are used to determine wildcarded matching of properties, with
+ * method of the object, which is exposed as the {@link #isAllowed()} method here. The internal #propertiesMatch(Map)
+ * and #valueMatches(String, String) methods are used to determine wildcarded matching of properties, with
  * the empty string or "*" matching all values, and "*" at the end of a rule value indicating prefix matching.
  * <p>
  * The {@link #matches(Action)} method is intended to be used when determining precedence of rules, and
diff --git a/qpid/java/broker-plugins/access-control/src/main/java/org/apache/qpid/server/security/access/config/RuleSet.java b/qpid/java/broker-plugins/access-control/src/main/java/org/apache/qpid/server/security/access/config/RuleSet.java
index 7bf5626197..fd122ef8d2 100644
--- a/qpid/java/broker-plugins/access-control/src/main/java/org/apache/qpid/server/security/access/config/RuleSet.java
+++ b/qpid/java/broker-plugins/access-control/src/main/java/org/apache/qpid/server/security/access/config/RuleSet.java
@@ -49,9 +49,6 @@ import org.apache.qpid.server.security.access.Permission;
 
 /**
  * Models the rule configuration for the access control plugin.
- *
- * The access control rule definitions are loaded from an external configuration file, passed in as the
- * target to the {@link load(ConfigurationFile)} method. The file specified
  */
 public class RuleSet implements EventLoggerProvider
 {
diff --git a/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/AMQNoMethodHandlerException.java b/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/AMQNoMethodHandlerException.java
index 8faf1a7c65..42250190b4 100644
--- a/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/AMQNoMethodHandlerException.java
+++ b/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/AMQNoMethodHandlerException.java
@@ -27,14 +27,10 @@ import org.apache.qpid.protocol.AMQMethodEvent;
 /**

  * AMQNoMethodHandlerException represents the case where no method handler exists to handle an AQMP method.

  *

- * <p/><table id="crc"><caption>CRC Card</caption>

- * <tr><th> Responsibilities <th> Collaborations

- * <tr><td> Represents failure to handle an AMQP method.

- * </table>

- *

- * @todo Not an AMQP exception as no status code.

- *

- * @todo Missing method handler. Unlikely to ever happen, and if it does its a coding error. Consider replacing with a

+ * <p>

+ * TODO  Not an AMQP exception as no status code.

+ * <p>

+ * TODO  Missing method handler. Unlikely to ever happen, and if it does its a coding error. Consider replacing with a

  *       Runtime.

  */

 public class AMQNoMethodHandlerException extends AMQException

diff --git a/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/ConsumerTarget_0_8.java b/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/ConsumerTarget_0_8.java
index 7303ef30da..7c2efe64e6 100644
--- a/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/ConsumerTarget_0_8.java
+++ b/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/ConsumerTarget_0_8.java
@@ -44,8 +44,10 @@ import org.apache.qpid.server.txn.ServerTransaction;
 import org.apache.qpid.server.util.StateChangeListener;
 
 /**
- * Encapsulation of a subscription to a queue. <p/> Ties together the protocol session of a subscriber, the consumer tag
- * that was given out by the broker and the channel id. <p/>
+ * Encapsulation of a subscription to a queue.
+ * <p>
+ * Ties together the protocol session of a subscriber, the consumer tag
+ * that was given out by the broker and the channel id.
  */
 public abstract class ConsumerTarget_0_8 extends AbstractConsumerTarget implements FlowCreditManager.FlowCreditManagerListener
 {
@@ -171,10 +173,8 @@ public abstract class ConsumerTarget_0_8 extends AbstractConsumerTarget implemen
          * This method can be called by each of the publisher threads. As a result all changes to the channel object must be
          * thread safe.
          *
-         *
          * @param entry   The message to send
          * @param batch
-         * @throws org.apache.qpid.AMQException
          */
         @Override
         public void send(MessageInstance entry, boolean batch)
@@ -287,10 +287,8 @@ public abstract class ConsumerTarget_0_8 extends AbstractConsumerTarget implemen
          * This method can be called by each of the publisher threads. As a result all changes to the channel object must be
          * thread safe.
          *
-         *
          * @param entry   The message to send
          * @param batch
-         * @throws org.apache.qpid.AMQException
          */
         @Override
         public void send(MessageInstance entry, boolean batch)
diff --git a/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/state/AMQStateManager.java b/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/state/AMQStateManager.java
index 328064b6dc..cb9295ac49 100644
--- a/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/state/AMQStateManager.java
+++ b/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/state/AMQStateManager.java
@@ -43,8 +43,9 @@ import org.apache.qpid.server.security.SubjectCreator;
 import org.apache.qpid.server.util.ServerScopedRuntimeException;
 
 /**
- * The state manager is responsible for managing the state of the protocol session. <p/> For each AMQProtocolHandler
- * there is a separate state manager.
+ * The state manager is responsible for managing the state of the protocol session.
+ * <p>
+ * For each AMQProtocolHandler there is a separate state manager.
  */
 public class AMQStateManager implements AMQMethodListener
 {
diff --git a/qpid/java/management/common/src/main/java/org/apache/qpid/management/common/mbeans/ManagedExchange.java b/qpid/java/management/common/src/main/java/org/apache/qpid/management/common/mbeans/ManagedExchange.java
index 32e5fbd125..b6e1ed22ff 100644
--- a/qpid/java/management/common/src/main/java/org/apache/qpid/management/common/mbeans/ManagedExchange.java
+++ b/qpid/java/management/common/src/main/java/org/apache/qpid/management/common/mbeans/ManagedExchange.java
@@ -134,8 +134,8 @@ public interface ManagedExchange
     /**
      * Removes an exchange binding from a queue.
      * 
-     * @param exchangeName the Exchange name
-     * @param routingKey the routing key
+     * @param queueName the Queue name
+     * @param binding the binding key
      * @throws IOException
      * @throws JMException
      * @since Qpid JMX API 1.8