From b92dbfd49426f04a31bf66d5fded0944596435f0 Mon Sep 17 00:00:00 2001 From: Dennis Kieselhorst Date: Mon, 24 Apr 2017 12:47:03 +0200 Subject: [PATCH] fixed Javadoc errors --- .../apache/cxf/jaxrs/JAXRSServerFactoryBean.java | 4 ++-- .../cxf/jaxrs/client/JAXRSClientFactoryBean.java | 7 +++---- .../org/apache/cxf/jaxrs/client/WebClient.java | 15 +++++++-------- 3 files changed, 12 insertions(+), 14 deletions(-) diff --git a/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/JAXRSServerFactoryBean.java b/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/JAXRSServerFactoryBean.java index b643a2835ea..423ae4f1cbf 100644 --- a/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/JAXRSServerFactoryBean.java +++ b/rt/frontend/jaxrs/src/main/java/org/apache/cxf/jaxrs/JAXRSServerFactoryBean.java @@ -286,7 +286,7 @@ public void setLanguageMappings(Map lMaps) { * Sets the extension mappings, * example, 'xml' is the key and 'text/xml' is the value. * - * @param lMaps the extension mappings + * @param extMaps the extension mappings */ public void setExtensionMappings(Map extMaps) { extensionMappings = extMaps; @@ -450,7 +450,7 @@ protected void setDefaultResourceProvider(ClassResourceInfo cri) { /** * Set the reference to the document (WADL, etc) describing the endpoint - * @param documentLocation document location + * @param docLocation document location */ public void setDocLocation(String docLocation) { this.documentLocation = docLocation; diff --git a/rt/rs/client/src/main/java/org/apache/cxf/jaxrs/client/JAXRSClientFactoryBean.java b/rt/rs/client/src/main/java/org/apache/cxf/jaxrs/client/JAXRSClientFactoryBean.java index 6fe60829184..23d5f72ad30 100644 --- a/rt/rs/client/src/main/java/org/apache/cxf/jaxrs/client/JAXRSClientFactoryBean.java +++ b/rt/rs/client/src/main/java/org/apache/cxf/jaxrs/client/JAXRSClientFactoryBean.java @@ -97,7 +97,7 @@ public void setThreadSafe(boolean threadSafe) { /** * Sets the time a thread-local client state will be kept. * This property is ignored for thread-unsafe clients - * @param secondsToKeepState + * @param time secondsToKeepState */ public void setSecondsToKeepState(long time) { this.timeToKeepState = time; @@ -161,8 +161,8 @@ public void setResourceClass(Class cls) { } /** - * Sets the resource class, may be called from a Spring handler - * @param cls the resource class + * Sets the service class, may be called from a Spring handler + * @param cls the service class */ public void setServiceClass(Class cls) { this.serviceClass = cls; @@ -171,7 +171,6 @@ public void setServiceClass(Class cls) { /** * Returns the service class - * @param cls the service class */ public Class getServiceClass() { return serviceClass; diff --git a/rt/rs/client/src/main/java/org/apache/cxf/jaxrs/client/WebClient.java b/rt/rs/client/src/main/java/org/apache/cxf/jaxrs/client/WebClient.java index 8b5e0630f83..44de0da82a3 100644 --- a/rt/rs/client/src/main/java/org/apache/cxf/jaxrs/client/WebClient.java +++ b/rt/rs/client/src/main/java/org/apache/cxf/jaxrs/client/WebClient.java @@ -134,7 +134,7 @@ public static WebClient create(String baseURI, boolean threadSafe) { /** * Creates WebClient - * @param baseURI baseURI + * @param baseAddress baseURI * @param providers list of providers */ public static WebClient create(String baseAddress, List providers) { @@ -143,8 +143,9 @@ public static WebClient create(String baseAddress, List providers) { /** * Creates WebClient - * @param baseURI baseURI + * @param baseAddress baseURI * @param providers list of providers + * @param threadSafe if true ThreadLocalClientState is used */ public static WebClient create(String baseAddress, List providers, boolean threadSafe) { JAXRSClientFactoryBean bean = getBean(baseAddress, null); @@ -157,7 +158,7 @@ public static WebClient create(String baseAddress, List providers, boolean th /** * Creates a thread safe WebClient - * @param baseURI baseURI + * @param baseAddress baseURI * @param providers list of providers * @param timeToKeepState time to keep this thread safe state. */ @@ -250,7 +251,7 @@ public static WebClient create(String baseAddress, List providers, /** * Creates WebClient, baseURI will be set to Client currentURI - * @param client existing client + * @param object existing client object */ public static WebClient fromClientObject(Object object) { Client client = client(object); @@ -572,7 +573,6 @@ public Collection postAndGetCollection(Object collection, /** * Posts the object and returns a collection of typed objects * @param body request body - * @param memberClass type of collection member class * @param responseClass expected type of response object * @return JAX-RS Response */ @@ -595,7 +595,6 @@ public Collection postAndGetCollection(Object body, Class me /** * Does HTTP GET invocation and returns a collection of typed objects - * @param body request body, can be null * @param memberClass expected type of collection member class * @return typed collection */ @@ -605,7 +604,6 @@ public Collection getCollection(Class memberClass) { /** * Does HTTP GET invocation and returns typed response object - * @param body request body, can be null * @param responseClass expected type of response object * @return typed object, can be null. Response status code and headers * can be obtained too, see Client.getResponse() @@ -780,7 +778,8 @@ public WebClient replaceHeader(String headerName, Object value) { /** * Replaces the current query with the new value. - * @param queryString the new value, providing a null is + * @param queryParam query param name + * @param value the new value, providing a null is * equivalent to calling resetQuery(). * @return updated WebClient */