Author: dkulp
Date: Wed Jan 12 19:49:59 2011
New Revision: 1058291
URL: http://svn.apache.org/viewvc?rev=1058291&view=rev
Log:
[CXF-3079] Update a bunch of javadocs to remove all the javadoc warnings
in api
Modified:
cxf/trunk/api/src/main/java/org/apache/cxf/annotations/DataBinding.java
cxf/trunk/api/src/main/java/org/apache/cxf/annotations/EndpointProperties.java
cxf/trunk/api/src/main/java/org/apache/cxf/annotations/EndpointProperty.java
cxf/trunk/api/src/main/java/org/apache/cxf/clustering/FailoverStrategy.java
cxf/trunk/api/src/main/java/org/apache/cxf/configuration/ConfiguredBeanLocator.java
cxf/trunk/api/src/main/java/org/apache/cxf/continuations/Continuation.java
cxf/trunk/api/src/main/java/org/apache/cxf/endpoint/Client.java
cxf/trunk/api/src/main/java/org/apache/cxf/endpoint/ClientCallback.java
cxf/trunk/api/src/main/java/org/apache/cxf/io/StaxValidationManager.java
cxf/trunk/api/src/main/java/org/apache/cxf/phase/AbstractPhaseInterceptor.java
cxf/trunk/api/src/main/java/org/apache/cxf/service/model/SchemaInfo.java
cxf/trunk/api/src/main/java/org/apache/cxf/transport/Observable.java
cxf/trunk/api/src/main/java/org/apache/cxf/ws/policy/AssertionBuilderRegistry.java
cxf/trunk/api/src/main/java/org/apache/cxf/ws/policy/PolicyBuilder.java
cxf/trunk/api/src/main/java/org/apache/cxf/wsdl/WSDLManager.java
cxf/trunk/parent/pom.xml
Modified:
cxf/trunk/api/src/main/java/org/apache/cxf/annotations/DataBinding.java
URL:
http://svn.apache.org/viewvc/cxf/trunk/api/src/main/java/org/apache/cxf/annotations/DataBinding.java?rev=1058291&r1=1058290&r2=1058291&view=diff
==============================================================================
--- cxf/trunk/api/src/main/java/org/apache/cxf/annotations/DataBinding.java
(original)
+++ cxf/trunk/api/src/main/java/org/apache/cxf/annotations/DataBinding.java Wed
Jan 12 19:49:59 2011
@@ -37,7 +37,7 @@ public @interface DataBinding {
/**
* Bean reference to lookup in configuration. Bean must be castable
* to the Class set above
- * @return
+ * @return The id of the bean reference
*/
String ref() default "";
}
Modified:
cxf/trunk/api/src/main/java/org/apache/cxf/annotations/EndpointProperties.java
URL:
http://svn.apache.org/viewvc/cxf/trunk/api/src/main/java/org/apache/cxf/annotations/EndpointProperties.java?rev=1058291&r1=1058290&r2=1058291&view=diff
==============================================================================
---
cxf/trunk/api/src/main/java/org/apache/cxf/annotations/EndpointProperties.java
(original)
+++
cxf/trunk/api/src/main/java/org/apache/cxf/annotations/EndpointProperties.java
Wed Jan 12 19:49:59 2011
@@ -35,7 +35,7 @@ public @interface EndpointProperties {
/**
* The properties
- * @return
+ * @return the list of properties to set
*/
EndpointProperty[] value();
Modified:
cxf/trunk/api/src/main/java/org/apache/cxf/annotations/EndpointProperty.java
URL:
http://svn.apache.org/viewvc/cxf/trunk/api/src/main/java/org/apache/cxf/annotations/EndpointProperty.java?rev=1058291&r1=1058290&r2=1058291&view=diff
==============================================================================
---
cxf/trunk/api/src/main/java/org/apache/cxf/annotations/EndpointProperty.java
(original)
+++
cxf/trunk/api/src/main/java/org/apache/cxf/annotations/EndpointProperty.java
Wed Jan 12 19:49:59 2011
@@ -35,13 +35,13 @@ public @interface EndpointProperty {
/**
* The value(s) of the property
- * @return
+ * @return the value of the property
*/
String[] value();
/**
* The key to record the property
- * @return
+ * @return the key for the property
*/
String key();
}
Modified:
cxf/trunk/api/src/main/java/org/apache/cxf/clustering/FailoverStrategy.java
URL:
http://svn.apache.org/viewvc/cxf/trunk/api/src/main/java/org/apache/cxf/clustering/FailoverStrategy.java?rev=1058291&r1=1058290&r2=1058291&view=diff
==============================================================================
--- cxf/trunk/api/src/main/java/org/apache/cxf/clustering/FailoverStrategy.java
(original)
+++ cxf/trunk/api/src/main/java/org/apache/cxf/clustering/FailoverStrategy.java
Wed Jan 12 19:49:59 2011
@@ -57,7 +57,7 @@ public interface FailoverStrategy {
/**
* Select one of the alternate addresses for a retried invocation.
*
- * @param alternates List of alternate addresses if available
+ * @param addresses List of alternate addresses if available
* @return the selected address
*/
String selectAlternateAddress(List<String> addresses);
Modified:
cxf/trunk/api/src/main/java/org/apache/cxf/configuration/ConfiguredBeanLocator.java
URL:
http://svn.apache.org/viewvc/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/ConfiguredBeanLocator.java?rev=1058291&r1=1058290&r2=1058291&view=diff
==============================================================================
---
cxf/trunk/api/src/main/java/org/apache/cxf/configuration/ConfiguredBeanLocator.java
(original)
+++
cxf/trunk/api/src/main/java/org/apache/cxf/configuration/ConfiguredBeanLocator.java
Wed Jan 12 19:49:59 2011
@@ -31,35 +31,32 @@ public interface ConfiguredBeanLocator {
* Gets the names of all the configured beans of the specific type. Does
* not cause them to be loaded.
* @param type
- * @return
+ * @return List of all the bean names for the given type
*/
List<String> getBeanNamesOfType(Class<?> type);
/**
* Gets all the configured beans of the specific types. Causes them
* all to be loaded.
- * @param <T>
* @param type
- * @return
+ * @return The collection of all the configured beans of the given type
*/
<T> Collection<? extends T> getBeansOfType(Class<T> type);
/**
* Returns the bean of the given type and name. Causes it to be loaded.
- * @param <T>
* @param name
* @param type
- * @return
+ * @return the bean of the given name and type
*/
<T> T getBeanOfType(String name, Class<T> type);
/**
* Iterates through the beans of the given type, calling the listener
* to determine if it should be loaded or not.
- * @param <T>
* @param type
* @param listener
- * @return
+ * @return true if beans of the type were loaded
*/
<T> boolean loadBeansOfType(Class<T> type, BeanLoaderListener<T> listener);
@@ -67,11 +64,10 @@ public interface ConfiguredBeanLocator {
* For supporting "legacy" config, checks the configured bean to see if
* it has a property configured with the given name/value. Mostly used
* for supporting things configured with "activationNamespaces" set.
- * @param <T>
- * @param type
- * @param property
+ * @param beanName
+ * @param propertyName
* @param value
- * @return
+ * @return true if the bean has the given property/value
*/
boolean hasConfiguredPropertyValue(String beanName, String propertyName,
String value);
@@ -81,7 +77,7 @@ public interface ConfiguredBeanLocator {
* the loader will just skip to the next bean
* @param name
* @param type
- * @return
+ * @return true if the bean should be loaded
*/
boolean loadBean(String name, Class<? extends T> type);
@@ -89,8 +85,9 @@ public interface ConfiguredBeanLocator {
* Return true if the bean that was loaded meets the requirements at
* which point, the loader will stop loading additional beans of the
* given type
+ * @param name
* @param bean
- * @return
+ * @return true if the bean meets the requirements of the listener
*/
boolean beanLoaded(String name, T bean);
}
Modified:
cxf/trunk/api/src/main/java/org/apache/cxf/continuations/Continuation.java
URL:
http://svn.apache.org/viewvc/cxf/trunk/api/src/main/java/org/apache/cxf/continuations/Continuation.java?rev=1058291&r1=1058290&r2=1058291&view=diff
==============================================================================
--- cxf/trunk/api/src/main/java/org/apache/cxf/continuations/Continuation.java
(original)
+++ cxf/trunk/api/src/main/java/org/apache/cxf/continuations/Continuation.java
Wed Jan 12 19:49:59 2011
@@ -29,7 +29,7 @@ public interface Continuation {
* This method will suspend the request for the timeout or until resume is
* called
*
- * @param timeout. A timeout of < 0 will cause an immediate return.
+ * @param timeout A timeout of < 0 will cause an immediate return.
* A timeout of 0 will wait indefinitely.
* @return True if resume called or false if timeout.
*/
Modified: cxf/trunk/api/src/main/java/org/apache/cxf/endpoint/Client.java
URL:
http://svn.apache.org/viewvc/cxf/trunk/api/src/main/java/org/apache/cxf/endpoint/Client.java?rev=1058291&r1=1058290&r2=1058291&view=diff
==============================================================================
--- cxf/trunk/api/src/main/java/org/apache/cxf/endpoint/Client.java (original)
+++ cxf/trunk/api/src/main/java/org/apache/cxf/endpoint/Client.java Wed Jan 12
19:49:59 2011
@@ -235,7 +235,7 @@ public interface Client extends Intercep
/**
* Checks if the Request context is thread local or global.
- * @return
+ * @return true if the request context is a thread local
*/
boolean isThreadLocalRequestContext();
Modified:
cxf/trunk/api/src/main/java/org/apache/cxf/endpoint/ClientCallback.java
URL:
http://svn.apache.org/viewvc/cxf/trunk/api/src/main/java/org/apache/cxf/endpoint/ClientCallback.java?rev=1058291&r1=1058290&r2=1058291&view=diff
==============================================================================
--- cxf/trunk/api/src/main/java/org/apache/cxf/endpoint/ClientCallback.java
(original)
+++ cxf/trunk/api/src/main/java/org/apache/cxf/endpoint/ClientCallback.java Wed
Jan 12 19:49:59 2011
@@ -112,7 +112,7 @@ public class ClientCallback implements F
/**
* return the map of items returned from an operation.
- * @return
+ * @return the response context
* @throws InterruptedException if the operation was cancelled.
* @throws ExecutionException if the operation resulted in a fault.
*/
Modified:
cxf/trunk/api/src/main/java/org/apache/cxf/io/StaxValidationManager.java
URL:
http://svn.apache.org/viewvc/cxf/trunk/api/src/main/java/org/apache/cxf/io/StaxValidationManager.java?rev=1058291&r1=1058290&r2=1058291&view=diff
==============================================================================
--- cxf/trunk/api/src/main/java/org/apache/cxf/io/StaxValidationManager.java
(original)
+++ cxf/trunk/api/src/main/java/org/apache/cxf/io/StaxValidationManager.java
Wed Jan 12 19:49:59 2011
@@ -32,11 +32,18 @@ import org.apache.cxf.service.model.Serv
public interface StaxValidationManager {
/**
* Install the schemas onto the reader for validation.
- * @param reader
- * @param schemas
+ * @param reader - the reader to enable validation
+ * @param serviceInfo - the Service to pull the schema from
* @throws XMLStreamException
*/
void setupValidation(XMLStreamReader reader, ServiceInfo serviceInfo)
throws XMLStreamException;
+
+ /**
+ * Install the schemas onto the writer for validation.
+ * @param writer - the writer to enable validation
+ * @param serviceInfo - the Service to pull the schema from
+ * @throws XMLStreamException
+ */
void setupValidation(XMLStreamWriter writer, ServiceInfo serviceInfo)
throws XMLStreamException;
}
Modified:
cxf/trunk/api/src/main/java/org/apache/cxf/phase/AbstractPhaseInterceptor.java
URL:
http://svn.apache.org/viewvc/cxf/trunk/api/src/main/java/org/apache/cxf/phase/AbstractPhaseInterceptor.java?rev=1058291&r1=1058290&r2=1058291&view=diff
==============================================================================
---
cxf/trunk/api/src/main/java/org/apache/cxf/phase/AbstractPhaseInterceptor.java
(original)
+++
cxf/trunk/api/src/main/java/org/apache/cxf/phase/AbstractPhaseInterceptor.java
Wed Jan 12 19:49:59 2011
@@ -69,8 +69,8 @@ public abstract class AbstractPhaseInter
* <code>uniqueId</code> is set to false, the implementing class' name
* is used as the id.
*
- * @param p the interceptor's phase
- * @param uniqueId
+ * @param phase the interceptor's phase
+ * @param uniqueId true to have a unique ID generated
*/
public AbstractPhaseInterceptor(String phase, boolean uniqueId) {
this(null, phase, uniqueId);
Modified:
cxf/trunk/api/src/main/java/org/apache/cxf/service/model/SchemaInfo.java
URL:
http://svn.apache.org/viewvc/cxf/trunk/api/src/main/java/org/apache/cxf/service/model/SchemaInfo.java?rev=1058291&r1=1058290&r2=1058291&view=diff
==============================================================================
--- cxf/trunk/api/src/main/java/org/apache/cxf/service/model/SchemaInfo.java
(original)
+++ cxf/trunk/api/src/main/java/org/apache/cxf/service/model/SchemaInfo.java
Wed Jan 12 19:49:59 2011
@@ -81,7 +81,7 @@ public final class SchemaInfo extends Ab
/**
* Build and return a DOM tree for this schema.
- * @return
+ * @return a DOM Element representation of the schema
*/
public synchronized Element getElement() {
// if someone recently used this DOM tree, take advantage.
Modified: cxf/trunk/api/src/main/java/org/apache/cxf/transport/Observable.java
URL:
http://svn.apache.org/viewvc/cxf/trunk/api/src/main/java/org/apache/cxf/transport/Observable.java?rev=1058291&r1=1058290&r2=1058291&view=diff
==============================================================================
--- cxf/trunk/api/src/main/java/org/apache/cxf/transport/Observable.java
(original)
+++ cxf/trunk/api/src/main/java/org/apache/cxf/transport/Observable.java Wed
Jan 12 19:49:59 2011
@@ -33,7 +33,7 @@ public interface Observable {
/**
* Retrieves the message observer for incoming messages
- * @return
+ * @return the MessageObserver for incoming messages
*/
MessageObserver getMessageObserver();
}
Modified:
cxf/trunk/api/src/main/java/org/apache/cxf/ws/policy/AssertionBuilderRegistry.java
URL:
http://svn.apache.org/viewvc/cxf/trunk/api/src/main/java/org/apache/cxf/ws/policy/AssertionBuilderRegistry.java?rev=1058291&r1=1058290&r2=1058291&view=diff
==============================================================================
---
cxf/trunk/api/src/main/java/org/apache/cxf/ws/policy/AssertionBuilderRegistry.java
(original)
+++
cxf/trunk/api/src/main/java/org/apache/cxf/ws/policy/AssertionBuilderRegistry.java
Wed Jan 12 19:49:59 2011
@@ -51,7 +51,7 @@ public interface AssertionBuilderRegistr
* If set to false, the policy engine will throw an exception upon
* encountering an assertion type for which no AssertionBuilder
* has been registered.
- * @return
+ * @return false if unknown assertions will result in an exception
*/
boolean isIgnoreUnknownAssertions();
Modified:
cxf/trunk/api/src/main/java/org/apache/cxf/ws/policy/PolicyBuilder.java
URL:
http://svn.apache.org/viewvc/cxf/trunk/api/src/main/java/org/apache/cxf/ws/policy/PolicyBuilder.java?rev=1058291&r1=1058290&r2=1058291&view=diff
==============================================================================
--- cxf/trunk/api/src/main/java/org/apache/cxf/ws/policy/PolicyBuilder.java
(original)
+++ cxf/trunk/api/src/main/java/org/apache/cxf/ws/policy/PolicyBuilder.java Wed
Jan 12 19:49:59 2011
@@ -67,7 +67,7 @@ public interface PolicyBuilder {
/**
* Return the PolicyRegistry associated with the builder
- * @return
+ * @return the PolicyRegistry
*/
PolicyRegistry getPolicyRegistry();
Modified: cxf/trunk/api/src/main/java/org/apache/cxf/wsdl/WSDLManager.java
URL:
http://svn.apache.org/viewvc/cxf/trunk/api/src/main/java/org/apache/cxf/wsdl/WSDLManager.java?rev=1058291&r1=1058290&r2=1058291&view=diff
==============================================================================
--- cxf/trunk/api/src/main/java/org/apache/cxf/wsdl/WSDLManager.java (original)
+++ cxf/trunk/api/src/main/java/org/apache/cxf/wsdl/WSDLManager.java Wed Jan 12
19:49:59 2011
@@ -95,7 +95,7 @@ public interface WSDLManager {
/**
* This object will cache the schemas for a WSDL.
* @param wsdl
- * @return
+ * @return the cache of all the schemas in the wsdl
*/
ServiceSchemaInfo getSchemasForDefinition(Definition wsdl);
Modified: cxf/trunk/parent/pom.xml
URL:
http://svn.apache.org/viewvc/cxf/trunk/parent/pom.xml?rev=1058291&r1=1058290&r2=1058291&view=diff
==============================================================================
--- cxf/trunk/parent/pom.xml (original)
+++ cxf/trunk/parent/pom.xml Wed Jan 12 19:49:59 2011
@@ -101,6 +101,7 @@
<directory>src/main/java</directory>
<excludes>
<exclude>**/*.java</exclude>
+ <exclude>**/package.html</exclude>
</excludes>
</resource>
<resource>
