This closes #831

artemis-core-client/src/main/java/org/apache/activemq/artemis/core/protocol/core/CommandConfirmationHandler.java

@@ -18,7 +18,6 @@ package org.apache.activemq.artemis.core.protocol.core;
 
 /**
  * A CommandConfirmationHandler is used by the channel to confirm confirmations of packets.
- * <p>
  */
 public interface CommandConfirmationHandler {
 

artemis-jdbc-store/src/main/java/org/apache/activemq/artemis/jdbc/store/file/JDBCSequentialFileFactoryDriver.java

@@ -94,7 +94,6 @@ public class JDBCSequentialFileFactoryDriver extends AbstractJDBCDriver {
     * Opens the supplied file.  If the file does not exist in the database it will create a new one.
     *
     * @param file
-    * @return
     * @throws SQLException
     */
    public void openFile(JDBCSequentialFile file) throws SQLException {
@@ -216,7 +215,7 @@ public class JDBCSequentialFileFactoryDriver extends AbstractJDBCDriver {
     * @param file
     * @param data
     * @return
-    * @throws Exception
+    * @throws SQLException
     */
    public synchronized int writeToFile(JDBCSequentialFile file, byte[] data) throws SQLException {
       try {
@@ -238,7 +237,7 @@ public class JDBCSequentialFileFactoryDriver extends AbstractJDBCDriver {
     * @param file
     * @param bytes
     * @return
-    * @throws Exception
+    * @throws SQLException
     */
    public synchronized int readFromFile(JDBCSequentialFile file, ByteBuffer bytes) throws SQLException {
       connection.setAutoCommit(false);

artemis-jms-client/src/main/java/org/apache/activemq/artemis/jms/client/ActiveMQConnectionFactory.java

@@ -652,7 +652,6 @@ public class ActiveMQConnectionFactory implements ConnectionFactoryOptions, Exte
 
    /**
     * @param interceptorList a comma separated string of incoming interceptor class names to be used. Each interceptor needs a default Constructor to be used with this method.
-    * @return this
     */
    public void setIncomingInterceptorList(String interceptorList) {
       checkWrite();
@@ -665,7 +664,6 @@ public class ActiveMQConnectionFactory implements ConnectionFactoryOptions, Exte
 
    /**
     * @param interceptorList a comma separated string of incoming interceptor class names to be used. Each interceptor needs a default Constructor to be used with this method.
-    * @return this
     */
    public void setOutgoingInterceptorList(String interceptorList) {
       serverLocator.setOutgoingInterceptorList(interceptorList);

artemis-jms-client/src/main/java/org/apache/activemq/artemis/jndi/ReadOnlyContext.java

@@ -47,7 +47,6 @@ import org.apache.activemq.artemis.core.client.ActiveMQClientLogger;
  * 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)
  * 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

artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/JournalImpl.java

@@ -73,7 +73,6 @@ import org.jboss.logging.Logger;
 
 /**
  * <p>A circular log implementation.</p>
- * <p></p>
  * <p>Look at {@link JournalImpl#load(LoaderCallback)} for the file layout
  */
 public class JournalImpl extends JournalBase implements TestableJournal, JournalRecordProvider {
@@ -930,9 +929,7 @@ public class JournalImpl extends JournalBase implements TestableJournal, Journal
    /**
     * <p>If the system crashed after a prepare was called, it should store information that is required to bring the transaction
     * back to a state it could be committed. </p>
-    * <p></p>
     * <p> transactionData allows you to store any other supporting user-data related to the transaction</p>
-    * <p></p>
     * <p> This method also uses the same logic applied on {@link JournalImpl#appendCommitRecord(long, boolean)}
     *
     * @param txID
@@ -1397,7 +1394,6 @@ public class JournalImpl extends JournalBase implements TestableJournal, Journal
 
    /**
     * <p>Load data accordingly to the record layouts</p>
-    * <p></p>
     * <p>Basic record layout:</p>
     * <table border=1 summary="">
     * <tr><td><b>Field Name</b></td><td><b>Size</b></td></tr>
@@ -1411,9 +1407,7 @@ public class JournalImpl extends JournalBase implements TestableJournal, Journal
     * <tr><td>RecordBody</td><td>Byte Array (size=BodySize)</td></tr>
     * <tr><td>Check Size</td><td>Integer (4 bytes)</td></tr>
     * </table>
-    * <p></p>
     * <p> The check-size is used to validate if the record is valid and complete </p>
-    * <p></p>
     * <p>Commit/Prepare record layout:</p>
     * <table border=1 summary="">
     * <tr><td><b>Field Name</b></td><td><b>Size</b></td></tr>
@@ -1428,7 +1422,6 @@ public class JournalImpl extends JournalBase implements TestableJournal, Journal
     * <tr><td>* NumberOfElements(n)</td><td>Integer (4 bytes)</td></tr>
     * <tr><td>CheckSize</td><td>Integer (4 bytes)</td></tr>
     * </table>
-    * <p></p>
     * <p> * FileID and NumberOfElements are the transaction summary, and they will be repeated (N)umberOfFiles times </p>
     */
    @Override

artemis-junit/src/main/java/org/apache/activemq/artemis/junit/ActiveMQConsumerResource.java

@@ -30,10 +30,10 @@ import org.apache.activemq.artemis.api.core.client.ServerLocator;
  *
  * <pre><code>
  * public class SimpleTest {
- *    {@code @Rule}
+ *     @Rule
  *     public ActiveMQConsumerResource client = new ActiveMQProducerResource( "vm://0", "test.queue" );
  *
- *    {@code @Test}
+ *     @Test
  *     public void testSomething() throws Exception {
  *         // Use the embedded client here
  *         ClientMessage message = client.receiveMessage();

artemis-junit/src/main/java/org/apache/activemq/artemis/junit/ActiveMQDynamicProducerResource.java

@@ -31,10 +31,10 @@ import org.apache.activemq.artemis.api.core.client.ServerLocator;
  *
  * <pre><code>
  * public class SimpleTest {
- *    {@code @Rule}
+ *     @Rule
  *     public ActiveMQDynamicProducerResource producer = new ActiveMQDynamicProducerResource( "vm://0");
  *
- *    {@code @Test}
+ *     @Test
  *     public void testSomething() throws Exception {
  *         // Use the embedded ClientProducer here
  *         producer.sendMessage( "test.address", "String Body" );

artemis-junit/src/main/java/org/apache/activemq/artemis/junit/ActiveMQProducerResource.java

@@ -32,10 +32,10 @@ import org.apache.activemq.artemis.api.core.client.ServerLocator;
  *
  * <pre><code>
  * public class SimpleTest {
- *    {@code @Rule}
+ *     @Rule
  *     public ActiveMQProducerResource producer = new ActiveMQProducerResource( "vm://0", "test.queue");
  *
- *    {@code @Test}
+ *     @Test
  *     public void testSomething() throws Exception {
  *         // Use the embedded ClientProducer here
  *         producer.sendMessage( "String Body" );

artemis-junit/src/main/java/org/apache/activemq/artemis/junit/EmbeddedActiveMQResource.java

@@ -52,10 +52,10 @@ import org.slf4j.LoggerFactory;
  *
  * <pre><code>
  * public class SimpleTest {
- *    {@code @Rule}
+ *     @Rule
  *     public EmbeddedActiveMQResource server = new EmbeddedActiveMQResource();
  *
- *    {@code @Test}
+ *     @Test
  *     public void testSomething() throws Exception {
  *         // Use the embedded server here
  *     }

artemis-junit/src/main/java/org/apache/activemq/artemis/junit/EmbeddedJMSResource.java

@@ -63,10 +63,10 @@ import org.slf4j.LoggerFactory;
  *
  * <pre><code>
  * public class SimpleTest {
- *    {@code @Rule}
+ *     @Rule
  *     public EmbeddedJMSResource server = new EmbeddedJMSResource();
  *
- *    {@code @Test}
+ *     @Test
  *     public void testSomething() throws Exception {
  *         // Use the embedded server here
  *     }
@@ -213,7 +213,7 @@ public class EmbeddedJMSResource extends ExternalResource {
 
    /**
     * Start the embedded EmbeddedJMSResource.
-    * <p/>
+    * <p>
     * The server will normally be started by JUnit using the before() method.  This method allows the server to
     * be started manually to support advanced testing scenarios.
     */
@@ -228,7 +228,7 @@ public class EmbeddedJMSResource extends ExternalResource {
 
    /**
     * Stop the embedded ActiveMQ broker, blocking until the broker has stopped.
-    * <p/>
+    * <p>
     * The broker will normally be stopped by JUnit using the after() method.  This method allows the broker to
     * be stopped manually to support advanced testing scenarios.
     */
@@ -250,7 +250,7 @@ public class EmbeddedJMSResource extends ExternalResource {
 
    /**
     * Start the embedded ActiveMQ Broker
-    * <p/>
+    * <p>
     * Invoked by JUnit to setup the resource
     */
    @Override
@@ -264,7 +264,7 @@ public class EmbeddedJMSResource extends ExternalResource {
 
    /**
     * Stop the embedded ActiveMQ Broker
-    * <p/>
+    * <p>
     * Invoked by JUnit to tear down the resource
     */
    @Override
@@ -278,7 +278,7 @@ public class EmbeddedJMSResource extends ExternalResource {
 
    /**
     * Get the EmbeddedJMS server.
-    * <p/>
+    * <p>
     * This may be required for advanced configuration of the EmbeddedJMS server.
     *
     * @return
@@ -323,7 +323,7 @@ public class EmbeddedJMSResource extends ExternalResource {
 
    /**
     * Get the Queue corresponding to a JMS Destination.
-    * <p/>
+    * <p>
     * The full name of the JMS destination including the prefix should be provided - i.e. queue://myQueue
     * or topic://myTopic.  If the destination type prefix is not included in the destination name, a prefix
     * of "queue://" is assumed.
@@ -359,7 +359,7 @@ public class EmbeddedJMSResource extends ExternalResource {
 
    /**
     * Get the Queues corresponding to a JMS Topic.
-    * <p/>
+    * <p>
     * The full name of the JMS Topic including the prefix should be provided - i.e. topic://myTopic.  If the destination type prefix
     * is not included in the destination name, a prefix of "topic://" is assumed.
     *
@@ -391,7 +391,7 @@ public class EmbeddedJMSResource extends ExternalResource {
 
    /**
     * Get the number of messages in a specific JMS Destination.
-    * <p/>
+    * <p>
     * The full name of the JMS destination including the prefix should be provided - i.e. queue://myQueue
     * or topic://myTopic.  If the destination type prefix is not included in the destination name, a prefix
     * of "queue://" is assumed.

artemis-junit/src/main/java/org/apache/activemq/artemis/junit/ThreadLeakCheckRule.java

@@ -52,7 +52,7 @@ public class ThreadLeakCheckRule extends ExternalResource {
    /**
     * Override to set up your specific external resource.
     *
-    * @throws if setup fails (which will disable {@code after}
+    * @throws Throwable if setup fails (which will disable {@code after})
     */
    @Override
    protected void before() throws Throwable {

artemis-protocols/artemis-amqp-protocol/src/main/java/org/apache/activemq/artemis/protocol/amqp/converter/message/AMQPMessageIdHelper.java

@@ -31,7 +31,6 @@ import org.apache.qpid.proton.amqp.UnsignedLong;
  * Helper class for identifying and converting message-id and correlation-id values between the
  * AMQP types and the Strings values used by JMS.
  * <p>
- * <p>
  * AMQP messages allow for 4 types of message-id/correlation-id: message-id-string,
  * message-id-binary, message-id-uuid, or message-id-ulong. In order to accept or return a
  * string representation of these for interoperability with other AMQP clients, the following
@@ -43,12 +42,10 @@ import org.apache.qpid.proton.amqp.UnsignedLong;
  * {@literal "AMQP_ULONG:<string representation of ulong>"}<br>
  * {@literal "AMQP_STRING:<string>"}<br>
  * <p>
- * <p>
  * The AMQP_STRING encoding exists only for escaping message-id-string values that happen to
  * begin with one of the encoding prefixes (including AMQP_STRING itself). It MUST NOT be used
  * otherwise.
  * <p>
- * <p>
  * When provided a string for conversion which attempts to identify itself as an encoded binary,
  * uuid, or ulong but can't be converted into the indicated format, an exception will be thrown.
  */

artemis-protocols/artemis-amqp-protocol/src/main/java/org/apache/activemq/artemis/protocol/amqp/converter/message/OutboundTransformer.java

@@ -43,8 +43,10 @@ public abstract class OutboundTransformer {
     *
     * @return the message format key of the encoded message.
     *
-    * @throws Exception
+    * @throws JMSException
     *         if an error occurs during message transformation
+    * @throws UnsupportedEncodingException
+    *         if an error occurs during message encoding
     */
    public abstract long transform(ServerJMSMessage message, WritableBuffer buffer) throws JMSException, UnsupportedEncodingException;
 

artemis-server/src/main/java/org/apache/activemq/artemis/core/config/storage/DatabaseStorageConfiguration.java

@@ -103,8 +103,8 @@ public class DatabaseStorageConfiguration implements StoreConfiguration {
 
    /**
     * The {@link SQLProvider.Factory} used to communicate with the JDBC data store.
-    * It can be {@code null}. If the value is {@code null} and {@code dataSource} is set, the {@code {@link org.apache.activemq.artemis.jdbc.store.sql.GenericSQLProvider.Factory} will be user,
-    * else the type of the factory will be determined based on the {@code jdbcDriverClassName).
+    * It can be {@code null}. If the value is {@code null} and {@code dataSource} is set, the {@code {@link org.apache.activemq.artemis.jdbc.store.sql.GenericSQLProvider.Factory}} will be used,
+    * else the type of the factory will be determined based on the {@code jdbcDriverClassName}.
     *
     * @return the factory used to communicate with the JDBC data store.
     */

artemis-server/src/main/java/org/apache/activemq/artemis/core/paging/PagingManager.java

@@ -27,7 +27,7 @@ import org.apache.activemq.artemis.core.settings.HierarchicalRepositoryChangeLis
  * <PRE>
  *
  * +--------------+      1  +----------------+       N +--------------+       N +--------+       1 +-------------------+
- * | {@link org.apache.activemq.artemis.core.postoffice.PostOffice} |-------&gt; |{@link PagingManager}|-------&gt; |{@link PagingStore} | ------&gt; | {@link org.apache.activemq.artemis.core.paging.impl.Page}  | ------&gt; | {@link SequentialFile} |
+ * | {@link org.apache.activemq.artemis.core.postoffice.PostOffice} |-------&gt; |{@link PagingManager}|-------&gt; |{@link PagingStore} | ------&gt; | {@link org.apache.activemq.artemis.core.paging.impl.Page}  | ------&gt; | {@link org.apache.activemq.artemis.core.io.SequentialFile} |
  * +--------------+         +----------------+         +--------------+         +--------+         +-------------------+
  * |                  1 ^
  * |                    |
@@ -97,7 +97,7 @@ public interface PagingManager extends ActiveMQComponent, HierarchicalRepository
 
    /**
     * Add size at the global count level.
-    * if totalSize > globalMaxSize it will return true
+    * if totalSize &gt; globalMaxSize it will return true
     */
    PagingManager addSize(int size);
 

artemis-server/src/main/java/org/apache/activemq/artemis/core/paging/PagingStore.java

@@ -166,7 +166,7 @@ public interface PagingStore extends ActiveMQComponent {
    /**
     * Sends the pages with given IDs to the {@link ReplicationManager}.
     * <p>
-    * Sending is done here to avoid exposing the internal {@link SequentialFile}s.
+    * Sending is done here to avoid exposing the internal {@link org.apache.activemq.artemis.core.io.SequentialFile}s.
     *
     * @param replicator
     * @param pageIds

artemis-server/src/main/java/org/apache/activemq/artemis/core/server/ActiveMQServer.java

@@ -279,7 +279,7 @@ public interface ActiveMQServer extends ActiveMQComponent {
     * @param name
     * @param filterString
     * @param durable
-    * @throws ActiveMQInvalidTransientQueueUseException if the shared queue already exists with a different {@code address} or {@code filter}
+    * @throws org.apache.activemq.artemis.api.core.ActiveMQInvalidTransientQueueUseException if the shared queue already exists with a different {@code address} or {@code filterString}
     * @throws NullPointerException                      if {@code address} is {@code null}
     */
    void createSharedQueue(final SimpleString address,

artemis-server/src/main/java/org/apache/activemq/artemis/spi/core/security/jaas/TextFileCertificateLoginModule.java

@@ -27,8 +27,8 @@ import java.util.Set;
 /**
  * A LoginModule allowing for SSL certificate based authentication based on
  * Distinguished Names (DN) stored in text files. The DNs are parsed using a
- * Properties class where each line is <user_name>=<user_DN>. This class also
- * uses a group definition file where each line is <role_name>=<user_name_1>,<user_name_2>,etc.
+ * Properties class where each line is &lt;user_name&gt;=&lt;user_DN&gt;. This class also
+ * uses a group definition file where each line is &lt;role_name&gt;=&lt;user_name_1&gt;,&lt;user_name_2&gt;,etc.
  * The user and role files' locations must be specified in the
  * org.apache.activemq.jaas.textfiledn.user and
  * org.apache.activemq.jaas.textfiledn.role properties respectively. NOTE: This

pom.xml

@@ -692,7 +692,11 @@
                   <groupId>org.apache.maven.plugins</groupId>
                   <artifactId>maven-javadoc-plugin</artifactId>
                   <configuration>
-                     <additionalparam>-Xdoclint:none</additionalparam>
+                     <additionalparam>
+                        -Xdoclint:all
+                        -Xdoclint:-missing
+                        -Xdoclint:-syntax
+                     </additionalparam>
                   </configuration>
                </plugin>
             </plugins>

tests/artemis-test-support/src/main/java/org/apache/activemq/transport/amqp/client/AmqpClient.java

@@ -63,7 +63,7 @@ public class AmqpClient {
     * connect attempt immediately and will fail if the remote peer cannot be reached.
     *
     * @throws Exception if an error occurs attempting to connect to the Broker.
-    * @returns a new connection object used to interact with the connected peer.
+    * @return a new connection object used to interact with the connected peer.
     */
    public AmqpConnection connect() throws Exception {
 
@@ -82,7 +82,7 @@ public class AmqpClient {
     * changes applied before the <code>connect</code> method is invoked.
     *
     * @throws Exception if an error occurs attempting to connect to the Broker.
-    * @returns a new connection object used to interact with the connected peer.
+    * @return a new connection object used to interact with the connected peer.
     */
    public AmqpConnection createConnection() throws Exception {
       if (username == null && password != null) {
@@ -218,7 +218,7 @@ public class AmqpClient {
     *
     * @param broker the address of the remote broker instance.
     * @throws Exception if an error occurs attempting to connect to the Broker.
-    * @returns a new connection object used to interact with the connected peer.
+    * @return a new connection object used to interact with the connected peer.
     */
    public static AmqpConnection connect(URI broker) throws Exception {
       return connect(broker, null, null);
@@ -231,7 +231,7 @@ public class AmqpClient {
     * @param username the user name to use to connect to the broker or null for anonymous.
     * @param password the password to use to connect to the broker, must be null if user name is null.
     * @throws Exception if an error occurs attempting to connect to the Broker.
-    * @returns a new connection object used to interact with the connected peer.
+    * @return a new connection object used to interact with the connected peer.
     */
    public static AmqpConnection connect(URI broker, String username, String password) throws Exception {
       if (username == null && password != null) {

tests/artemis-test-support/src/main/java/org/apache/activemq/transport/amqp/client/AmqpMessage.java

@@ -150,7 +150,7 @@ public class AmqpMessage {
    /**
     * Accepts the message marking it as consumed on the remote peer.
     *
-    * @param session The session that is used to manage acceptance of the message.
+    * @param txnSession The session that is used to manage acceptance of the message.
     * @throws Exception if an error occurs during the accept.
     */
    public void accept(AmqpSession txnSession) throws Exception {
@@ -160,7 +160,7 @@ public class AmqpMessage {
    /**
     * Accepts the message marking it as consumed on the remote peer.
     *
-    * @param session
+    * @param txnSession
     *      The session that is used to manage acceptance of the message.
     *
     * @throws Exception if an error occurs during the accept.
@@ -354,7 +354,7 @@ public class AmqpMessage {
    /**
     * Sets the GroupId property on an outbound message using the provided String
     *
-    * @param messageId the String Group ID value to set.
+    * @param groupId the String Group ID value to set.
     */
    public void setGroupId(String groupId) {
       checkReadOnly();
@@ -505,7 +505,7 @@ public class AmqpMessage {
     * Sets a byte array value into the body of an outgoing Message, throws
     * an exception if this is an incoming message instance.
     *
-    * @param value the byte array value to store in the Message body.
+    * @param bytes the byte array value to store in the Message body.
     * @throws IllegalStateException if the message is read only.
     */
    public void setBytes(byte[] bytes) throws IllegalStateException {
@@ -515,10 +515,10 @@ public class AmqpMessage {
    }
 
    /**
-    * Sets a byte array value into the body of an outgoing Message, throws
+    * Sets a described type into the body of an outgoing Message, throws
     * an exception if this is an incoming message instance.
     *
-    * @param value the byte array value to store in the Message body.
+    * @param described the described type value to store in the Message body.
     * @throws IllegalStateException if the message is read only.
     */
    public void setDescribedType(DescribedType described) throws IllegalStateException {

tests/artemis-test-support/src/main/java/org/apache/activemq/transport/amqp/client/sasl/Mechanism.java

@@ -103,7 +103,7 @@ public interface Mechanism extends Comparable<Mechanism> {
    String getPassword();
 
    /**
-    * Sets any additional Mechanism specific properties using a Map<String, Object>
+    * Sets any additional Mechanism specific properties using a Map&lt;String, Object&gt;
     *
     * @param options the map of additional properties that this Mechanism should utilize.
     */