You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by an...@apache.org on 2004/11/19 08:41:03 UTC

svn commit: r105794 - in cocoon/branches/BRANCH_2_1_X/src: blocks/authentication-fw/java/org/apache/cocoon/webapps/authentication/components blocks/portal/java/org/apache/cocoon/portal blocks/scratchpad/java/org/apache/cocoon/components/flow/ws java/org/apache/cocoon/acting java/org/apache/cocoon/components/flow/javascript/fom java/org/apache/cocoon/components/thread java/org/apache/cocoon/util/log

Author: antonio
Date: Thu Nov 18 23:41:03 2004
New Revision: 105794

Modified:
   cocoon/branches/BRANCH_2_1_X/src/blocks/authentication-fw/java/org/apache/cocoon/webapps/authentication/components/Authenticator.java
   cocoon/branches/BRANCH_2_1_X/src/blocks/portal/java/org/apache/cocoon/portal/LinkService.java
   cocoon/branches/BRANCH_2_1_X/src/blocks/scratchpad/java/org/apache/cocoon/components/flow/ws/EndpointDefinition.java
   cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/acting/AbstractValidatorAction.java
   cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/flow/javascript/fom/FOM_JavaScriptInterpreter.java
   cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/thread/DefaultThreadPool.java
   cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/util/log/CocoonStreamTargetFactory.java
Log:
Fix javadocs

Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/authentication-fw/java/org/apache/cocoon/webapps/authentication/components/Authenticator.java
==============================================================================
--- cocoon/branches/BRANCH_2_1_X/src/blocks/authentication-fw/java/org/apache/cocoon/webapps/authentication/components/Authenticator.java	(original)
+++ cocoon/branches/BRANCH_2_1_X/src/blocks/authentication-fw/java/org/apache/cocoon/webapps/authentication/components/Authenticator.java	Thu Nov 18 23:41:03 2004
@@ -28,7 +28,7 @@
  * An authenticator must be implemented in a thread safe manner!
  *
  * @author <a href="mailto:cziegeler@apache.org">Carsten Ziegeler</a>
- * @version CVS $Id: Authenticator.java,v 1.11 2004/03/05 13:01:40 bdelacretaz Exp $
+ * @version CVS $Id$
 */
 public interface Authenticator {
 
@@ -67,7 +67,7 @@
 
     /**
      * Try to authenticate the user.
-     * @return A AuthenticationResult that is either valid (authentication
+     * @return An AuthenticationResult that is either valid (authentication
      *         successful) or invalid (authentication failed.
      * @throws ProcessingException Only if an error occurs
      */

Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/portal/java/org/apache/cocoon/portal/LinkService.java
==============================================================================
--- cocoon/branches/BRANCH_2_1_X/src/blocks/portal/java/org/apache/cocoon/portal/LinkService.java	(original)
+++ cocoon/branches/BRANCH_2_1_X/src/blocks/portal/java/org/apache/cocoon/portal/LinkService.java	Thu Nov 18 23:41:03 2004
@@ -48,7 +48,7 @@
 
     /**
      * Get the uri for this coplet containing the additional events.
-     * @param events The events to add: These can either be {@link Event}s or {@link #ParameterDescription}s.
+     * @param events The events to add: These can either be {@link Event}s or {@link ParameterDescription}s.
      * @return A URI
      */
     String getLinkURI(List events);

Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/scratchpad/java/org/apache/cocoon/components/flow/ws/EndpointDefinition.java
==============================================================================
--- cocoon/branches/BRANCH_2_1_X/src/blocks/scratchpad/java/org/apache/cocoon/components/flow/ws/EndpointDefinition.java	(original)
+++ cocoon/branches/BRANCH_2_1_X/src/blocks/scratchpad/java/org/apache/cocoon/components/flow/ws/EndpointDefinition.java	Thu Nov 18 23:41:03 2004
@@ -60,7 +60,7 @@
      * Returns the target namespace of the WSDL document in which this endpoint
      * is defined.
      *
-     * @return
+     * @return String
      */
     public String getNamespaceURI() {
         return namespaceURI;
@@ -69,7 +69,7 @@
     /**
      * Returns the name of the service that this endpoint belongs to.
      *
-     * @return
+     * @return String
      */
     public String getServiceName() {
         return service.getQName().getLocalPart();
@@ -78,7 +78,7 @@
     /**
      * Returns the name of the port that concretely defines the endpoint.
      *
-     * @return
+     * @return String
      */
     public String getPortName() {
         return port.getName();

Modified: cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/acting/AbstractValidatorAction.java
==============================================================================
--- cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/acting/AbstractValidatorAction.java	(original)
+++ cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/acting/AbstractValidatorAction.java	Thu Nov 18 23:41:03 2004
@@ -187,7 +187,7 @@
  * </table>
  * @author <a href="mailto:Martin.Man@seznam.cz">Martin Man</a>
  * @author <a href="mailto:haul@apache.org">Christian Haul</a>
- * @version CVS $Id: AbstractValidatorAction.java,v 1.12 2004/04/03 03:01:35 joerg Exp $
+ * @version CVS $Id$
  */
 public abstract class AbstractValidatorAction
     extends AbstractComplementaryConfigurableAction
@@ -206,7 +206,7 @@
 
     /**
      * Are parameters encoded as strings?
-     * @return
+     * @return boolean
      */
     abstract boolean isStringEncoded();
 

Modified: cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/flow/javascript/fom/FOM_JavaScriptInterpreter.java
==============================================================================
--- cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/flow/javascript/fom/FOM_JavaScriptInterpreter.java	(original)
+++ cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/flow/javascript/fom/FOM_JavaScriptInterpreter.java	Thu Nov 18 23:41:03 2004
@@ -372,7 +372,7 @@
 
     /**
      * Associates a JavaScript scope, a Scriptable object, with
-     * {@link #getInterpreterID identifier} of this {@link Interpreter}
+     * {@link #getInterpreterID() identifier} of this {@link Interpreter}
      * instance.
      *
      * @param scope a <code>ThreadScope</code> value

Modified: cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/thread/DefaultThreadPool.java
==============================================================================
--- cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/thread/DefaultThreadPool.java	(original)
+++ cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/thread/DefaultThreadPool.java	Thu Nov 18 23:41:03 2004
@@ -196,7 +196,7 @@
     }
 
     /**
-     * @see org.apache.cocoon.components.thread.ThreadPool#shutdownGraceful()
+     * @see org.apache.cocoon.components.thread.ThreadPool#shutdown()
      */
     public void shutdown(  )
     {

Modified: cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/util/log/CocoonStreamTargetFactory.java
==============================================================================
--- cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/util/log/CocoonStreamTargetFactory.java	(original)
+++ cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/util/log/CocoonStreamTargetFactory.java	Thu Nov 18 23:41:03 2004
@@ -20,7 +20,7 @@
 import org.apache.log.format.Formatter;
 
 /**
- * TargetFactory for {@link org.apache.log.output.io.StreamTarget}.
+ * TargetFactory for {@link org.apache.log.output.io.StreamTarget }.
  *
  * This factory is able to create different StreamTargets according to the following
  * configuration syntax:
@@ -40,7 +40,7 @@
  * <p>The syntax of "format" is the same as in <code>CocoonTargetFactory</code>.</p>
  *
  * @author <a href="mailto:giacomo@apache.org">Giacomo Pati</a>
- * @version CVS $Id: CocoonStreamTargetFactory.java,v 1.3 2004/03/05 13:03:01 bdelacretaz Exp $
+ * @version CVS $Id$
  */
 public class CocoonStreamTargetFactory
     extends StreamTargetFactory {