activemq-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rob...@apache.org
Subject [activemq-artemis] branch main updated: NO-JIRA: fix javadoc errors on JDK11+, enable CI javadoc check on JDK11+
Date Wed, 02 Jun 2021 16:44:30 GMT
This is an automated email from the ASF dual-hosted git repository.

robbie pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/activemq-artemis.git


The following commit(s) were added to refs/heads/main by this push:
     new c993b5a  NO-JIRA: fix javadoc errors on JDK11+, enable CI javadoc check on JDK11+
c993b5a is described below

commit c993b5a0e9aa6cfdd20d7ec11d96641c2e8dd69b
Author: Robbie Gemmell <robbie@apache.org>
AuthorDate: Wed Jun 2 16:58:25 2021 +0100

    NO-JIRA: fix javadoc errors on JDK11+, enable CI javadoc check on JDK11+
---
 .github/workflows/build.yml                                        | 7 ++++++-
 .../activemq/artemis/core/config/TransformerConfiguration.java     | 2 +-
 .../org/apache/activemq/artemis/core/server/ActiveMQServer.java    | 2 +-
 .../main/java/org/apache/activemq/artemis/core/server/Queue.java   | 4 ++--
 4 files changed, 10 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 3e0d59a..50e6fd5 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -46,7 +46,12 @@ jobs:
           cd examples
           mvn install -Pexamples,noRun
 
-      - name: javadoc check (mvn javadoc:javadoc -Prelease on JDK 8)
+      - name: Javadoc Check (JDK8 / -Prelease)
         if: matrix.java == '8'
         run: |
           mvn javadoc:javadoc -Prelease
+
+      - name: Javadoc Check (JDK 11+)
+        if: matrix.java != '8'
+        run: |
+          mvn javadoc:javadoc
diff --git a/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/config/TransformerConfiguration.java
b/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/config/TransformerConfiguration.java
index 1819679..e05bba9 100644
--- a/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/config/TransformerConfiguration.java
+++ b/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/config/TransformerConfiguration.java
@@ -55,7 +55,7 @@ public final class TransformerConfiguration implements Serializable {
     * <p><ul>
     * <li>class-name - a string value,
     * <li>properties - an object containing string key-value pairs.
-    * </ul></p>
+    * </ul>
     *
     * @param jsonString json string
     * @return the {@code TransformerConfiguration} created from the JSON-formatted input
{@code String}
diff --git a/artemis-server/src/main/java/org/apache/activemq/artemis/core/server/ActiveMQServer.java
b/artemis-server/src/main/java/org/apache/activemq/artemis/core/server/ActiveMQServer.java
index 2d6eb63..33d8d18 100644
--- a/artemis-server/src/main/java/org/apache/activemq/artemis/core/server/ActiveMQServer.java
+++ b/artemis-server/src/main/java/org/apache/activemq/artemis/core/server/ActiveMQServer.java
@@ -880,7 +880,7 @@ public interface ActiveMQServer extends ServiceComponent {
     * This atomicity is necessary to prevent {@link #stop()} to stop the component right
after adding it, but before
     * starting it.
     *
-    * @throw IllegalStateException if the state is {@link SERVER_STATE#STOPPED} or {@link
SERVER_STATE#STOPPING}
+    * @throws IllegalStateException if the state is {@link SERVER_STATE#STOPPED} or {@link
SERVER_STATE#STOPPING}
     */
    void addExternalComponent(ActiveMQComponent externalComponent, boolean start) throws Exception;
 
diff --git a/artemis-server/src/main/java/org/apache/activemq/artemis/core/server/Queue.java
b/artemis-server/src/main/java/org/apache/activemq/artemis/core/server/Queue.java
index e08274a..193d0ed 100644
--- a/artemis-server/src/main/java/org/apache/activemq/artemis/core/server/Queue.java
+++ b/artemis-server/src/main/java/org/apache/activemq/artemis/core/server/Queue.java
@@ -73,8 +73,8 @@ public interface Queue extends Bindable,CriticalComponent {
 
    void refDown(MessageReference messageReference);
 
-   /** Remove item with a supplied positivie (>= 0) ID.
-    *  if the idSupplier return <0 the ID is considered a non value (null) and it will
be ignored
+   /** Remove item with a supplied non-negative {@literal (>= 0) } ID.
+    *  If the idSupplier returns {@literal < 0} the ID is considered a non value (null)
and it will be ignored.
     *
     *  @see org.apache.activemq.artemis.utils.collections.LinkedList#setIDSupplier(ToLongFunction)
*/
    MessageReference removeWithSuppliedID(long id, ToLongFunction<MessageReference>
idSupplier);

Mime
View raw message