Skip to content

Commit

Permalink
ARTEMIS-5312 reduce build-time warnings for JavaDoc
Browse files Browse the repository at this point in the history
There are number of warnings related to JavaDoc during the build. This
commit adjusts a handful of specifica JavaDoc comments to eliminate
warnings about empty <p> tags. It also modifies the configuration of the
Maven JavaDoc plugin to categorically prevent warnings about "missing"
JavaDoc comments on public methods, etc.
  • Loading branch information
jbertram authored and clebertsuconic committed Feb 13, 2025
1 parent e0c63ca commit 6f15e33
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 18 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@
/**
* This class holds all the properties required to configure a queue. The only strictly required property is
* {@code name}. Some defaults will be enforced for properties which are not explicitly set:
* <p><ul>
* <ul>
* <li>{@code address} : the value set for {@code name}
* <li>{@code transient} : {@code false}
* <li>{@code temporary} : {@code false}
* <li>{@code durable} : {@code true}
* <li>{@code autoCreated} : {@code false}
* <li>{@code internal} : {@code false}
* <li>{@code configurationManaged} : {@code false}
* </ul><p>
* </ul>
*/
public class QueueConfiguration implements Serializable {

Expand Down Expand Up @@ -223,7 +223,7 @@ public QueueConfiguration(String name) {
/**
* Set the value of a parameter based on its "key" {@code String}. Valid key names and corresponding {@code static}
* {@code final} are:
* <p><ul>
* <ul>
* <li>id: {@link #ID}
* <li>name: {@link #NAME}
* <li>address: {@link #ADDRESS}
Expand Down Expand Up @@ -254,7 +254,7 @@ public QueueConfiguration(String name) {
* <li>internal: {@link #INTERNAL}
* <li>transient: {@link #TRANSIENT}
* <li>auto-created: {@link #AUTO_CREATED}
* </ul><p>
* </ul>
* The {@code String}-based values will be converted to the proper value types based on the underlying property. For
* example, if you pass the value "TRUE" for the key "auto-created" the {@code String} "TRUE" will be converted to
* the {@code Boolean} {@code true}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ interface QueueQuery {
* details on configuration specifics.
* <p>
* Some static defaults will be enforced for properties which are not set on the {@code QueueConfiguration}:
* <p><ul>
* <ul>
* <li>{@code transient} : {@code false}
* <li>{@code temporary} : {@code false}
* <li>{@code durable} : {@code true}
Expand All @@ -310,9 +310,9 @@ interface QueueQuery {
* <li>{@code configurationManaged} : {@code false}
* <li>{@code maxConsumers} : {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#getDefaultMaxQueueConsumers()}
* <li>{@code purgeOnNoConsumers} : {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#getDefaultPurgeOnNoConsumers()}
* </ul><p>
* </ul>
* Some dynamic defaults will be enforced via address-settings for the corresponding unset properties:
* <p><ul>
* <ul>
* <li>{@code exclusive}
* <li>{@code groupRebalance}
* <li>{@code groupBuckets}
Expand All @@ -328,7 +328,7 @@ interface QueueQuery {
* <li>{@code autoDelete} (only set if queue was auto-created)
* <li>{@code autoDeleteDelay}
* <li>{@code autoDeleteMessageCount}
* </ul><p>
* </ul>
*
* @param queueConfiguration the configuration to use when creating the queue
* @throws ActiveMQException
Expand All @@ -339,15 +339,15 @@ interface QueueQuery {
* This method is essentially the same as {@link #createQueue(QueueConfiguration)} with a few key exceptions.
* <p>
* If {@code durable} is {@code true} then:
* <p><ul>
* <ul>
* <li>{@code transient} will be forced to {@code false}
* <li>{@code temporary} will be forced to {@code false}
* </ul><p>
* </ul>
* If {@code durable} is {@code false} then:
* <p><ul>
* <ul>
* <li>{@code transient} will be forced to {@code true}
* <li>{@code temporary} will be forced to {@code true}
* </ul><p>
* </ul>
* In all instances {@code autoCreated} will be forced to {@code false} and {@code autoCreatedAddress} will be forced
* to {@code true}.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ public interface TopologyMember {
* <p>
* This is a server configuration value. An active server will only send its messages to another active server
* with matching {@code scale-down-group-name}.
* <p>
*
* @return the {@code scale-down-group-name}
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ public Map<String, String> getProperties() {
* This method returns a {@code TransformerConfiguration} created from the JSON-formatted input {@code String}.
* The input should contain these entries:
*
* <p><ul>
* <ul>
* <li>class-name - a string value,
* <li>properties - an object containing string key-value pairs.
* </ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ public BridgeConfiguration(String name) {
/**
* Set the value of a parameter based on its "key" {@code String}. Valid key names and corresponding {@code static}
* {@code final} are:
* <p><ul>
* <ul>
* <li>name: {@link #NAME}
* <li>queue-name: {@link #QUEUE_NAME}
* <li>forwarding-address: {@link #FORWARDING_ADDRESS}
Expand All @@ -199,7 +199,7 @@ public BridgeConfiguration(String name) {
* <li>routing-type: {@link #ROUTING_TYPE}
* <li>concurrency: {@link #CONCURRENCY}
* <li>client-id: {@link #CLIENT_ID}
* </ul><p>
* </ul>
* The {@code String}-based values will be converted to the proper value types based on the underlying property. For
* example, if you pass the value "TRUE" for the key "auto-created" the {@code String} "TRUE" will be converted to
* the {@code Boolean} {@code true}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ public DivertConfiguration() {
/**
* Set the value of a parameter based on its "key" {@code String}. Valid key names and corresponding {@code static}
* {@code final} are:
* <p><ul>
* <ul>
* <li>name: {@link #NAME}
* <li>routing-name: {@link #ROUTING_NAME}
* <li>address: {@link #ADDRESS}
Expand All @@ -77,7 +77,7 @@ public DivertConfiguration() {
* <li>filter-string: {@link #FILTER_STRING}
* <li>transformer-configuration: {@link #TRANSFORMER_CONFIGURATION}
* <li>routing-type: {@link #ROUTING_TYPE}
* </ul><p>
* </ul>
* The {@code String}-based values will be converted to the proper value types based on the underlying property. For
* example, if you pass the value "TRUE" for the key "exclusive" the {@code String} "TRUE" will be converted to
* the {@code Boolean} {@code true}.
Expand Down
1 change: 1 addition & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1051,6 +1051,7 @@
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<noindex>true</noindex>
<doclint>all,-missing</doclint>
</configuration>
</plugin>
<plugin>
Expand Down

0 comments on commit 6f15e33

Please sign in to comment.