This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new d7209d14a05a CAMEL-21356 - Javadoc compliance with doclint for Java 17
in camel-core-xml (#29662)
d7209d14a05a is described below
commit d7209d14a05a23cd0d4c15bbaf88d5b5c3ccccba
Author: Loris Boiteux <[email protected]>
AuthorDate: Thu Nov 12 13:03:32 2026 +0100
CAMEL-21356 - Javadoc compliance with doclint for Java 17 in camel-core-xml
(#29662)
* CAMEL-21356: Javadoc compliance with doclint in camel-core-xml
Replace <tt> with <code> and self-closing <p/> with <p>, and fix
pre-existing wording in the touched Javadoc blocks.
Co-authored-by: Claude Opus 5.5 <[email protected]>
* CAMEL-21356: Align the @Metadata description of the endpoint uri and
regenerate endpoint.json
The endpoint.json description comes from the @Metadata annotation, not
from the Javadoc, so fix "a series of property" there as well and commit
the regenerated camel-spring-xml endpoint.json.
Co-authored-by: Claude Opus 5.5 <[email protected]>
* Regen
---------
Co-authored-by: Claude Opus 5.5 <[email protected]>
Co-authored-by: Guillaume Nodet <[email protected]>
---
.../apache/camel/catalog/schemas/camel-spring.xsd | 2 +-
.../org/apache/camel/spring/xml/endpoint.json | 2 +-
.../core/xml/AbstractCamelEndpointFactoryBean.java | 6 ++---
.../xml/CamelPropertyPlaceholderDefinition.java | 4 ++--
.../core/xml/CamelRouteControllerDefinition.java | 8 +++----
.../xml/CamelStreamCachingStrategyDefinition.java | 28 +++++++++++-----------
6 files changed, 25 insertions(+), 25 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
index 172cbd912be0..92befe4050b2 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
@@ -2486,7 +2486,7 @@ The id of this node.
<xs:documentation xml:lang="en">
<![CDATA[
Sets the URI to use to resolve the endpoint. Notice that additional options
can be configured using a series of
-property.
+properties.
]]>
</xs:documentation>
</xs:annotation>
diff --git
a/components/camel-spring-parent/camel-spring-xml/src/generated/resources/META-INF/org/apache/camel/spring/xml/endpoint.json
b/components/camel-spring-parent/camel-spring-xml/src/generated/resources/META-INF/org/apache/camel/spring/xml/endpoint.json
index 2280a86a41fd..0b044dfef4aa 100644
---
a/components/camel-spring-parent/camel-spring-xml/src/generated/resources/META-INF/org/apache/camel/spring/xml/endpoint.json
+++
b/components/camel-spring-parent/camel-spring-xml/src/generated/resources/META-INF/org/apache/camel/spring/xml/endpoint.json
@@ -13,7 +13,7 @@
},
"properties": {
"id": { "index": 0, "kind": "attribute", "displayName": "Id", "group":
"common", "required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description": "The
id of this node" },
- "uri": { "index": 1, "kind": "attribute", "displayName": "Uri", "group":
"common", "required": true, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the URI to use to resolve the endpoint. Notice that additional options can be
configured using a series of property." },
+ "uri": { "index": 1, "kind": "attribute", "displayName": "Uri", "group":
"common", "required": true, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the URI to use to resolve the endpoint. Notice that additional options can be
configured using a series of properties." },
"camelContextId": { "index": 2, "kind": "attribute", "displayName": "Camel
Context Id", "group": "common", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Id of CamelContext to use if there are
multiple CamelContexts in the same JVM" }
}
}
diff --git
a/core/camel-core-xml/src/main/java/org/apache/camel/core/xml/AbstractCamelEndpointFactoryBean.java
b/core/camel-core-xml/src/main/java/org/apache/camel/core/xml/AbstractCamelEndpointFactoryBean.java
index 10d7a0f89bea..ba06daed526b 100644
---
a/core/camel-core-xml/src/main/java/org/apache/camel/core/xml/AbstractCamelEndpointFactoryBean.java
+++
b/core/camel-core-xml/src/main/java/org/apache/camel/core/xml/AbstractCamelEndpointFactoryBean.java
@@ -37,7 +37,7 @@ import org.apache.camel.util.URISupport;
@XmlAccessorType(XmlAccessType.FIELD)
public abstract class AbstractCamelEndpointFactoryBean extends
AbstractCamelFactoryBean<Endpoint> {
@XmlAttribute(required = true)
- @Metadata(description = "Sets the URI to use to resolve the endpoint.
Notice that additional options can be configured using a series of property.")
+ @Metadata(description = "Sets the URI to use to resolve the endpoint.
Notice that additional options can be configured using a series of properties.")
private String uri;
@XmlElementRef
@Metadata(description = "To configure additional endpoint options using a
XML style which is similar as configuring Spring beans.")
@@ -70,8 +70,8 @@ public abstract class AbstractCamelEndpointFactoryBean
extends AbstractCamelFact
/**
* Sets the URI to use to resolve the endpoint.
- * <p/>
- * Notice that additional options can be configured using a series of
property.
+ * <p>
+ * Notice that additional options can be configured using a series of
properties.
*/
public void setUri(String uri) {
this.uri = uri;
diff --git
a/core/camel-core-xml/src/main/java/org/apache/camel/core/xml/CamelPropertyPlaceholderDefinition.java
b/core/camel-core-xml/src/main/java/org/apache/camel/core/xml/CamelPropertyPlaceholderDefinition.java
index ea07cf4f47de..45f283a05348 100644
---
a/core/camel-core-xml/src/main/java/org/apache/camel/core/xml/CamelPropertyPlaceholderDefinition.java
+++
b/core/camel-core-xml/src/main/java/org/apache/camel/core/xml/CamelPropertyPlaceholderDefinition.java
@@ -73,8 +73,8 @@ public class CamelPropertyPlaceholderDefinition extends
IdentifiedType {
/**
* Encoding to use when loading properties file from the file system or
classpath.
- * <p/>
- * If no encoding has been set, then the properties files is loaded using
ISO-8859-1 encoding (latin-1) as
+ * <p>
+ * If no encoding has been set, then the properties files are loaded using
ISO-8859-1 encoding (latin-1) as
* documented by {@link java.util.Properties#load(java.io.InputStream)}
*/
public void setEncoding(String encoding) {
diff --git
a/core/camel-core-xml/src/main/java/org/apache/camel/core/xml/CamelRouteControllerDefinition.java
b/core/camel-core-xml/src/main/java/org/apache/camel/core/xml/CamelRouteControllerDefinition.java
index 29b331391c63..9bd3c88b3389 100644
---
a/core/camel-core-xml/src/main/java/org/apache/camel/core/xml/CamelRouteControllerDefinition.java
+++
b/core/camel-core-xml/src/main/java/org/apache/camel/core/xml/CamelRouteControllerDefinition.java
@@ -92,8 +92,8 @@ public class CamelRouteControllerDefinition extends
IdentifiedType {
*
* The pattern is matching on route id, and endpoint uri for the route.
Multiple patterns can be separated by comma.
*
- * For example to include all kafka routes, you can say <tt>kafka:*</tt>.
And to include routes with specific route
- * ids <tt>myRoute,myOtherRoute</tt>. The pattern supports wildcards and
uses the matcher from
+ * For example to include all kafka routes, you can say
<code>kafka:*</code>. And to include routes with specific
+ * route ids <code>myRoute,myOtherRoute</code>. The pattern supports
wildcards and uses the matcher from
* org.apache.camel.support.PatternHelper#matchPattern.
*/
public void setIncludeRoutes(String includeRoutes) {
@@ -109,8 +109,8 @@ public class CamelRouteControllerDefinition extends
IdentifiedType {
*
* The pattern is matching on route id, and endpoint uri for the route.
Multiple patterns can be separated by comma.
*
- * For example to exclude all JMS routes, you can say <tt>jms:*</tt>. And
to exclude routes with specific route ids
- * <tt>mySpecialRoute,myOtherSpecialRoute</tt>. The pattern supports
wildcards and uses the matcher from
+ * For example to exclude all JMS routes, you can say <code>jms:*</code>.
And to exclude routes with specific route
+ * ids <code>mySpecialRoute,myOtherSpecialRoute</code>. The pattern
supports wildcards and uses the matcher from
* org.apache.camel.support.PatternHelper#matchPattern.
*/
public void setExcludeRoutes(String excludeRoutes) {
diff --git
a/core/camel-core-xml/src/main/java/org/apache/camel/core/xml/CamelStreamCachingStrategyDefinition.java
b/core/camel-core-xml/src/main/java/org/apache/camel/core/xml/CamelStreamCachingStrategyDefinition.java
index 632777569cc1..1dcabed74535 100644
---
a/core/camel-core-xml/src/main/java/org/apache/camel/core/xml/CamelStreamCachingStrategyDefinition.java
+++
b/core/camel-core-xml/src/main/java/org/apache/camel/core/xml/CamelStreamCachingStrategyDefinition.java
@@ -138,9 +138,9 @@ public class CamelStreamCachingStrategyDefinition extends
IdentifiedType {
/**
* Sets the spool (temporary) directory to use for overflow and spooling
to disk.
- * <p/>
- * If no spool directory has been explicit configured, then a temporary
directory is created in the
- * <tt>java.io.tmpdir</tt> directory.
+ * <p>
+ * If no spool directory has been explicitly configured, then a temporary
directory is created in the
+ * <code>java.io.tmpdir</code> directory.
*/
public void setSpoolDirectory(String spoolDirectory) {
this.spoolDirectory = spoolDirectory;
@@ -152,7 +152,7 @@ public class CamelStreamCachingStrategyDefinition extends
IdentifiedType {
/**
* Sets a cipher name to use when spooling to disk to write with
encryption.
- * <p/>
+ * <p>
* By default the data is not encrypted.
*/
public void setSpoolCipher(String spoolCipher) {
@@ -165,9 +165,9 @@ public class CamelStreamCachingStrategyDefinition extends
IdentifiedType {
/**
* Threshold in bytes when overflow to disk is activated.
- * <p/>
+ * <p>
* The default threshold is {@link
org.apache.camel.StreamCache#DEFAULT_SPOOL_THRESHOLD} bytes (eg 128kb). Use
- * <tt>-1</tt> to disable overflow to disk.
+ * <code>-1</code> to disable overflow to disk.
*/
public void setSpoolThreshold(String spoolThreshold) {
this.spoolThreshold = spoolThreshold;
@@ -213,7 +213,7 @@ public class CamelStreamCachingStrategyDefinition extends
IdentifiedType {
/**
* Sets the buffer size to use when allocating in-memory buffers used for
in-memory stream caches.
- * <p/>
+ * <p>
* The default size is {@link
org.apache.camel.util.IOHelper#DEFAULT_BUFFER_SIZE}
*/
public void setBufferSize(String bufferSize) {
@@ -226,8 +226,8 @@ public class CamelStreamCachingStrategyDefinition extends
IdentifiedType {
/**
* Whether to remove the temporary directory when stopping.
- * <p/>
- * This option is default <tt>true</tt>
+ * <p>
+ * This option is default <code>true</code>
*/
public void setRemoveSpoolDirectoryWhenStopping(String
removeSpoolDirectoryWhenStopping) {
this.removeSpoolDirectoryWhenStopping =
removeSpoolDirectoryWhenStopping;
@@ -249,11 +249,11 @@ public class CamelStreamCachingStrategyDefinition extends
IdentifiedType {
}
/**
- * Sets whether if just any of the {@link
org.apache.camel.spi.StreamCachingStrategy.SpoolRule} rules returns
- * <tt>true</tt> then shouldSpoolCache(long) returns <tt>true</tt>. If
this option is <tt>false</tt>, then
- * <b>all</b> the {@link
org.apache.camel.spi.StreamCachingStrategy.SpoolRule} must return <tt>true</tt>.
- * <p/>
- * The default value is <tt>false</tt> which means that all the rules must
return <tt>true</tt>.
+ * Sets whether, if any of the {@link
org.apache.camel.spi.StreamCachingStrategy.SpoolRule} rules returns
+ * <code>true</code>, then shouldSpoolCache(long) returns
<code>true</code>. If this option is <code>false</code>,
+ * then <b>all</b> the {@link
org.apache.camel.spi.StreamCachingStrategy.SpoolRule} must return
<code>true</code>.
+ * <p>
+ * The default value is <code>false</code> which means that all the rules
must return <code>true</code>.
*/
public void setAnySpoolRules(String anySpoolRules) {
this.anySpoolRules = anySpoolRules;
