From 30d0a85f3a19f28eca299e56e7c959a9a810acc8 Mon Sep 17 00:00:00 2001
From: Robert Gemmell <robbie@apache.org>
Date: Fri, 8 Aug 2014 16:15:37 +0000
Subject: QPID-5980: javadoc fixups continue

git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@1616811 13f79535-47bb-0310-9956-ffa450edef68
---
 .../qpid/server/store/berkeleydb/BDBBackup.java    | 35 ++++++++++------------
 .../store/berkeleydb/upgrade/UpgradeFrom5To6.java  |  4 +--
 2 files changed, 18 insertions(+), 21 deletions(-)

(limited to 'qpid/java/bdbstore/src')

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
-- 
cgit v1.2.1