You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by gz...@apache.org on 2026/04/23 11:52:18 UTC
(camel) branch main updated: Fix escaping code in Javadoc comments
This is an automated email from the ASF dual-hosted git repository.
gzurowski 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 d18aa2729f65 Fix escaping code in Javadoc comments
d18aa2729f65 is described below
commit d18aa2729f65b1c9f13cb95e1a54d96d202644c0
Author: Gregor Zurowski <gr...@zurowski.org>
AuthorDate: Thu Apr 23 13:52:02 2026 +0200
Fix escaping code in Javadoc comments
This is to fix the following maven-javadoc-plugin error during
release:
```
[INFO] [ERROR] /git/camel/core/camel-util/src/main/java/org/apache/camel/util/StringHelper.java:228: warning: invalid input: '<'
[INFO] [ERROR] * Encodes the text into safe XML by replacing < > and & with XML tokens
```
---
.../main/java/org/apache/camel/util/StringHelper.java | 2 +-
.../main/java/org/apache/camel/util/URISupport.java | 18 +++++++++---------
2 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/core/camel-util/src/main/java/org/apache/camel/util/StringHelper.java b/core/camel-util/src/main/java/org/apache/camel/util/StringHelper.java
index 314cd518d3fd..c2dd5c4f3cc2 100644
--- a/core/camel-util/src/main/java/org/apache/camel/util/StringHelper.java
+++ b/core/camel-util/src/main/java/org/apache/camel/util/StringHelper.java
@@ -225,7 +225,7 @@ public final class StringHelper {
}
/**
- * Encodes the text into safe XML by replacing < > and & with XML tokens
+ * Encodes the text into safe XML by replacing {@code <}, {@code >}, and {@code &} with XML tokens.
*
* @param text the text
* @return the encoded text
diff --git a/core/camel-util/src/main/java/org/apache/camel/util/URISupport.java b/core/camel-util/src/main/java/org/apache/camel/util/URISupport.java
index beaec95280f8..84127b3a501f 100644
--- a/core/camel-util/src/main/java/org/apache/camel/util/URISupport.java
+++ b/core/camel-util/src/main/java/org/apache/camel/util/URISupport.java
@@ -252,8 +252,8 @@ public final class URISupport {
*
* @param uri the uri
* @param useRaw whether to force using raw values
- * @param lenient whether to parse lenient and ignore trailing & markers which has no key or value which
- * can happen when using HTTP components
+ * @param lenient whether to parse lenient and ignore trailing {@code &} markers that have no key or
+ * value, which can happen when using HTTP components
* @return the parameters, or an empty map if no parameters (eg never null)
* @throws URISyntaxException is thrown if uri has invalid syntax.
* @see #RAW_TOKEN_PREFIX
@@ -499,8 +499,8 @@ public final class URISupport {
* Assembles a query from the given map.
*
* @param options the map with the options (eg key/value pairs)
- * @return a query string with <tt>key1=value&key2=value2&...</tt>, or an empty string if there is no
- * options.
+ * @return a query string with {@code key1=value&key2=value2&...}, or an empty string if there are no
+ * options
*/
public static String createQueryString(Map<String, Object> options) {
final Set<String> keySet = options.keySet();
@@ -512,8 +512,8 @@ public final class URISupport {
*
* @param options the map with the options (eg key/value pairs)
* @param encode whether to URL encode the query string
- * @return a query string with <tt>key1=value&key2=value2&...</tt>, or an empty string if there is no
- * options.
+ * @return a query string with {@code key1=value&key2=value2&...}, or an empty string if there are no
+ * options
*/
public static String createQueryString(Map<String, Object> options, boolean encode) {
return createQueryString(options.keySet(), options, encode);
@@ -561,9 +561,9 @@ public final class URISupport {
* Assembles a query from the given map.
*
* @param options the map with the options (eg key/value pairs)
- * @param ampersand to use & for Java code, and & for XML
- * @return a query string with <tt>key1=value&key2=value2&...</tt>, or an empty string if there
- * is no options.
+ * @param ampersand to use {@code &} for Java code, and {@code &} for XML
+ * @return a query string with {@code key1=value&key2=value2&...}, or an empty string if there
+ * are no options
* @throws URISyntaxException is thrown if uri has invalid syntax.
*/
@Deprecated(since = "4.1.0")