You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cxf.apache.org by co...@apache.org on 2020/01/09 14:59:12 UTC

[cxf] branch master updated: More javadoc work

This is an automated email from the ASF dual-hosted git repository.

coheigea pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/cxf.git


The following commit(s) were added to refs/heads/master by this push:
     new 9be0ff5  More javadoc work
9be0ff5 is described below

commit 9be0ff566caa784807bd89e7c6996a4405ac59d7
Author: Colm O hEigeartaigh <co...@apache.org>
AuthorDate: Thu Jan 9 14:58:53 2020 +0000

    More javadoc work
---
 .../java/org/apache/cxf/service/model/AbstractMessageContainer.java | 2 +-
 .../main/java/org/apache/cxf/connector/CXFConnectionFactory.java    | 2 +-
 .../main/java/org/apache/cxf/jca/inbound/DispatchMDBInvoker.java    | 3 ---
 .../src/main/java/org/apache/cxf/jca/inbound/MDBActivationWork.java | 4 ----
 .../jca/src/main/java/org/apache/cxf/jca/inbound/MDBInvoker.java    | 2 +-
 .../soap/src/main/java/org/apache/cxf/binding/soap/SoapFault.java   | 2 +-
 .../src/main/java/org/apache/cxf/aegis/type/basic/BeanTypeInfo.java | 2 +-
 .../aegis/src/main/java/org/apache/cxf/aegis/xml/MessageWriter.java | 2 +-
 .../logging/src/main/java/org/apache/cxf/ext/logging/WireTapIn.java | 5 ++---
 .../src/main/java/org/apache/cxf/metrics/MetricsContext.java        | 4 ++--
 .../java/org/apache/cxf/jaxrs/provider/FormEncodingProvider.java    | 3 ---
 .../main/java/org/apache/cxf/jaxws/handler/HandlerResolverImpl.java | 3 ---
 .../src/main/java/org/apache/cxf/jaxws/handler/types/CString.java   | 6 +++---
 .../main/java/org/apache/cxf/jaxws/handler/types/XsdQNameType.java  | 6 +++---
 .../main/java/org/apache/cxf/jaxws/handler/types/XsdStringType.java | 6 +++---
 .../java/org/apache/cxf/ws/addressing/soap/VersionTransformer.java  | 2 +-
 16 files changed, 20 insertions(+), 34 deletions(-)

