QPID-5980: initial javadoc fixups

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

27 files changed, 45 insertions, 174 deletions

diff --git a/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/NameParserImpl.java b/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/NameParserImpl.java
index 7c3857f6c9..d2a741d96c 100644
--- a/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/NameParserImpl.java
+++ b/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/NameParserImpl.java
@@ -25,7 +25,7 @@ import javax.naming.NamingException;
 
 /**
  * A default implementation of {@link NameParser}
- * <p/>
+ * <p>
  * Based on class from ActiveMQ.
  */
 public class NameParserImpl implements NameParser
diff --git a/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/ReadOnlyContext.java b/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/ReadOnlyContext.java
index 4e0f994b94..d0f7ddb216 100644
--- a/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/ReadOnlyContext.java
+++ b/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/ReadOnlyContext.java
@@ -45,13 +45,13 @@ import javax.naming.spi.NamingManager;
 /**
  * Based on class from ActiveMQ.
  * A read-only Context
- * <p/>
+ * <p>
  * This version assumes it and all its subcontext are read-only and any attempt
  * to modify (e.g. through bind) will result in an OperationNotSupportedException.
  * Each Context in the tree builds a cache of the entries in all sub-contexts
  * to optimise the performance of lookup.
- * </p>
- * <p>This implementation is intended to optimise the performance of lookup(String)
+ * <p>
+ * This implementation is intended to optimise the performance of lookup(String)
  * to about the level of a HashMap get. It has been observed that the scheme
  * resolution phase performed by the JVM takes considerably longer, so for
  * optimum performance lookups should be coded like:</p>
@@ -148,11 +148,6 @@ public class ReadOnlyContext implements Context, Serializable
      * to bind the remaining name.  It returns a map containing all the bindings from the next context, plus
      * the context it just created (if it in fact created it). (the names are suitably extended by the segment
      * originally lopped off).
-     *
-     * @param name
-     * @param value
-     * @return
-     * @throws javax.naming.NamingException
      */
     protected Map internalBind(String name, Object value) throws NamingException
     {
diff --git a/qpid/java/client/src/main/java/org/apache/qpid/jndi/NameParserImpl.java b/qpid/java/client/src/main/java/org/apache/qpid/jndi/NameParserImpl.java
index a3174aec7a..d7b16fcd6d 100644
--- a/qpid/java/client/src/main/java/org/apache/qpid/jndi/NameParserImpl.java
+++ b/qpid/java/client/src/main/java/org/apache/qpid/jndi/NameParserImpl.java
@@ -25,7 +25,7 @@ import javax.naming.NamingException;
 
 /**
  * A default implementation of {@link NameParser}
- * <p/>
+ * <p>
  * Based on class from ActiveMQ.
  */
 public class NameParserImpl implements NameParser
diff --git a/qpid/java/client/src/main/java/org/apache/qpid/jndi/ReadOnlyContext.java b/qpid/java/client/src/main/java/org/apache/qpid/jndi/ReadOnlyContext.java
index 76ec5f9498..1d7525ca91 100644
--- a/qpid/java/client/src/main/java/org/apache/qpid/jndi/ReadOnlyContext.java
+++ b/qpid/java/client/src/main/java/org/apache/qpid/jndi/ReadOnlyContext.java
@@ -44,13 +44,13 @@ import java.util.Map;
 /**
  * Based on class from ActiveMQ.
  * A read-only Context
- * <p/>
+ * <p>
  * This version assumes it and all its subcontext are read-only and any attempt
  * to modify (e.g. through bind) will result in an OperationNotSupportedException.
  * Each Context in the tree builds a cache of the entries in all sub-contexts
  * to optimise the performance of lookup.
- * </p>
- * <p>This implementation is intended to optimise the performance of lookup(String)
+ * <p>
+ * This implementation is intended to optimise the performance of lookup(String)
  * to about the level of a HashMap get. It has been observed that the scheme
  * resolution phase performed by the JVM takes considerably longer, so for
  * optimum performance lookups should be coded like:</p>
@@ -147,11 +147,6 @@ public class ReadOnlyContext implements Context, Serializable
      * to bind the remaining name.  It returns a map containing all the bindings from the next context, plus
      * the context it just created (if it in fact created it). (the names are suitably extended by the segment
      * originally lopped off).
-     *
-     * @param name
-     * @param value
-     * @return
-     * @throws javax.naming.NamingException
      */
     protected Map internalBind(String name, Object value) throws NamingException
     {
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelClosedException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelClosedException.java
index 1b2eabdc86..73a906b81c 100644
--- a/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelClosedException.java
+++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelClosedException.java
@@ -24,13 +24,6 @@ import org.apache.qpid.protocol.AMQConstant;
 
 /**
  * AMQChannelClosedException indicates that an operation cannot be performed becauase a channel has been closed.
- *
- * <p/><table id="crc"><caption>CRC Card</caption>
- * <tr><th> Responsibilities <th> Collaborations
- * <tr><td> Represents a failed operation on a closed channel.
- * </table>
- *
- * @todo Does this duplicate AMQChannelException?
  */
 public class AMQChannelClosedException extends AMQException
 {
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelException.java
index df71ece787..55f0fe57b0 100644
--- a/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelException.java
+++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelException.java
@@ -28,13 +28,6 @@ import org.apache.qpid.protocol.AMQConstant;
 
 /**
  * AMQChannelException indicates that an error that requires the channel to be closed has occurred.
- *
- * <p/><table id="crc"><caption>CRC Card</caption>
- * <tr><th> Responsibilities <th> Collaborations
- * <tr><td> Represents an error that rquires the channel to be closed.
- * </table>
- *
- * @todo Does this duplicate AMQChannelClosedException?
  */
 public class AMQChannelException extends AMQException
 {
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionClosedException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionClosedException.java
index b2ce3c1b32..4417c0a141 100644
--- a/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionClosedException.java
+++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionClosedException.java
@@ -25,15 +25,8 @@ import org.apache.qpid.protocol.AMQConstant;
 /**
  * AMQConnectionClosedException indicates that a connection has been closed.
  *
- * <p/>This exception is really used as an event, in order that the method handler that raises it creates an event
+ * <p>This exception is really used as an event, in order that the method handler that raises it creates an event
  * which is propagated to the io handler, in order to notify it of the connection closure.
- *
- * <p/><table id="crc"><caption>CRC Card</caption>
- * <tr><th> Responsibilities <th> Collaborations
- * <tr><td> Represents a the closure of a connection.
- * </table>
- *
- * @todo Should review where exceptions-as-events
  */
 public class AMQConnectionClosedException extends AMQException
 {
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionException.java
index ef108eeb67..096c4ede80 100644
--- a/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionException.java
+++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionException.java
@@ -29,13 +29,6 @@ import org.apache.qpid.protocol.AMQConstant;
 
 /**
  * AMQConnectionException indicates that an error that requires the channel to be closed has occurred.
- *
- * <p/><table id="crc"><caption>CRC Card</caption>
- * <tr><th> Responsibilities <th> Collaborations
- * <tr><td> Represents an error that rquires the channel to be closed.
- * </table>
- *
- * @todo Does this duplicate AMQChannelClosedException?
  */
 public class AMQConnectionException extends AMQException
 {
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionFailureException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionFailureException.java
index d9a9ee0782..efadaae611 100644
--- a/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionFailureException.java
+++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionFailureException.java
@@ -26,13 +26,6 @@ import java.util.Collection;
 
 /**
  * AMQConnectionFailureException indicates that a connection to a broker could not be formed.
- *
- * <p/><table id="crc"><caption>CRC Card</caption>
- * <tr><th> Responsibilities <th> Collaborations
- * <tr><td> Represents failure to connect to a broker.
- * </table>
- *
- * @todo Not an AMQP exception as no status code.
  */
 public class AMQConnectionFailureException extends AMQException
 {
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQDisconnectedException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQDisconnectedException.java
index 5ec5c42ab9..38fbc8fc57 100644
--- a/qpid/java/common/src/main/java/org/apache/qpid/AMQDisconnectedException.java
+++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQDisconnectedException.java
@@ -22,13 +22,6 @@ package org.apache.qpid;
 
 /**
  * AMQDisconnectedException indicates that a broker disconnected without failover.
- *
- * <p/><table id="crc"><caption>CRC Card</caption>
- * <tr><th> Responsibilities <th> Collaborations
- * <tr><td> Represents disconnection without failover by the broker.
- * </table>
- *
- * @todo Not an AMQP exception as no status code.
  */
 public class AMQDisconnectedException extends AMQException
 {
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQException.java
index 591202d934..3741cb9902 100644
--- a/qpid/java/common/src/main/java/org/apache/qpid/AMQException.java
+++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQException.java
@@ -26,14 +26,6 @@ import org.apache.qpid.protocol.AMQConstant;
 /**
  * AMQException forms the root exception of all exceptions relating to the AMQ protocol. It provides space to associate
  * a required AMQ error code with the exception, which is a numeric value, with a meaning defined by the protocol.
- *
- * <p/><table id="crc"><caption>CRC Card</caption>
- * <tr><th> Responsibilities <th> Collaborations
- * <tr><td> Represents an exception condition associated with an AMQ protocol status code.
- * </table>
- *
- * @todo This exception class is also used as a generic exception throughout Qpid code. This usage may not be strictly
- *       correct if this is to signify a protocol exception. Should review.
  */
 public class AMQException extends Exception
 {
@@ -117,9 +109,9 @@ public class AMQException extends Exception
      * Rethrown this exception as a new exception.
      *
      * Attempt to create a new exception of the same class if they have the default constructor of:
-     * {AMQConstant.class, String.class, Throwable.class}
-     * <p>
-     * Individual subclasses may override as requried to create a new instance.
+     * {AMQConstant.class, String.class, Throwable.class}.
+     *
+     * @return cloned exception
      */
     public AMQException cloneForCurrentThread()
     {
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidArgumentException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidArgumentException.java
index 2bbaaef1fc..2592ab7662 100644
--- a/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidArgumentException.java
+++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidArgumentException.java
@@ -24,11 +24,6 @@ import org.apache.qpid.protocol.AMQConstant;
 
 /**
  * AMQInvalidArgumentException indicates that an invalid argument has been passed to an AMQP method.
- *
- * <p/><table id="crc"><caption>CRC Card</caption>
- * <tr><th> Responsibilities <th> Collaborations
- * <tr><td> Represents an error due to an invalid argument being passed to an AMQP method.
- * </table>
  */
 public class AMQInvalidArgumentException extends AMQException
 {
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidRoutingKeyException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidRoutingKeyException.java
index c117968a29..d0a61cfeeb 100644
--- a/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidRoutingKeyException.java
+++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidRoutingKeyException.java
@@ -24,11 +24,6 @@ import org.apache.qpid.protocol.AMQConstant;
 
 /**
  * AMQInvalidRoutingKeyException indicates an error with a routing key having an invalid format.
- *
- * <p/><table id="crc"><caption>CRC Card</caption>
- * <tr><th> Responsibilities <th> Collaborations
- * <tr><td> Represents a format error in a routing key.
- * </table>
  */
 public class AMQInvalidRoutingKeyException extends AMQException
 {
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQPInvalidClassException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQPInvalidClassException.java
index ab5141be9d..533a704a80 100644
--- a/qpid/java/common/src/main/java/org/apache/qpid/AMQPInvalidClassException.java
+++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQPInvalidClassException.java
@@ -23,12 +23,7 @@ package org.apache.qpid;
 /**
  * AMQPInvalidClassException indicates an error when trying to store an illegally typed argument in a field table.
  *
- * <p/><table id="crc"><caption>CRC Card</caption>
- * <tr><th> Responsibilities <th> Collaborations
- * <tr><td> Represents illegal argument type for field table values.
- * </table>
- *
- * @todo Could just re-use an exising exception like IllegalArgumentException or ClassCastException.
+ * <p>TODO Could just re-use an exising exception like IllegalArgumentException or ClassCastException.
  */
 public class AMQPInvalidClassException extends RuntimeException
 {
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQTimeoutException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQTimeoutException.java
index 4ae8282af5..c36d2c5907 100644
--- a/qpid/java/common/src/main/java/org/apache/qpid/AMQTimeoutException.java
+++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQTimeoutException.java
@@ -24,11 +24,6 @@ import org.apache.qpid.protocol.AMQConstant;
 
 /**
  * AMQTimeoutException indicates that an expected response from a broker took too long.
- *
- * <p/><table id="crc"><caption>CRC Card</caption>
- * <tr><th> Responsibilities <th> Collaborations
- * <tr><td> Indicates that an expected response from a broker took too long.
- * </table>
  */
 public class AMQTimeoutException extends AMQException
 {
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQUndeliveredException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQUndeliveredException.java
index 01a569b693..68cbc57216 100644
--- a/qpid/java/common/src/main/java/org/apache/qpid/AMQUndeliveredException.java
+++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQUndeliveredException.java
@@ -24,11 +24,6 @@ import org.apache.qpid.protocol.AMQConstant;
 
 /**
  * AMQUndeliveredException indicates that a message, marked immediate or mandatory, could not be delivered.
- *
- * <p/><table id="crc"><caption>CRC Card</caption>
- * <tr><th> Responsibilities <th> Collaborations
- * <tr><td> Represents failure to delivery a message that must be delivered.
- * </table>
  */
 public class AMQUndeliveredException extends AMQException
 {
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQUnresolvedAddressException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQUnresolvedAddressException.java
index 82ffe583c3..902b12300f 100644
--- a/qpid/java/common/src/main/java/org/apache/qpid/AMQUnresolvedAddressException.java
+++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQUnresolvedAddressException.java
@@ -22,15 +22,10 @@ package org.apache.qpid;
 
 /**
  * AMQUnresolvedAddressException indicates failure to resolve a socket address.
- *
- * <p/><table id="crc"><caption>CRC Card</caption>
- * <tr><th> Responsibilities <th> Collaborations
- * <tr><td> Represents failre to resolve a socket address.
- * </table>
- *
- * @todo Not an AMQP exception as no status code.
- *
- * @todo Why replace java.nio.UnresolvedAddressException with this? This is checked, which may explain why, but it
+ * <p>
+ * TODO Not an AMQP exception as no status code.
+ * <p>
+ * TODO Why replace java.nio.UnresolvedAddressException with this? This is checked, which may explain why, but it
  *       doesn't wrap the underlying exception.
  */
 public class AMQUnresolvedAddressException extends AMQException
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/dtx/XidImpl.java b/qpid/java/common/src/main/java/org/apache/qpid/dtx/XidImpl.java
index 3590254d27..2d017b1cd4 100644
--- a/qpid/java/common/src/main/java/org/apache/qpid/dtx/XidImpl.java
+++ b/qpid/java/common/src/main/java/org/apache/qpid/dtx/XidImpl.java
@@ -99,14 +99,14 @@ public class XidImpl implements Xid
      * +---+---+---+---+---+---+---+-  -+---+---+-  -+---+
      * 0               4   5   6           6+g         6+g+b
      * format_id: an implementation specific format identifier
-     * <p/>
+     * <p>
      * gtrid_length: how many bytes of this form the transaction id
-     * <p/>
+     * <p>
      * bqual_length: how many bytes of this form the branch id
-     * <p/>
+     * <p>
      * data: a sequence of octets of at most 128 bytes containing the txn id and the
      * branch id
-     * <p/>
+     * <p>
      * Note - The sum of the two lengths must equal the length of the data field.
      *
      * @param xid an XID STring Form
@@ -239,14 +239,14 @@ public class XidImpl implements Xid
      * +---+---+---+---+---+---+---+-  -+---+---+-  -+---+
      * 0               4   5   6           6+g         6+g+b
      * format_id: an implementation specific format identifier
-     * <p/>
+     * <p>
      * gtrid_length: how many bytes of this form the transaction id
-     * <p/>
+     * <p>
      * bqual_length: how many bytes of this form the branch id
-     * <p/>
+     * <p>
      * data: a sequence of octets of at most 128 bytes containing the txn id and the
      * branch id
-     * <p/>
+     * <p>
      * Note - The sum of the two lengths must equal the length of the data field.
      *
      * @param xid an Xid to convert.
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQDataBlock.java b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQDataBlock.java
index fd42084429..c234a5e829 100644
--- a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQDataBlock.java
+++ b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQDataBlock.java
@@ -39,7 +39,8 @@ public abstract class AMQDataBlock implements EncodableAMQDataBlock
 
     /**
      * Writes the datablock to the specified buffer.
-     * @param buffer
+     * @param buffer the buffer to write to
+     * @throws IOException if there is a problem writing the output
      */
     public abstract void writePayload(DataOutput buffer) throws IOException;
 
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQFrameDecodingException.java b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQFrameDecodingException.java
index 2373edb478..34e9211d1c 100644
--- a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQFrameDecodingException.java
+++ b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQFrameDecodingException.java
@@ -26,11 +26,6 @@ import org.apache.qpid.protocol.AMQConstant;
 /**
  * AMQFrameDecodingException indicates that an AMQP frame cannot be decoded because it does not have the correct
  * format as defined by the protocol.
- *
- * <p/><table id="crc"><caption>CRC Card</caption>
- * <tr><th> Responsibilities <th> Collaborations
- * <tr><td> Represents a format error in a protocol frame.
- * </table>
  */
 public class AMQFrameDecodingException extends AMQException
 {
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQMethodBody.java b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQMethodBody.java
index 966a03605c..250b8e87d1 100644
--- a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQMethodBody.java
+++ b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQMethodBody.java
@@ -32,9 +32,12 @@ public interface AMQMethodBody extends AMQBody
 {
     public static final byte TYPE = 1;
 
-    /** AMQP version */
+    /** AMQP major version 
+     * @return the major version*/
     public byte getMajor();
 
+    /** AMQP minor version 
+     * @return the minor version*/
     public byte getMinor();
 
 
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolClassException.java b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolClassException.java
index ab09c1de6d..0586a11619 100644
--- a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolClassException.java
+++ b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolClassException.java
@@ -22,13 +22,8 @@ package org.apache.qpid.framing;
 
 /**
  * AMQProtocolInstanceException indicates that the protocol class is incorrect in a header.
- *
- * <p/><table id="crc"><caption>CRC Card</caption>
- * <tr><th> Responsibilities <th> Collaborations
- * <tr><td> Represent incorrect protocol class in frame header.
- * </table>
- *
- * @todo Not an AMQP exception as no status code.
+ * <p>
+ * TODO Not an AMQP exception as no status code.
  */
 public class AMQProtocolClassException extends AMQProtocolHeaderException
 {
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolHeaderException.java b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolHeaderException.java
index 6b819364da..b0c92d9aab 100644
--- a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolHeaderException.java
+++ b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolHeaderException.java
@@ -24,13 +24,8 @@ import org.apache.qpid.AMQException;
 
 /**
  * AMQProtocolHeaderException indicates a format error in an AMQP frame header.
- *
- * <p/><table id="crc"><caption>CRC Card</caption>
- * <tr><th> Responsibilities <th> Collaborations
- * <tr><td> Represent format error in frame header.
- * </table>
- *
- * @todo Not an AMQP exception as no status code.
+ * <p>
+ * TODO Not an AMQP exception as no status code.
  */
 public class AMQProtocolHeaderException extends AMQException
 {
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolInstanceException.java b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolInstanceException.java
index 3165c373a9..cbc9e724de 100644
--- a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolInstanceException.java
+++ b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolInstanceException.java
@@ -22,13 +22,8 @@ package org.apache.qpid.framing;
 
 /**
  * AMQProtocolInstanceException indicates that the protocol instance is incorrect in a header.
- *
- * <p/><table id="crc"><caption>CRC Card</caption>
- * <tr><th> Responsibilities <th> Collaborations
- * <tr><td> Represent incorrect protocol instance in frame header.
- * </table>
- *
- * @todo Not an AMQP exception as no status code.
+ * <p>
+ * TODO Not an AMQP exception as no status code.
  */
 public class AMQProtocolInstanceException extends AMQProtocolHeaderException
 {
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolVersionException.java b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolVersionException.java
index c9b0973ea6..37c384bfc9 100644
--- a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolVersionException.java
+++ b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolVersionException.java
@@ -22,13 +22,8 @@ package org.apache.qpid.framing;
 
 /**
  * AMQProtocolInstanceException indicates that the client and server differ on expected protocol version  in a header.
- *
- * <p/><table id="crc"><caption>CRC Card</caption>
- * <tr><th> Responsibilities <th> Collaborations
- * <tr><td> Represent incorrect protocol version in frame header.
- * </table>
- *
- * @todo Not an AMQP exception as no status code.
+ * <p>
+ * TODO Not an AMQP exception as no status code.
  */
 public class AMQProtocolVersionException extends AMQProtocolHeaderException
 {
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQType.java b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQType.java
index b681e782a3..71b5c5a623 100644
--- a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQType.java
+++ b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQType.java
@@ -30,16 +30,6 @@ import java.util.Collection;
  * AMQType is a type that represents the different possible AMQP field table types. It provides operations for each
  * of the types to perform tasks such as calculating the size of an instance of the type, converting types between AMQP
  * and Java native types, and reading and writing instances of AMQP types in binary formats to and from byte buffers.
- *
- * <p/><table id="crc"><caption>CRC Card</caption>
- * <tr><th> Responsibilities <th> Collaborations
- * <tr><td> Get the equivalent one byte identifier for a type.
- * <tr><td> Calculate the size of an instance of an AMQP parameter type. <td> {@link EncodingUtils}
- * <tr><td> Convert an instance of an AMQP parameter into a compatable Java object tagged with its AMQP type.
- *     <td> {@link AMQTypedValue}
- * <tr><td> Write an instance of an AMQP parameter type to a byte buffer. <td> {@link EncodingUtils}
- * <tr><td> Read an instance of an AMQP parameter from a byte buffer. <td> {@link EncodingUtils}
- * </table>
  */
 public enum AMQType
 {
@@ -827,6 +817,7 @@ public enum AMQType
      *
      * @param value  An instance of the type.
      * @param buffer The byte buffer to write it to.
+     * @throws IOException if there is a problem writing to the buffer
      */
     public void writeToBuffer(Object value, DataOutput buffer) throws IOException
     {
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/pool/ReferenceCountingExecutorService.java b/qpid/java/common/src/main/java/org/apache/qpid/pool/ReferenceCountingExecutorService.java
index 0df9a85676..a6df71464b 100644
--- a/qpid/java/common/src/main/java/org/apache/qpid/pool/ReferenceCountingExecutorService.java
+++ b/qpid/java/common/src/main/java/org/apache/qpid/pool/ReferenceCountingExecutorService.java
@@ -33,28 +33,19 @@ import java.util.concurrent.TimeUnit;
  * the references taken, instantiating the service on the first reference, and shutting it down when the last
  * reference is released.
  *
- * <p/>It is important to ensure that an executor service is correctly shut down as failing to do so prevents the JVM
+ * <p>It is important to ensure that an executor service is correctly shut down as failing to do so prevents the JVM
  * from terminating due to the existence of non-daemon threads.
  *
- * <p/><table id="crc><caption>CRC Card</caption>
- * <tr><th> Responsibilities <th> Collaborations
- * <tr><td> Provide a shared executor service. <td> {@link Executors}
- * <tr><td> Shutdown the executor service when not needed. <td> {@link ExecutorService}
- * <tr><td> Track references to the executor service.
- * <tr><td> Provide configuration of the executor service.
- * </table>
- *
- * @todo Might be more elegant to make this actually implement ExecutorService, providing better hiding of the
+ * <p>
+ * TODO  Might be more elegant to make this actually implement ExecutorService, providing better hiding of the
  *       implementation details. Also this class introduces a pattern (albeit specific to this usage) that could be
  *       generalized to reference count anything. That is, on first instance call a create method, on release of last
  *       instance call a destroy method. This could definitely be abstracted out as a re-usable piece of code; a
  *       reference counting factory. It could then be re-used to do reference counting in other places (such as
  *       messages). Countable objects have a simple create/destroy life cycle, capturable by an interface that the
  *       ref counting factory can call to manage the lifecycle.
- *
- * @todo {@link #_poolSize} should be static?
- *
- * @todo The {@link #getPool()} method breaks the encapsulation of the reference counter. Generally when getPool is used
+ * <p>
+ * TODO  The {@link #getPool()} method breaks the encapsulation of the reference counter. Generally when getPool is used
  *       further checks are applied to ensure that the executor service has not been shutdown. This passes responsibility
  *       for managing the lifecycle of the reference counted object onto the caller rather than neatly encapsulating it
  *       here. Could think about adding more state to the lifecycle, to mark ref counted objects as invalid, and have an