ws-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dk...@apache.org
Subject svn commit: r1794394 - in /webservices/neethi/trunk/src/main/java/org/apache/neethi: ./ builders/converters/ builders/xml/ util/
Date Mon, 08 May 2017 15:35:14 GMT
Author: dkulp
Date: Mon May  8 15:35:14 2017
New Revision: 1794394

URL: http://svn.apache.org/viewvc?rev=1794394&view=rev
Log:
Update javadocs so new javadoc plugin will work

Modified:
    webservices/neethi/trunk/src/main/java/org/apache/neethi/Assertion.java
    webservices/neethi/trunk/src/main/java/org/apache/neethi/AssertionBuilderFactory.java
    webservices/neethi/trunk/src/main/java/org/apache/neethi/AssertionBuilderFactoryImpl.java
    webservices/neethi/trunk/src/main/java/org/apache/neethi/Policy.java
    webservices/neethi/trunk/src/main/java/org/apache/neethi/PolicyEngine.java
    webservices/neethi/trunk/src/main/java/org/apache/neethi/PolicyOperator.java
    webservices/neethi/trunk/src/main/java/org/apache/neethi/PolicyReference.java
    webservices/neethi/trunk/src/main/java/org/apache/neethi/builders/converters/Converter.java
    webservices/neethi/trunk/src/main/java/org/apache/neethi/builders/xml/XmlPrimitiveAssertion.java
    webservices/neethi/trunk/src/main/java/org/apache/neethi/util/Service.java

Modified: webservices/neethi/trunk/src/main/java/org/apache/neethi/Assertion.java
URL: http://svn.apache.org/viewvc/webservices/neethi/trunk/src/main/java/org/apache/neethi/Assertion.java?rev=1794394&r1=1794393&r2=1794394&view=diff
==============================================================================
--- webservices/neethi/trunk/src/main/java/org/apache/neethi/Assertion.java (original)
+++ webservices/neethi/trunk/src/main/java/org/apache/neethi/Assertion.java Mon May  8 15:35:14
2017
@@ -58,7 +58,8 @@ public interface Assertion extends Polic
     void serialize(XMLStreamWriter writer) throws XMLStreamException;
     
     /**
-     * Returns a new PolicyComponent that is the normalized version of this. 
+     * Returns a new PolicyComponent that is the normalized version of this.
+     * @return the normalized policy
      */
     PolicyComponent normalize();
 }

Modified: webservices/neethi/trunk/src/main/java/org/apache/neethi/AssertionBuilderFactory.java
URL: http://svn.apache.org/viewvc/webservices/neethi/trunk/src/main/java/org/apache/neethi/AssertionBuilderFactory.java?rev=1794394&r1=1794393&r2=1794394&view=diff
==============================================================================
--- webservices/neethi/trunk/src/main/java/org/apache/neethi/AssertionBuilderFactory.java
(original)
+++ webservices/neethi/trunk/src/main/java/org/apache/neethi/AssertionBuilderFactory.java
Mon May  8 15:35:14 2017
@@ -34,7 +34,7 @@ public interface AssertionBuilderFactory
 
     /**
      * Returns the PolicyEngine associated with this factory
-     * @return
+     * @return the PolicyEngine
      */
     PolicyBuilder getPolicyEngine();
 
@@ -42,7 +42,7 @@ public interface AssertionBuilderFactory
      * Returns the ConverterRegistry that the builder 
      * uses for converting the object to the types
      * needed for the AssertionBuilders
-     * @return
+     * @return the ConverterRegistry
      */
     ConverterRegistry getConverterRegistry();
 

