QPID-5980: javadoc fixups continue

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

6 files changed, 32 insertions, 34 deletions

diff --git a/qpid/java/bdbstore/src/main/java/org/apache/qpid/server/store/berkeleydb/BDBBackup.java b/qpid/java/bdbstore/src/main/java/org/apache/qpid/server/store/berkeleydb/BDBBackup.java
index 80802b6a0c..4717aab472 100644
--- a/qpid/java/bdbstore/src/main/java/org/apache/qpid/server/store/berkeleydb/BDBBackup.java
+++ b/qpid/java/bdbstore/src/main/java/org/apache/qpid/server/store/berkeleydb/BDBBackup.java
@@ -41,41 +41,38 @@ import java.util.Properties;
 
 /**
  * BDBBackup is a utility for taking hot backups of the current state of a BDB transaction log database.
- *
- * <p/>This utility makes the following assumptions/performs the following actions:
- *
- * <p/><ul> <li>The from and to directory locations will already exist. This scripts does not create them. <li>If this
+ * <p>
+ * This utility makes the following assumptions/performs the following actions:
+ * <p>
+ * <ul> <li>The from and to directory locations will already exist. This scripts does not create them. <li>If this
  * script fails to complete in one minute it will terminate. <li>This script always exits with code 1 on error, code 0
  * on success (standard unix convention). <li>This script will log out at info level, when it starts and ends and a list
  * of all files backed up. <li>This script logs all errors at error level. <li>This script does not perform regular
  * backups, wrap its calling script in a cron job or similar to do this. </ul>
- *
- * <p/>This utility is build around the BDB provided backup helper utility class, DbBackup. This utility class provides
+ * <p>
+ * This utility is build around the BDB provided backup helper utility class, DbBackup. This utility class provides
  * an ability to force BDB to stop writing to the current log file set, whilst the backup is taken, to ensure that a
  * consistent snapshot is acquired. Preventing BDB from writing to the current log file set, does not stop BDB from
  * continuing to run concurrently while the backup is running, it simply moves onto a new set of log files; this
  * provides a 'hot' backup facility.
- *
- * <p/>DbBackup can also help with incremental backups, by providing the number of the last log file backed up.
+ * <p>
+ * DbBackup can also help with incremental backups, by providing the number of the last log file backed up.
  * Subsequent backups can be taken, from later log files only. In a messaging application, messages are not expected to
  * be long-lived in most cases, so the log files will usually have been completely turned over between backups. This
  * utility does not support incremental backups for this reason.
- *
- * <p/>If the database is locked by BDB, as is required when using transactions, and therefore will always be the case
+ * <p>
+ * If the database is locked by BDB, as is required when using transactions, and therefore will always be the case
  * in Qpid, this utility cannot make use of the DbBackup utility in a seperate process. DbBackup, needs to ensure that
  * the BDB envinronment used to take the backup has exclusive write access to the log files. This utility can take a
  * backup as a standalone utility against log files, when a broker is not running, using the {@link #takeBackup(String,
  *String,com.sleepycat.je.Environment)} method.
- *
- * <p/>A seperate backup machanism is provided by the {@link #takeBackupNoLock(String,String)} method which can take a
+ * <p>
+ * A seperate backup machanism is provided by the {@link #takeBackupNoLock(String,String)} method which can take a
  * hot backup against a running broker. This works by finding out the set of files to copy, and then opening them all to
  * read, and repeating this process until a consistent set of open files is obtained. This is done to avoid the
  * situation where the BDB cleanup thread deletes a file, between the directory listing and opening of the file to copy.
  * All consistently opened files are copied. This is the default mechanism the the {@link #main} method of this utility
  * uses.
- *
- * <p/><table id="crc><caption>CRC Card</caption> <tr><th> Responsibilities <th> Collaborations <tr><td> Hot copy all
- * BDB log files from one directory to another. </table>
  */
 public class BDBBackup
 {
@@ -102,10 +99,10 @@ public class BDBBackup
     /**
      * Runs a backup of the BDB log files in a specified directory, copying the backed up files to another specified
      * directory.
-     *
-     * <p/>The following arguments must be specified:
-     *
-     * <p/><table><caption>Command Line</caption> <tr><th> Option <th> Comment <tr><td> -fromdir <td> The path to the
+     * <p>
+     * The following arguments must be specified:
+     * <table>
+     * <caption>Command Line</caption> <tr><th> Option <th> Comment <tr><td> -fromdir <td> The path to the
      * directory to back the bdb log file from. <tr><td> -todir   <td> The path to the directory to save the backed up
      * bdb log files to. </table>
      *
diff --git a/qpid/java/bdbstore/src/main/java/org/apache/qpid/server/store/berkeleydb/upgrade/UpgradeFrom5To6.java b/qpid/java/bdbstore/src/main/java/org/apache/qpid/server/store/berkeleydb/upgrade/UpgradeFrom5To6.java
index 366b6a1c97..1e4bfec09c 100644
--- a/qpid/java/bdbstore/src/main/java/org/apache/qpid/server/store/berkeleydb/upgrade/UpgradeFrom5To6.java
+++ b/qpid/java/bdbstore/src/main/java/org/apache/qpid/server/store/berkeleydb/upgrade/UpgradeFrom5To6.java
@@ -110,8 +110,8 @@ public class UpgradeFrom5To6 extends AbstractStoreUpgrade
      *
      * Message content is moved from the database messageContentDb_v5 to
      * MESSAGE_CONTENT. The structure of the database changes from ( message-id:
-     * long, chunk-id: int ) -> ( size: int, byte[] data ) to ( message-id:
-     * long) -> ( byte[] data )
+     * long, chunk-id: int ) {@literal ->} ( size: int, byte[] data ) to ( message-id:
+     * long) {@literal ->} ( byte[] data )
      *
      * That is we keep only one record per message, which contains all the
      * message content
diff --git a/qpid/java/jca/src/main/java/org/apache/qpid/ra/QpidRASessionImpl.java b/qpid/java/jca/src/main/java/org/apache/qpid/ra/QpidRASessionImpl.java
index c4cfeaba48..a972d6cda0 100644
--- a/qpid/java/jca/src/main/java/org/apache/qpid/ra/QpidRASessionImpl.java
+++ b/qpid/java/jca/src/main/java/org/apache/qpid/ra/QpidRASessionImpl.java
@@ -1230,7 +1230,6 @@ public class QpidRASessionImpl implements Session, QueueSession, TopicSession, X
    /**
     * Get the XA resource
     * @return The XA resource
-    * @exception IllegalStateException If non XA connection
     */
    public XAResource getXAResource()
    {
@@ -1713,8 +1712,8 @@ public class QpidRASessionImpl implements Session, QueueSession, TopicSession, X
    }
 
    /**
-    * @throws SystemException
-    * @throws RollbackException
+    * throws SystemException
+    * throws RollbackException
     *
     */
    public void checkState() throws JMSException
diff --git a/qpid/java/jca/src/main/java/org/apache/qpid/ra/inflow/QpidActivationSpec.java b/qpid/java/jca/src/main/java/org/apache/qpid/ra/inflow/QpidActivationSpec.java
index 3d9a88adb5..9654d06ef3 100644
--- a/qpid/java/jca/src/main/java/org/apache/qpid/ra/inflow/QpidActivationSpec.java
+++ b/qpid/java/jca/src/main/java/org/apache/qpid/ra/inflow/QpidActivationSpec.java
@@ -452,7 +452,7 @@ public class QpidActivationSpec extends ConnectionFactoryProperties implements A
 
    /**
     * Set the prefetch low
-    * @param value The value
+    * @param prefetchLow The value
     */
    public void setPrefetchLow(final Integer prefetchLow)
    {
@@ -480,7 +480,7 @@ public class QpidActivationSpec extends ConnectionFactoryProperties implements A
 
    /**
     * Set the prefetch high
-    * @param value The value
+    * @param prefetchHigh The value
     */
    public void setPrefetchHigh(final Integer prefetchHigh)
    {
diff --git a/qpid/java/management/example/src/main/java/org/apache/qpid/example/jmxexample/QueueInformation.java b/qpid/java/management/example/src/main/java/org/apache/qpid/example/jmxexample/QueueInformation.java
index faac704dbc..977cc38c2f 100644
--- a/qpid/java/management/example/src/main/java/org/apache/qpid/example/jmxexample/QueueInformation.java
+++ b/qpid/java/management/example/src/main/java/org/apache/qpid/example/jmxexample/QueueInformation.java
@@ -64,13 +64,15 @@ public class QueueInformation
 
     /**
      * Params:
-     * 0: host, e.g. eqd-myserver.mydomain.com
-     * 1: port, e.g. 8999
-     * 2: vhost e.g. dev-only
-     * 3: username, e.g. guest
-     * 4: pwd, e.g. guest
-     * 5: loop pause, no value indicates one-off, any other value is millisecs
-     * ..: attributes=<csv attribute list> , queue=<csv queue list>
+     * <p>
+     * <p>0: host, e.g. eqd-myserver.mydomain.com
+     * <p>1: port, e.g. 8999
+     * <p>2: vhost e.g. dev-only
+     * <p>3: username, e.g. guest
+     * <p>4: pwd, e.g. guest
+     * <p>5: loop pause, no value indicates one-off, any other value is millisecs
+     * <p>..: {@literal attributes=<csv attribute list> , queue=<csv queue list>}
+     * <p>
      * The queue list can use wildcards such as * and ?. Basically any value
      * that JMX will accept in the query string for t name='' value of the queue.
      */
diff --git a/qpid/java/tools/src/main/java/org/apache/qpid/testkit/TestLauncher.java b/qpid/java/tools/src/main/java/org/apache/qpid/testkit/TestLauncher.java
index 72ca48e1c9..0c94030ec6 100644
--- a/qpid/java/tools/src/main/java/org/apache/qpid/testkit/TestLauncher.java
+++ b/qpid/java/tools/src/main/java/org/apache/qpid/testkit/TestLauncher.java
@@ -56,7 +56,7 @@ import org.apache.qpid.thread.Threading;
  * or both, each on it's own separate thread.
  * 
  * If con_count == ssn_count, then each entity created will have
- * it's own Connection. Else if con_count < ssn_count, then
+ * it's own Connection. Else if con_count {@literal <} ssn_count, then
  * a connection will be shared by ssn_count/con_count # of entities.
  * 
  * The if both sender and receiver options are set, it will