ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ehatc...@apache.org
Subject cvs commit: jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/net FTP.java
Date Thu, 20 Jun 2002 00:35:47 GMT
ehatcher    2002/06/19 17:35:47

  Modified:    src/main/org/apache/tools/ant/taskdefs/optional/depend Tag:
                        ANT_15_BRANCH Depend.java
               src/main/org/apache/tools/ant/taskdefs/optional Tag:
                        ANT_15_BRANCH EchoProperties.java
               src/main/org/apache/tools/ant/taskdefs/optional/ejb Tag:
                        ANT_15_BRANCH Ejbc.java EjbJar.java
               src/main/org/apache/tools/ant/taskdefs/optional/net Tag:
                        ANT_15_BRANCH FTP.java
  Log:
  Javadoc cleanups for xdocs generation. Yes, I'm going alphabetically!
  
  Revision  Changes    Path
  No                   revision
  
  
  No                   revision
  
  
  1.27.2.1  +11 -13    jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/depend/Depend.java
  
  Index: Depend.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/depend/Depend.java,v
  retrieving revision 1.27
  retrieving revision 1.27.2.1
  diff -u -r1.27 -r1.27.2.1
  --- Depend.java	15 Apr 2002 12:16:31 -0000	1.27
  +++ Depend.java	20 Jun 2002 00:35:46 -0000	1.27.2.1
  @@ -173,7 +173,7 @@
       }
   
       /**
  -     * Creates a nested classpath element.
  +     * Adds a classpath to be used for this dependency check.
        *
        * @return A path object to be configured by Ant
        */
  @@ -185,7 +185,7 @@
       }
   
       /**
  -     * Adds a reference to a CLASSPATH defined elsewhere.
  +     * Adds a reference to a classpath defined elsewhere.
        *
        * @param r a reference to a path object to be used as the depend
        *      classpath
  @@ -687,8 +687,6 @@
        */
       protected void scanDir(File srcDir, String files[]) {
   
  -        long now = System.currentTimeMillis();
  -
           for (int i = 0; i < files.length; i++) {
               File srcFile = new File(srcDir, files[i]);
               if (files[i].endsWith(".java")) {
  @@ -798,7 +796,7 @@
   
   
       /**
  -     * Set the source dirs to find the source Java files.
  +     * Set the directories path to find the Java source files.
        *
        * @param srcPath the source path
        */
  @@ -807,7 +805,7 @@
       }
   
       /**
  -     * Set the destination directory where the compiled java files exist.
  +     * Set the destination directory where the compiled Java files exist.
        *
        * @param destPath the destination areas where build files are written
        */
  @@ -816,7 +814,7 @@
       }
   
       /**
  -     * Sets the dependency cache file
  +     * Sets the dependency cache file.
        *
        * @param cache the dependency cache file
        */
  @@ -825,10 +823,10 @@
       }
   
       /**
  -     * Set the closure flag. When not set, the depend task will only follow
  -     * direct dependencies between classes. When set, transitive
  -     * dependencies are followed until the closure of the dependency set if
  -     * reached.
  +     * If true, transitive dependencies are followed until the
  +     * closure of the dependency set if reached.
  +     * When not set, the depend task will only follow
  +     * direct dependencies between classes.
        *
        * @param closure indicate if dependency closure is required.
        */
  @@ -837,8 +835,8 @@
       }
   
       /**
  -     * Flag to indicate whether the reverse dependency list should be dumped
  -     * to debug
  +     * If true, the dependency information will be written
  +     * to the debug level log.
        *
        * @param dump set to true to dump dependency information to the log
        */
  
  
  
  No                   revision
  
  
  No                   revision
  
  
  1.8.2.4   +2 -1      jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/EchoProperties.java
  
  Index: EchoProperties.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/EchoProperties.java,v
  retrieving revision 1.8.2.3
  retrieving revision 1.8.2.4
  diff -u -r1.8.2.3 -r1.8.2.4
  --- EchoProperties.java	4 Jun 2002 06:36:31 -0000	1.8.2.3
  +++ EchoProperties.java	20 Jun 2002 00:35:46 -0000	1.8.2.4
  @@ -135,7 +135,8 @@
   
   
       /**
  -     *  Sets the failure mode for the task.
  +     * If true, the task will fail if an error occurs writing the properties
  +     * file, otherwise errors are just logged.
        *
        *@param  failonerror  <tt>true</tt> if IO exceptions are reported as build
        *      exceptions, or <tt>false</tt> if IO exceptions are ignored.
  
  
  
  No                   revision
  
  
  No                   revision
  
  
  1.18.2.1  +3 -3      jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ejb/Ejbc.java
  
  Index: Ejbc.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ejb/Ejbc.java,v
  retrieving revision 1.18
  retrieving revision 1.18.2.1
  diff -u -r1.18 -r1.18.2.1
  --- Ejbc.java	30 Apr 2002 14:28:48 -0000	1.18
  +++ Ejbc.java	20 Jun 2002 00:35:46 -0000	1.18.2.1
  @@ -166,7 +166,7 @@
       }
   
       /**
  -     * Set the directory from where the serialised deployment descriptors are
  +     * Set the directory from where the serialized deployment descriptors are
        * to be read.
        *
        * @param dirName the name of the directory containing the serialised deployment descriptors.
  @@ -176,7 +176,7 @@
       }
   
       /**
  -     * Set the directory into which the support classes, RMI stubs, etc are to be written
  +     * Set the directory into which the support classes, RMI stubs, etc are to be written.
        *
        * @param dirName the name of the directory into which code is generated
        */
  @@ -190,7 +190,7 @@
       }
   
       /**
  -     * Set the generated manifest file.
  +     * Set the name of the generated manifest file.
        *
        * For each EJB that is processed an entry is created in this file. This can then be
used
        * to create a jar file for dploying the beans.
  
  
  
  1.34.2.2  +19 -27    jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.java
  
  Index: EjbJar.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.java,v
  retrieving revision 1.34.2.1
  retrieving revision 1.34.2.2
  diff -u -r1.34.2.1 -r1.34.2.2
  --- EjbJar.java	14 Jun 2002 15:15:01 -0000	1.34.2.1
  +++ EjbJar.java	20 Jun 2002 00:35:46 -0000	1.34.2.2
  @@ -77,7 +77,7 @@
   
   /**
    * <p>
  - * Provides automated ejb jar file creation for ant. Extends the
  + * Provides automated EJB JAR file creation. Extends the
    * MatchingTask class provided in the default ant distribution to provide a
    * directory scanning EJB jarfile generator.
    * </p>
  @@ -239,8 +239,7 @@
       }
   
       /**
  -     * Create a weblogic nested element used to configure a
  -     * deployment tool for Weblogic server.
  +     * Adds a deployment tool for Weblogic server.
        *
        * @return the deployment tool instance to be configured.
        */
  @@ -251,8 +250,7 @@
       }
   
       /**
  -     * Create a websphere nested element used to configure a
  -     * deployment tool for Websphere 4.0 server.
  +     * Adds a deployment tool for Websphere 4.0 server.
        *
        * @return the deployment tool instance to be configured.
        */
  @@ -263,8 +261,7 @@
       }
   
       /**
  -     * Create a Borland nested element used to configure a
  -     * deployment tool for Borland server.
  +     * Adds a deployment tool for Borland server.
        *
        * @return the deployment tool instance to be configured.
        */
  @@ -278,8 +275,7 @@
       }
   
       /**
  -     * Create a nested element used to configure a deployment tool for iPlanet
  -     * Application Server.
  +     * Adds a deployment tool for iPlanet Application Server.
        *
        * @return the deployment tool instance to be configured.
        */
  @@ -292,8 +288,7 @@
       }
   
       /**
  -     * Create a jboss nested element used to configure a
  -     * deployment tool for Jboss server.
  +     * Adds a deployment tool for JBoss server.
        *
        * @return the deployment tool instance to be configured.
        */
  @@ -304,8 +299,7 @@
       }
   
       /**
  -     * Create a jonas nested element used to configure a
  -     * deployment tool for JOnAS server.
  +     * Adds a deployment tool for JOnAS server.
        *
        * @return the deployment tool instance to be configured.
        */
  @@ -318,8 +312,8 @@
       }
   
       /**
  -     * Create a nested element for weblogic when using the Toplink
  -     * Object- Relational mapping.
  +     * Adds a deployment tool for Weblogic when using the Toplink
  +     * Object-Relational mapping.
        *
        * @return the deployment tool instance to be configured.
        */
  @@ -334,10 +328,8 @@
       }
   
       /**
  -     * creates a nested classpath element.
  -     *
  -     * This classpath is used to locate the super classes and interfaces
  -     * of the classes that will make up the EJB jar.
  +     * Adds to the classpath used to locate the super classes and
  +     * interfaces of the classes that will make up the EJB JAR.
        *
        * @return the path to be configured.
        */
  @@ -363,7 +355,7 @@
       }
   
       /**
  -     * Create a file set for support elements
  +     * Adds a fileset for support elements.
        *
        * @return a fileset which can be populated with support files.
        */
  @@ -390,7 +382,7 @@
        }
   
       /**
  -     * Set the srcdir attribute. The source directory is the directory that
  +     * Sets the source directory, which is the directory that
        * contains the classes that will be added to the EJB jar. Typically
        * this will include the home and remote interfaces and the bean class.
        *
  @@ -414,7 +406,7 @@
       }
   
       /**
  -     * Set the analyzer to use when adding in dependencies to the jar
  +     * Set the analyzer to use when adding in dependencies to the JAR.
        *
        * @param analyzer the name of the dependency analyzer or a class.
        */
  @@ -423,7 +415,7 @@
       }
   
       /**
  -     * Set the base name of the EJB jar that is to be created if it is not
  +     * Set the base name of the EJB JAR that is to be created if it is not
        * to be determined from the name of the deployment descriptor files.
        *
        * @param inValue the basename that will be used when writing the jar
  @@ -480,9 +472,9 @@
       }
   
       /**
  -     * Set the flat dest dir flag. This flag controls whether the
  +     * Controls whether the
        * destination jars are written out in the destination directory with
  -     * the same hierarchal structure from which the deployment descriptors
  +     * the same hierarchical structure from which the deployment descriptors
        * have been read. If this is set to true the generated EJB jars are
        * written into the root of the destination directory, otherwise they
        * are written out in the same relative position as the deployment
  @@ -508,8 +500,8 @@
       }
   
       /**
  -     * Set the baseNameTerminator. The basename terminator is the string
  -     * which terminates the bean name. The convention used by this task is
  +     * The string which terminates the bean name.
  +     * The convention used by this task is
        * that bean descriptors are named as the BeanName with some suffix. The
        * baseNameTerminator string separates the bean name and the suffix and
        * is used to determine the bean name.
  
  
  
  No                   revision
  
  
  No                   revision
  
  
  1.21.2.2  +13 -8     jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/net/FTP.java
  
  Index: FTP.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/net/FTP.java,v
  retrieving revision 1.21.2.1
  retrieving revision 1.21.2.2
  diff -u -r1.21.2.1 -r1.21.2.2
  --- FTP.java	22 May 2002 20:22:52 -0000	1.21.2.1
  +++ FTP.java	20 Jun 2002 00:35:47 -0000	1.21.2.2
  @@ -79,7 +79,7 @@
   import java.util.Vector;
   
   /**
  - * Basic FTP client that performs the following actions:
  + * Basic FTP client. Performs the following actions:
    * <ul>
    *   <li> <strong>send</strong> - send files to a remote server. This
is the
    *   default action.</li>
  @@ -296,8 +296,7 @@
   
   
       /**
  -     * Specifies whether to use binary-mode or text-mode transfers. Set to
  -     * true to send binary mode. Binary mode is enabled by default.
  +     * If true, uses binary mode, otherwise text mode (default is binary).
        */
       public void setBinary(boolean binary) {
           this.binary = binary;
  @@ -333,7 +332,7 @@
   
   
       /**
  -     * A synonym for setNewer. Set to true to transmit only new or changed
  +     * A synonym for setnewer. Set to true to transmit only new or changed
        * files.
        */
       public void setDepends(boolean depends) {
  @@ -368,7 +367,9 @@
       }
   
   
  -    /** Adds a set of files (nested fileset attribute).  */
  +    /**
  +     *  Adds a set of files.
  +     */
       public void addFileset(FileSet set) {
           filesets.addElement(set);
       }
  @@ -412,15 +413,19 @@
       }
   
   
  -    /** set the failed transfer flag  */
  +    /**
  +     * If true, enables unsuccessful file put, delete and get
  +     * operations to be skipped with a warning and the remainder
  +     * of the files still transferred.
  +     */
       public void setSkipFailedTransfers(boolean skipFailedTransfers) {
           this.skipFailedTransfers = skipFailedTransfers;
       }
   
   
       /**
  -     * set the flag to skip errors on dir creation (and maybe later other
  -     * server specific errors)
  +     * set the flag to skip errors on directory creation.
  +     * (and maybe later other server specific errors)
        */
       public void setIgnoreNoncriticalErrors(boolean ignoreNoncriticalErrors) {
           this.ignoreNoncriticalErrors = ignoreNoncriticalErrors;
  
  
  

--
To unsubscribe, e-mail:   <mailto:ant-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:ant-dev-help@jakarta.apache.org>


Mime
View raw message