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 Available.java ExecTask.java ExecuteOn.java
Date Tue, 18 Jun 2002 20:33:29 GMT
ehatcher    2002/06/18 13:33:29

  Modified:    src/main/org/apache/tools/ant/taskdefs Tag: ANT_15_BRANCH
                        Available.java ExecTask.java ExecuteOn.java
  Log:
  Javadoc cleanups to get attributes and elements to match our better HTML documentation.
  
  Revision  Changes    Path
  No                   revision
  
  
  No                   revision
  
  
  1.44.2.3  +7 -8      jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Available.java
  
  Index: Available.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Available.java,v
  retrieving revision 1.44.2.2
  retrieving revision 1.44.2.3
  diff -u -r1.44.2.2 -r1.44.2.3
  --- Available.java	28 May 2002 06:13:10 -0000	1.44.2.2
  +++ Available.java	18 Jun 2002 20:33:29 -0000	1.44.2.3
  @@ -94,7 +94,7 @@
       private boolean ignoreSystemclasses = false;
   
       /**
  -     * Set the classpath to be used when searching for classes and resources
  +     * Set the classpath to be used when searching for classes and resources.
        * 
        * @param classpath an Ant Path object containing the search path.
        */
  @@ -103,8 +103,7 @@
       }
   
       /**
  -     * Create a classpath object to be configured by Ant. The resulting
  -     * path will be used when searching for classes or resources
  +     * Classpath to be used when searching for classes and resources.
        *
        * @return an empty Path instance to be configured by Ant.
        */
  @@ -126,7 +125,7 @@
       }
   
       /**
  -     * Set the path to use when looking for a file
  +     * Set the path to use when looking for a file.
        *
        * @param filepath a Path instance containing the search path for files.
        */
  @@ -135,7 +134,7 @@
       }
   
       /**
  -     * Create a filepath to be configured by Ant.
  +     * Path to search for file resources.
        *
        * @return a new Path instance which Ant will configure with a file search
        *         path.
  @@ -158,7 +157,7 @@
       }
   
       /**
  -     * Set the value to be given to the property of the desired resource is
  +     * Set the value to be given to the property if the desired resource is
        * available.
        *
        * @param value the value to be given.
  @@ -191,7 +190,7 @@
       }
   
       /**
  -     * Set the name of a Java resouirce which is required to set the property.
  +     * Set the name of a Java resource which is required to set the property.
        *
        * @param resource the name of a resource which is required to be available.
        */
  @@ -213,7 +212,7 @@
       }
   
       /**
  -     * Set what type of file is required - either a directory or a file.
  +     * Set what type of file is required - either directory or file.
        *
        * @param type an instance of the FileDir enumeratedAttribute indicating
        *             whether the file required is to be a directory or a plain 
  
  
  
  1.36.2.2  +12 -10    jakarta-ant/src/main/org/apache/tools/ant/taskdefs/ExecTask.java
  
  Index: ExecTask.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/ExecTask.java,v
  retrieving revision 1.36.2.1
  retrieving revision 1.36.2.2
  diff -u -r1.36.2.1 -r1.36.2.2
  --- ExecTask.java	28 May 2002 07:06:48 -0000	1.36.2.1
  +++ ExecTask.java	18 Jun 2002 20:33:29 -0000	1.36.2.2
  @@ -133,21 +133,21 @@
       }
   
       /**
  -     * The working directory of the process
  +     * The working directory of the process.
        */
       public void setDir(File d) {
           this.dir = d;
       }
   
       /**
  -     * Only execute the process if <code>os.name</code> is included in
  -     * this string.
  +     * List of operating systems on which the command may be executed.
        */
       public void setOs(String os) {
           this.os = os;
       }
   
       /**
  +     * Deprecated, use executable instead.
        * The full commandline to execute, executable + arguments.
        */
       public void setCommand(Commandline cmdl) {
  @@ -173,21 +173,21 @@
       }
   
       /**
  -     * Throw a BuildException if process returns non 0.
  +     * Fail if the command exits with a non-zero return code.
        */
       public void setFailonerror(boolean fail) {
           failOnError = fail;
       }
   
       /**
  -     * Use a completely new environment
  +     * Do not propagate old environment when new environment variables are specified.
        */
       public void setNewenvironment(boolean newenv) {
           newEnvironment = newenv;
       }
   
       /**
  -     * Add a nested env element - an environment variable.
  +     * Add an environment variable.
        */
       public void addEnv(Environment.Variable var) {
           env.addVariable(var);
  @@ -201,8 +201,8 @@
       }
   
       /**
  -     * fill a property in with a result. 
  -     * when no property is defined: failure to execute
  +     * The name of a property in which the return code of the
  +     * command should be stored. Only of interest if failonerror=false.
        *
        * @since Ant 1.5
        */
  @@ -222,7 +222,8 @@
       }
       
       /**
  -     * fail if execution is wrong
  +     * Stop the build if program cannot be started. Defaults to true.
  +     *
        * @since Ant 1.5     
        */
       public void setFailIfExecutionFails(boolean flag) {
  @@ -230,7 +231,8 @@
       }
       
       /**
  -     * Shall we append to an existing file?
  +     * Whether output should be appended to or overwrite an existing file.
  +     * Defaults to false.
        *
        * @since 1.30, Ant 1.5
        */
  
  
  
  1.30.2.1  +12 -7     jakarta-ant/src/main/org/apache/tools/ant/taskdefs/ExecuteOn.java
  
  Index: ExecuteOn.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/ExecuteOn.java,v
  retrieving revision 1.30
  retrieving revision 1.30.2.1
  diff -u -r1.30 -r1.30.2.1
  --- ExecuteOn.java	25 Apr 2002 12:14:49 -0000	1.30
  +++ ExecuteOn.java	18 Jun 2002 20:33:29 -0000	1.30.2.1
  @@ -77,7 +77,7 @@
    *
    * @since Ant 1.2
    *
  - * @ant.task category="control" name="execon" name="apply"
  + * @ant.task category="control" name="apply"
    */
   public class ExecuteOn extends ExecTask {
   
  @@ -98,14 +98,17 @@
       protected boolean srcIsFirst = true;
   
       /**
  -     * Adds a set of files (nested fileset attribute).
  +     * Source files to operate upon.
        */
       public void addFileset(FileSet set) {
           filesets.addElement(set);
       }
   
       /**
  -     * Should filenames be returned as relative path names?
  +     * Whether the filenames should be passed on the command line as
  +     * absolute or relative pathnames. Paths are relative to the base
  +     * directory of the corresponding fileset for source files or the
  +     * dest attribute for target files.
        */
       public void setRelative(boolean relative) {
           this.relative = relative;
  @@ -113,7 +116,8 @@
   
   
       /**
  -     * Shall the command work on all specified files in parallel?
  +     * If true, run the command only once, appending all files as arguments.
  +     * If false, command will be executed once for every file. Defaults to false.
        */
       public void setParallel(boolean parallel) {
           this.parallel = parallel;
  @@ -127,14 +131,15 @@
       }
   
       /**
  -     * Should empty filesets be ignored?
  +     * If no source files have been found or are newer than their
  +     * corresponding target files, do not run the command.
        */
       public void setSkipEmptyFilesets(boolean skip) {
           skipEmpty = skip;
       }
   
       /**
  -     * Set the destination directory.
  +     * The directory where target files are to be placed.
        */
       public void setDest(File destDir) {
           this.destDir = destDir;
  @@ -168,7 +173,7 @@
       }
   
       /**
  -     * Defines the FileNameMapper to use (nested mapper element).
  +     * Mapper to use for mapping source files to target files.
        */
       public Mapper createMapper() throws BuildException {
           if (mapperElement != null) {
  
  
  

--
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