Modified: webservices/neethi/trunk/src/main/java/org/apache/neethi/AssertionBuilderFactoryImpl.java
URL: http://svn.apache.org/viewvc/webservices/neethi/trunk/src/main/java/org/apache/neethi/AssertionBuilderFactoryImpl.java?rev=1794394&r1=1794393&r2=1794394&view=diff
==============================================================================
--- webservices/neethi/trunk/src/main/java/org/apache/neethi/AssertionBuilderFactoryImpl.java
(original)
+++ webservices/neethi/trunk/src/main/java/org/apache/neethi/AssertionBuilderFactoryImpl.java
Mon May  8 15:35:14 2017
@@ -121,7 +121,7 @@ public class AssertionBuilderFactoryImpl
      * A subclass may want to log when an unknown assertion is encountered
      * or possibly throw an exception or similar.  Another option is to
      * provide a unique AssertionBuilder specific for that QName.
-     * @param qname
+     * @param qname The name of the assertion that was unknown
      * @return a AssertionBuilder to use for the element.
      */
     protected AssertionBuilder<?> handleNoRegisteredBuilder(QName qname) {

Modified: webservices/neethi/trunk/src/main/java/org/apache/neethi/Policy.java
URL: http://svn.apache.org/viewvc/webservices/neethi/trunk/src/main/java/org/apache/neethi/Policy.java?rev=1794394&r1=1794393&r2=1794394&view=diff
==============================================================================
--- webservices/neethi/trunk/src/main/java/org/apache/neethi/Policy.java (original)
+++ webservices/neethi/trunk/src/main/java/org/apache/neethi/Policy.java Mon May  8 15:35:14
2017
@@ -222,7 +222,7 @@ public class Policy extends All {
      * <tt>iterator.hasNext()</tt> will indicates whether there is another
      * Policy alternative.
      * 
-     * @return
+     * @return An iterator over the list of alternatives
      */
     public Iterator<List<Assertion>> getAlternatives() {
         return new PolicyIterator(this, registry);

Modified: webservices/neethi/trunk/src/main/java/org/apache/neethi/PolicyEngine.java
URL: http://svn.apache.org/viewvc/webservices/neethi/trunk/src/main/java/org/apache/neethi/PolicyEngine.java?rev=1794394&r1=1794393&r2=1794394&view=diff
==============================================================================
--- webservices/neethi/trunk/src/main/java/org/apache/neethi/PolicyEngine.java (original)
+++ webservices/neethi/trunk/src/main/java/org/apache/neethi/PolicyEngine.java Mon May  8
15:35:14 2017
@@ -94,7 +94,7 @@ public class PolicyEngine {
      * 
      * @param element
      *            the Policy element
-     * @retun a Policy object of the Policy element
+     * @return a Policy object of the Policy element
      */
     public static Policy getPolicy(OMElement element) {
         return getBuilder().getPolicy(element);
@@ -105,7 +105,7 @@ public class PolicyEngine {
      * 
      * @param element
      *            the Policy element
-     * @retun a Policy object of the Policy element
+     * @return a Policy object of the Policy element
      */
     public static Policy getPolicy(Object element) {
         return getBuilder().getPolicy(element);

Modified: webservices/neethi/trunk/src/main/java/org/apache/neethi/PolicyOperator.java
URL: http://svn.apache.org/viewvc/webservices/neethi/trunk/src/main/java/org/apache/neethi/PolicyOperator.java?rev=1794394&r1=1794393&r2=1794394&view=diff
==============================================================================
--- webservices/neethi/trunk/src/main/java/org/apache/neethi/PolicyOperator.java (original)
+++ webservices/neethi/trunk/src/main/java/org/apache/neethi/PolicyOperator.java Mon May 
8 15:35:14 2017
@@ -32,7 +32,7 @@ public interface PolicyOperator extends
     /**
      * Add a PolicyComponent to the PolicyOperator.
      * 
-     * @param component
+     * @param component Component to add to the operator
      */
     void addPolicyComponent(PolicyComponent component);
 

Modified: webservices/neethi/trunk/src/main/java/org/apache/neethi/PolicyReference.java
URL: http://svn.apache.org/viewvc/webservices/neethi/trunk/src/main/java/org/apache/neethi/PolicyReference.java?rev=1794394&r1=1794393&r2=1794394&view=diff
==============================================================================
--- webservices/neethi/trunk/src/main/java/org/apache/neethi/PolicyReference.java (original)
+++ webservices/neethi/trunk/src/main/java/org/apache/neethi/PolicyReference.java Mon May
 8 15:35:14 2017
@@ -81,6 +81,7 @@ public class PolicyReference implements
      * Throws an UnsupportedOperationException since PolicyReference.normalize()
      * can't resolve the Policy that it refers to unless a PolicyRegistry is
      * provided.
+     * @return The normalized PolicyComponent
      */
     public PolicyComponent normalize() {
         throw new UnsupportedOperationException("PolicyReference.normalize() is meaningless");

Modified: webservices/neethi/trunk/src/main/java/org/apache/neethi/builders/converters/Converter.java
URL: http://svn.apache.org/viewvc/webservices/neethi/trunk/src/main/java/org/apache/neethi/builders/converters/Converter.java?rev=1794394&r1=1794393&r2=1794394&view=diff
==============================================================================
--- webservices/neethi/trunk/src/main/java/org/apache/neethi/builders/converters/Converter.java
(original)
+++ webservices/neethi/trunk/src/main/java/org/apache/neethi/builders/converters/Converter.java
Mon May  8 15:35:14 2017
@@ -39,7 +39,7 @@ public interface Converter<S, T> {
 
     /**
      * 
-     * @param s
+     * @param s The source object
      * @return the result of the conversion; may not be <code>null</code>
      * @throws ConverterException
      *             if the conversion fails; note that to indicate a failure, the method may
throw

Modified: webservices/neethi/trunk/src/main/java/org/apache/neethi/builders/xml/XmlPrimitiveAssertion.java
URL: http://svn.apache.org/viewvc/webservices/neethi/trunk/src/main/java/org/apache/neethi/builders/xml/XmlPrimitiveAssertion.java?rev=1794394&r1=1794393&r2=1794394&view=diff
==============================================================================
--- webservices/neethi/trunk/src/main/java/org/apache/neethi/builders/xml/XmlPrimitiveAssertion.java
(original)
+++ webservices/neethi/trunk/src/main/java/org/apache/neethi/builders/xml/XmlPrimitiveAssertion.java
Mon May  8 15:35:14 2017
@@ -70,8 +70,7 @@ public class XmlPrimitiveAssertion exten
     /**
      * Sets the wrapped Element.
      * 
-     * @param element
-     *            the Element to be set as wrapped
+     * @param el the Element to be set as wrapped
      */
     public void setValue(Element el) {
         this.element = el;

Modified: webservices/neethi/trunk/src/main/java/org/apache/neethi/util/Service.java
URL: http://svn.apache.org/viewvc/webservices/neethi/trunk/src/main/java/org/apache/neethi/util/Service.java?rev=1794394&r1=1794393&r2=1794394&view=diff
==============================================================================
--- webservices/neethi/trunk/src/main/java/org/apache/neethi/util/Service.java (original)
+++ webservices/neethi/trunk/src/main/java/org/apache/neethi/util/Service.java Mon May  8
15:35:14 2017
@@ -35,13 +35,11 @@ import java.util.Map;
  * This class handles looking up service providers on the class path.
  * It implements the system described in:
  *
- * <a href='http://java.sun.com/j2se/1.3/docs/guide/jar/jar.html#Service Provider'>JAR
+ * <a href='http://docs.oracle.com/javase/6/docs/technotes/guides/jar/jar.html#Service%20Provider'>JAR
  * File Specification Under Service Provider</a>. Note that this
  * interface is very similar to the one they describe which seems to
  * be missing in the JDK.
  *
- * @author <a href="mailto:Thomas.DeWeeese@Kodak.com">Thomas DeWeese</a>
- * @version $Id$
  */
 public final class Service {
 
@@ -67,6 +65,7 @@ public final class Service {
      * default constructors.
      *
      * @param cls The class/interface to search for providers of.
+     * @return The list of providers that implement the cls
      */
     public static synchronized <T> List<? extends T> providers(Class<T>
cls) {
 



Mime
View raw message