diff --git a/core/src/main/java/org/apache/cxf/service/model/AbstractMessageContainer.java b/core/src/main/java/org/apache/cxf/service/model/AbstractMessageContainer.java
index f0b0187..33b7d66 100644
--- a/core/src/main/java/org/apache/cxf/service/model/AbstractMessageContainer.java
+++ b/core/src/main/java/org/apache/cxf/service/model/AbstractMessageContainer.java
@@ -39,7 +39,7 @@ public abstract class AbstractMessageContainer extends AbstractPropertiesHolder
 
     /**
      * Initializes a new instance of the <code>MessagePartContainer</code>.
-     * @param operation the operation.
+     * @param op the operation.
      * @param nm
      */
     AbstractMessageContainer(OperationInfo op, QName nm) {
diff --git a/integration/jca/src/main/java/org/apache/cxf/connector/CXFConnectionFactory.java b/integration/jca/src/main/java/org/apache/cxf/connector/CXFConnectionFactory.java
index 5383326..418ec66 100644
--- a/integration/jca/src/main/java/org/apache/cxf/connector/CXFConnectionFactory.java
+++ b/integration/jca/src/main/java/org/apache/cxf/connector/CXFConnectionFactory.java
@@ -30,7 +30,7 @@ public interface CXFConnectionFactory {
 
     /**
      *  Creates a client proxy based on the connection parameter object.
-     * @param param,
+     * @param param
      * @return A proxy object that implements both the given <code>iface</code>
      *         and the {@link Connection} interface. It represents the Web
      *         service associated with the specified service.
diff --git a/integration/jca/src/main/java/org/apache/cxf/jca/inbound/DispatchMDBInvoker.java b/integration/jca/src/main/java/org/apache/cxf/jca/inbound/DispatchMDBInvoker.java
index 03ae56d..5169a29 100644
--- a/integration/jca/src/main/java/org/apache/cxf/jca/inbound/DispatchMDBInvoker.java
+++ b/integration/jca/src/main/java/org/apache/cxf/jca/inbound/DispatchMDBInvoker.java
@@ -43,9 +43,6 @@ public class DispatchMDBInvoker extends MDBInvoker {
 
     private String targetJndiName;
 
-    /**
-     * @param messageEndpoint
-     */
     public DispatchMDBInvoker(MessageEndpointFactory factory, String targetJndiName) {
         super(factory);
         this.targetJndiName = targetJndiName;
diff --git a/integration/jca/src/main/java/org/apache/cxf/jca/inbound/MDBActivationWork.java b/integration/jca/src/main/java/org/apache/cxf/jca/inbound/MDBActivationWork.java
index cd6f4d4..650550f 100644
--- a/integration/jca/src/main/java/org/apache/cxf/jca/inbound/MDBActivationWork.java
+++ b/integration/jca/src/main/java/org/apache/cxf/jca/inbound/MDBActivationWork.java
@@ -241,10 +241,6 @@ public class MDBActivationWork implements Work {
         return Arrays.asList(str.split(","));
     }
 
-    /**
-     * @param endpoint
-     * @return
-     */
     private MDBInvoker createInvoker() {
         MDBInvoker answer = null;
         if (spec instanceof DispatchMDBActivationSpec) {
diff --git a/integration/jca/src/main/java/org/apache/cxf/jca/inbound/MDBInvoker.java b/integration/jca/src/main/java/org/apache/cxf/jca/inbound/MDBInvoker.java
index cdf71f5..bba3a0d 100644
--- a/integration/jca/src/main/java/org/apache/cxf/jca/inbound/MDBInvoker.java
+++ b/integration/jca/src/main/java/org/apache/cxf/jca/inbound/MDBInvoker.java
@@ -47,7 +47,7 @@ public class MDBInvoker extends AbstractInvoker {
     private final MessageEndpointFactory endpointFactory;
 
     /**
-     * @param messageEndpoint
+     * @param factory
      */
     public MDBInvoker(MessageEndpointFactory factory) {
         endpointFactory = factory;
diff --git a/rt/bindings/soap/src/main/java/org/apache/cxf/binding/soap/SoapFault.java b/rt/bindings/soap/src/main/java/org/apache/cxf/binding/soap/SoapFault.java
index 39fe4ac..0cc9517 100644
--- a/rt/bindings/soap/src/main/java/org/apache/cxf/binding/soap/SoapFault.java
+++ b/rt/bindings/soap/src/main/java/org/apache/cxf/binding/soap/SoapFault.java
@@ -178,7 +178,7 @@ public class SoapFault extends Fault {
     /**
      * Sets the SubCode list for the Fault Code.
      *
-     * @param subCode The SubCode element list as detailed by the SOAP 1.2 spec.
+     * @param subCodes The SubCode element list as detailed by the SOAP 1.2 spec.
      */
     public void setSubCodes(List<QName> subCodes) {
         this.subCodes = subCodes;
diff --git a/rt/databinding/aegis/src/main/java/org/apache/cxf/aegis/type/basic/BeanTypeInfo.java b/rt/databinding/aegis/src/main/java/org/apache/cxf/aegis/type/basic/BeanTypeInfo.java
index fc9f8b9..aa4fef6 100644
--- a/rt/databinding/aegis/src/main/java/org/apache/cxf/aegis/type/basic/BeanTypeInfo.java
+++ b/rt/databinding/aegis/src/main/java/org/apache/cxf/aegis/type/basic/BeanTypeInfo.java
@@ -80,7 +80,7 @@ public class BeanTypeInfo {
      *
      * @param typeClass
      * @param defaultNamespace
-     * @param initiallize If true attempt default property/xml mappings.
+     * @param initialize If true attempt default property/xml mappings.
      */
     public BeanTypeInfo(Class<?> typeClass, String defaultNamespace, boolean initialize) {
         this.beanClass = typeClass;
diff --git a/rt/databinding/aegis/src/main/java/org/apache/cxf/aegis/xml/MessageWriter.java b/rt/databinding/aegis/src/main/java/org/apache/cxf/aegis/xml/MessageWriter.java
index 61c1995..a750d64 100644
--- a/rt/databinding/aegis/src/main/java/org/apache/cxf/aegis/xml/MessageWriter.java
+++ b/rt/databinding/aegis/src/main/java/org/apache/cxf/aegis/xml/MessageWriter.java
@@ -81,7 +81,7 @@ public interface MessageWriter {
      * however, explicitly assert its type using the attribute
      * <code>xsi:type</code>."
      *
-     * @param type the QName of the type being referenced.
+     * @param qn the QName of the type being referenced.
      */
     void writeXsiType(QName qn);
 
diff --git a/rt/features/logging/src/main/java/org/apache/cxf/ext/logging/WireTapIn.java b/rt/features/logging/src/main/java/org/apache/cxf/ext/logging/WireTapIn.java
index 60fc44e..aefc731 100644
--- a/rt/features/logging/src/main/java/org/apache/cxf/ext/logging/WireTapIn.java
+++ b/rt/features/logging/src/main/java/org/apache/cxf/ext/logging/WireTapIn.java
@@ -34,15 +34,14 @@ import org.apache.cxf.phase.Phase;
 
 public class WireTapIn extends AbstractPhaseInterceptor<Message> {
     private static final String WIRE_TAP_STARTED = WireTapIn.class.getName() + ".Started";
-    
+
     private long threshold = -1;
     private int limit = AbstractLoggingInterceptor.DEFAULT_LIMIT;
 
     /**
      * Instantiates a new WireTapIn
      * @param limit
-     *
-     * @param logMessageContent the log message content
+     * @param threshold the log threshold
      */
     public WireTapIn(int limit, long threshold) {
         super(Phase.RECEIVE);
diff --git a/rt/features/metrics/src/main/java/org/apache/cxf/metrics/MetricsContext.java b/rt/features/metrics/src/main/java/org/apache/cxf/metrics/MetricsContext.java
index 21c461f..692cb8e 100644
--- a/rt/features/metrics/src/main/java/org/apache/cxf/metrics/MetricsContext.java
+++ b/rt/features/metrics/src/main/java/org/apache/cxf/metrics/MetricsContext.java
@@ -41,7 +41,7 @@ public interface MetricsContext {
      * @param timeInNS
      * @param inSize
      * @param outSize
-     * @param fm
+     * @param exchange
      */
-    void stop(long timeInNS, long inSize, long outSize, Exchange m);
+    void stop(long timeInNS, long inSize, long outSize, Exchange exchange);
 }
diff --git a/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/provider/FormEncodingProvider.java b/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/provider/FormEncodingProvider.java
index 9ab6b3e..785d839 100644
--- a/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/provider/FormEncodingProvider.java
+++ b/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/provider/FormEncodingProvider.java
@@ -154,9 +154,6 @@ public class FormEncodingProvider<T> extends AbstractConfigurableProvider
 
     /**
      * Retrieve map of parameters from the passed in message
-     *
-     * @param message
-     * @return a Map of parameters.
      */
     protected void populateMap(MultivaluedMap<String, String> params,
                                Annotation[] anns,
diff --git a/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/HandlerResolverImpl.java b/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/HandlerResolverImpl.java
index 6052f08..767940f 100644
--- a/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/HandlerResolverImpl.java
+++ b/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/HandlerResolverImpl.java
@@ -78,9 +78,6 @@ public class HandlerResolverImpl implements HandlerResolver {
 
     /**
      * Obtain handler chain from annotations.
-     *
-     * @param obj A endpoint implementation class or a SEI, or a generated
-     *            service class.
      */
     private List<Handler> getHandlersFromAnnotation(Class<?> clazz, PortInfo portInfo) {
         AnnotationHandlerChainBuilder builder = new AnnotationHandlerChainBuilder();
diff --git a/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/types/CString.java b/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/types/CString.java
index 8492c34..d41aa82 100644
--- a/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/types/CString.java
+++ b/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/types/CString.java
@@ -88,10 +88,10 @@ public class CString {
     /**
      * Sets the value of the id property.
      *
-     * @param value allowed object is {@link java.lang.String }
+     * @param id allowed object is {@link java.lang.String }
      */
-    public void setId(java.lang.String v) {
-        this.id = v;
+    public void setId(java.lang.String id) {
+        this.id = id;
     }
 
 }
diff --git a/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/types/XsdQNameType.java b/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/types/XsdQNameType.java
index c4342c3..46a1ad5 100644
--- a/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/types/XsdQNameType.java
+++ b/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/types/XsdQNameType.java
@@ -86,10 +86,10 @@ public class XsdQNameType {
     /**
      * Sets the value of the id property.
      *
-     * @param value allowed object is {@link java.lang.String }
+     * @param id allowed object is {@link java.lang.String }
      */
-    public void setId(java.lang.String v) {
-        this.id = v;
+    public void setId(java.lang.String id) {
+        this.id = id;
     }
 
 }
diff --git a/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/types/XsdStringType.java b/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/types/XsdStringType.java
index 62aecc8..0b1306b 100644
--- a/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/types/XsdStringType.java
+++ b/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/types/XsdStringType.java
@@ -85,10 +85,10 @@ public class XsdStringType {
     /**
      * Sets the value of the id property.
      *
-     * @param value allowed object is {@link java.lang.String }
+     * @param id allowed object is {@link java.lang.String }
      */
-    public void setId(java.lang.String v) {
-        this.id = v;
+    public void setId(java.lang.String id) {
+        this.id = id;
     }
 
 }
diff --git a/rt/ws/addr/src/main/java/org/apache/cxf/ws/addressing/soap/VersionTransformer.java b/rt/ws/addr/src/main/java/org/apache/cxf/ws/addressing/soap/VersionTransformer.java
index 605c26f..47ac1c5 100644
--- a/rt/ws/addr/src/main/java/org/apache/cxf/ws/addressing/soap/VersionTransformer.java
+++ b/rt/ws/addr/src/main/java/org/apache/cxf/ws/addressing/soap/VersionTransformer.java
@@ -137,7 +137,7 @@ public class VersionTransformer extends org.apache.cxf.ws.addressing.VersionTran
      * @param encodedAs specifies the encoded version
      * @param clz the class
      * @param headerElement the SOAP header element
-     * @param marshaller the JAXB marshaller to use
+     * @param unmarshaller the JAXB unmarshaller to use
      * @return the decoded value
      */
     public <T> T decodeAsNative(String encodedAs, Class<T> clz, Element headerElement,