You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by pa...@apache.org on 2019/12/29 12:43:07 UTC
[camel] branch master updated: Fix "javadoc @param tags that do not
match any parameters in the method" problems identified by lgtm.com.
This is an automated email from the ASF dual-hosted git repository.
pascalschumacher pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/master by this push:
new 078d235 Fix "javadoc @param tags that do not match any parameters in the method" problems identified by lgtm.com.
078d235 is described below
commit 078d235b87806a65a9207a774b4626e179f49b73
Author: Pascal Schumacher <pa...@gmx.net>
AuthorDate: Sun Dec 29 13:42:46 2019 +0100
Fix "javadoc @param tags that do not match any parameters in the method" problems identified by lgtm.com.
---
.../org/apache/camel/component/dns/types/DnsRecordConverter.java | 2 +-
.../java/org/apache/camel/component/johnzon/JohnzonDataFormat.java | 4 ++--
.../propagation/CamelMessagingHeadersExtractAdapter.java | 2 --
.../camel/component/salesforce/api/dto/composite/SObjectBatch.java | 7 +++----
.../org/apache/camel/component/ssh/SshShellOutputStringHelper.java | 4 ++--
.../component/xmlsecurity/api/DefaultXmlSignature2Message.java | 3 ---
.../apache/camel/component/xmlsecurity/api/XmlSignatureHelper.java | 2 --
.../src/main/java/org/apache/camel/util/ObjectHelper.java | 2 +-
.../src/main/java/org/apache/camel/util/json/Jsoner.java | 2 --
9 files changed, 9 insertions(+), 19 deletions(-)
diff --git a/components/camel-dns/src/main/java/org/apache/camel/component/dns/types/DnsRecordConverter.java b/components/camel-dns/src/main/java/org/apache/camel/component/dns/types/DnsRecordConverter.java
index 0a1c7fb..526100a 100644
--- a/components/camel-dns/src/main/java/org/apache/camel/component/dns/types/DnsRecordConverter.java
+++ b/components/camel-dns/src/main/java/org/apache/camel/component/dns/types/DnsRecordConverter.java
@@ -39,7 +39,7 @@ public final class DnsRecordConverter {
}
/**
- * @param ip, like "192.168.1.1"
+ * @param ip like "192.168.1.1"
* @return the complete DNS record for that IP.
*/
@Converter
diff --git a/components/camel-johnzon/src/main/java/org/apache/camel/component/johnzon/JohnzonDataFormat.java b/components/camel-johnzon/src/main/java/org/apache/camel/component/johnzon/JohnzonDataFormat.java
index 5296b33..92b6780 100644
--- a/components/camel-johnzon/src/main/java/org/apache/camel/component/johnzon/JohnzonDataFormat.java
+++ b/components/camel-johnzon/src/main/java/org/apache/camel/component/johnzon/JohnzonDataFormat.java
@@ -65,9 +65,9 @@ public class JohnzonDataFormat extends ServiceSupport implements DataFormat, Dat
/**
* Use the default Johnzon {@link Mapper} and with a custom
- * unmarshal type
+ * parameterized type
*
- * @param unmarshalType the custom unmarshal type
+ * @param parameterizedType the custom parameterized type
*/
public JohnzonDataFormat(JohnzonParameterizedType parameterizedType) {
this(null, parameterizedType);
diff --git a/components/camel-opentracing/src/main/java/org/apache/camel/opentracing/propagation/CamelMessagingHeadersExtractAdapter.java b/components/camel-opentracing/src/main/java/org/apache/camel/opentracing/propagation/CamelMessagingHeadersExtractAdapter.java
index e4b23a1..8426872 100644
--- a/components/camel-opentracing/src/main/java/org/apache/camel/opentracing/propagation/CamelMessagingHeadersExtractAdapter.java
+++ b/components/camel-opentracing/src/main/java/org/apache/camel/opentracing/propagation/CamelMessagingHeadersExtractAdapter.java
@@ -49,8 +49,6 @@ public final class CamelMessagingHeadersExtractAdapter implements TextMap {
* than specifically to JMS so that other Camel messaging endpoints can take
* part in traces where the peer is using JMS.
*
- * @param the source
- * @return the result
*/
private String decodeDash(String key) {
if (jmsEncoding) {
diff --git a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/api/dto/composite/SObjectBatch.java b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/api/dto/composite/SObjectBatch.java
index 9c231e0..29605b7 100644
--- a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/api/dto/composite/SObjectBatch.java
+++ b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/api/dto/composite/SObjectBatch.java
@@ -202,7 +202,6 @@ public final class SObjectBatch implements Serializable {
* @param type type of SObject
* @param fieldName external identifier field name
* @param fieldValue external identifier field value
- * @param fields to return
* @return this batch builder
*/
public SObjectBatch addGetByExternalId(final String type, final String fieldName, final String fieldValue) {
@@ -276,7 +275,7 @@ public final class SObjectBatch implements Serializable {
/**
* Add retrieval of SObject records by search to the batch.
*
- * @param query SOSL search to execute
+ * @param searchString SOSL search to execute
* @return this batch builder
*/
public SObjectBatch addSearch(final String searchString) {
@@ -310,7 +309,7 @@ public final class SObjectBatch implements Serializable {
*
* @param type type of SObject
* @param fieldName name of the field holding the external identifier
- * @param id external identifier value
+ * @param fieldValue external identifier value
* @param data SObject with fields to change
* @return this batch builder
*/
@@ -330,7 +329,7 @@ public final class SObjectBatch implements Serializable {
*
* @param type type of SObject
* @param fieldName name of the field holding the external identifier
- * @param id external identifier value
+ * @param fieldValue external identifier value
* @param data SObject with fields to change
* @return this batch builder
*/
diff --git a/components/camel-ssh/src/main/java/org/apache/camel/component/ssh/SshShellOutputStringHelper.java b/components/camel-ssh/src/main/java/org/apache/camel/component/ssh/SshShellOutputStringHelper.java
index 5a233e8..5affdb9 100644
--- a/components/camel-ssh/src/main/java/org/apache/camel/component/ssh/SshShellOutputStringHelper.java
+++ b/components/camel-ssh/src/main/java/org/apache/camel/component/ssh/SshShellOutputStringHelper.java
@@ -49,7 +49,7 @@ public final class SshShellOutputStringHelper {
* Returns an object before the given last token
*
* @param text the text
- * @param before the last token
+ * @param beforeLast the last token
* @param mapper a mapping function to convert the string before the token to type T
* @return an Optional describing the result of applying a mapping function to the text before the token.
*/
@@ -68,7 +68,7 @@ public final class SshShellOutputStringHelper {
*
* @param text the text
* @param after is the starting token to skip the text before that.
- * @param before the last token
+ * @param beforeLast the last token
* @return the text between the tokens, or <tt>null</tt> if text does not contain the tokens
*/
public static String betweenBeforeLast(String text, String after, String beforeLast) {
diff --git a/components/camel-xmlsecurity/src/main/java/org/apache/camel/component/xmlsecurity/api/DefaultXmlSignature2Message.java b/components/camel-xmlsecurity/src/main/java/org/apache/camel/component/xmlsecurity/api/DefaultXmlSignature2Message.java
index 6bc127d..3f13a19 100644
--- a/components/camel-xmlsecurity/src/main/java/org/apache/camel/component/xmlsecurity/api/DefaultXmlSignature2Message.java
+++ b/components/camel-xmlsecurity/src/main/java/org/apache/camel/component/xmlsecurity/api/DefaultXmlSignature2Message.java
@@ -319,9 +319,6 @@ public class DefaultXmlSignature2Message implements XmlSignature2Message {
/**
* Removes the Signature elements from the document.
- *
- * @param doc
- * document
*/
protected void removeSignatureElements(Node node) {
Document doc = XmlSignatureHelper.getDocument(node);
diff --git a/components/camel-xmlsecurity/src/main/java/org/apache/camel/component/xmlsecurity/api/XmlSignatureHelper.java b/components/camel-xmlsecurity/src/main/java/org/apache/camel/component/xmlsecurity/api/XmlSignatureHelper.java
index ff9d363..6174276 100644
--- a/components/camel-xmlsecurity/src/main/java/org/apache/camel/component/xmlsecurity/api/XmlSignatureHelper.java
+++ b/components/camel-xmlsecurity/src/main/java/org/apache/camel/component/xmlsecurity/api/XmlSignatureHelper.java
@@ -233,8 +233,6 @@ public final class XmlSignatureHelper {
* Returns a configuration for an XPATH2 transformation which consists of
* several XPATH expressions.
*
- * @param xpathAndFilterList
- * list of XPATH expressions with their filters
* @param namespaceMap
* namespace map, key is the prefix, value is the namespace, can
* be <code>null</code>
diff --git a/core/camel-util/src/main/java/org/apache/camel/util/ObjectHelper.java b/core/camel-util/src/main/java/org/apache/camel/util/ObjectHelper.java
index 317c066..c06a8dd 100644
--- a/core/camel-util/src/main/java/org/apache/camel/util/ObjectHelper.java
+++ b/core/camel-util/src/main/java/org/apache/camel/util/ObjectHelper.java
@@ -1170,7 +1170,7 @@ public final class ObjectHelper {
/**
* Turns the input array to a list of objects.
*
- * @param args an array of objects or null
+ * @param objects an array of objects or null
* @return an object list
*/
public static List<Object> asList(Object[] objects) {
diff --git a/tooling/camel-util-json/src/main/java/org/apache/camel/util/json/Jsoner.java b/tooling/camel-util-json/src/main/java/org/apache/camel/util/json/Jsoner.java
index ddd8e47..49e13cd 100644
--- a/tooling/camel-util-json/src/main/java/org/apache/camel/util/json/Jsoner.java
+++ b/tooling/camel-util-json/src/main/java/org/apache/camel/util/json/Jsoner.java
@@ -753,8 +753,6 @@ public final class Jsoner {
* to a string in JSON format.
* @param writableDestination represents where the resulting JSON text is
* written to.
- * @param replacement represents what is serialized instead of a non-JSON
- * value when replacements are allowed.
* @param flags represents the allowances and restrictions on serialization.
* @throws IOException if the writableDestination encounters an I/O problem.
* @throws IllegalArgumentException if the jsonSerializable isn't