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 AbstractCvsTask.java Concat.java ConditionTask.java Copy.java Cvs.java
Date Wed, 19 Jun 2002 00:42:43 GMT
ehatcher    2002/06/18 17:42:43

  Modified:    src/main/org/apache/tools/ant/taskdefs Tag: ANT_15_BRANCH
                        AbstractCvsTask.java Concat.java ConditionTask.java
                        Copy.java Cvs.java
  Log:
  Javadoc cleanups for xdocs generation.
  
  Revision  Changes    Path
  No                   revision
  
  
  No                   revision
  
  
  1.12.2.2  +76 -0     jakarta-ant/src/main/org/apache/tools/ant/taskdefs/AbstractCvsTask.java
  
  Index: AbstractCvsTask.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/AbstractCvsTask.java,v
  retrieving revision 1.12.2.1
  retrieving revision 1.12.2.2
  diff -u -r1.12.2.1 -r1.12.2.2
  --- AbstractCvsTask.java	31 May 2002 20:41:48 -0000	1.12.2.1
  +++ AbstractCvsTask.java	19 Jun 2002 00:42:43 -0000	1.12.2.2
  @@ -424,6 +424,11 @@
           return stringBuffer.toString();
       }
   
  +    /**
  +     * The CVSROOT variable.
  +     *
  +     * @param root
  +     */
       public void setCvsRoot(String root) {
   
           // Check if not real cvsroot => set it to null
  @@ -441,6 +446,11 @@
           return this.cvsRoot;
       }
   
  +    /**
  +     * The CVS_RSH variable.
  +     *
  +     * @param rsh
  +     */
       public void setCvsRsh(String rsh) {
           // Check if not real cvsrsh => set it to null
           if (rsh != null) {
  @@ -457,6 +467,11 @@
           return this.cvsRsh;
       }
   
  +    /**
  +     * Port used by CVS to communicate with the server.
  +     *
  +     * @param port
  +     */
       public void setPort(int port){
           this.port = port;
       }
  @@ -466,6 +481,11 @@
           return this.port;
       }
   
  +    /**
  +     * Password file to read passwords from.
  +     *
  +     * @param passFile
  +     */
       public void setPassfile(File passFile){
           this.passFile = passFile;
       }
  @@ -475,6 +495,11 @@
           return this.passFile;
       }
   
  +    /**
  +     * The directory where the checked out files should be placed.
  +     *
  +     * @param dest
  +     */
       public void setDest(File dest) {
           this.dest = dest;
       }
  @@ -484,6 +509,11 @@
           return this.dest;
       }
   
  +    /**
  +     * The package/module to check out.
  +     *
  +     * @param p
  +     */
       public void setPackage(String p) {
           this.cvsPackage = p;
       }
  @@ -493,6 +523,10 @@
           return this.cvsPackage;
       }
   
  +    /**
  +     * The tag of the package/module to check out.
  +     * @param p
  +     */
       public void setTag(String p) {
           // Check if not real tag => set it to null
           if (p != null && p.trim().length() > 0) {
  @@ -514,6 +548,10 @@
       }
   
   
  +    /**
  +     * Use the most recent revision no later than the given date.
  +     * @param p
  +     */
       public void setDate(String p) {
           if (p != null && p.trim().length() > 0) {
               addCommandArgument("-D");
  @@ -521,6 +559,10 @@
           }
       }
   
  +    /**
  +     * The CVS command to execute.
  +     * @param c
  +     */
       public void setCommand(String c) {
           this.command = c;
       }
  @@ -528,26 +570,54 @@
           return this.command;
       }
   
  +    /**
  +     * If true, suppress informational messages.
  +     * @param q
  +     */
       public void setQuiet(boolean q) {
           quiet = q;
       }
   
  +    /**
  +     * If true, report only and don't change any files.
  +     *
  +     * @param ne
  +     */
       public void setNoexec(boolean ne) {
           noexec = ne;
       }
   
  +    /**
  +     * The file to direct standard output from the command.
  +     * @param output
  +     */
       public void setOutput(File output) {
           this.output = output;
       }
   
  +    /**
  +     * The file to direct standard error from the command.
  +     *
  +     * @param error
  +     */
       public void setError(File error) {
           this.error = error;
       }
   
  +    /**
  +     * Whether to append output/error when redirecting to a file.
  +     * @param value
  +     */
       public void setAppend(boolean value){
           this.append = value;
       }
   
  +    /**
  +     * Stop the build process if the command exits with
  +     * a return code other than 0.
  +     * Defaults to false.
  +     * @param failOnError
  +     */
       public void setFailOnError(boolean failOnError) {
           this.failOnError = failOnError;
       }
  @@ -581,6 +651,10 @@
           vecCommandlines.removeElement(c);
       }
   
  +    /**
  +     * Adds direct command-line to execute.
  +     * @param c
  +     */
       public void addConfiguredCommandline(Commandline c) {
           this.addConfiguredCommandline(c, false);
       }
  @@ -611,6 +685,8 @@
       }
   
       /**
  +     * If true, this is the same as compressionlevel="3".
  +     *
        * @param usecomp If true, turns on compression using default
        * level, AbstractCvsTask.DEFAULT_COMPRESSION_LEVEL.
        */
  
  
  
  1.5.2.1   +4 -4      jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Concat.java
  
  Index: Concat.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Concat.java,v
  retrieving revision 1.5
  retrieving revision 1.5.2.1
  diff -u -r1.5 -r1.5.2.1
  --- Concat.java	15 Apr 2002 12:16:31 -0000	1.5
  +++ Concat.java	19 Jun 2002 00:42:43 -0000	1.5.2.1
  @@ -142,14 +142,14 @@
       // Attribute setters.
   
       /**
  -     * Sets the destination file for the stream.
  +     * Sets the destination file, or uses the console if not specified.
        */
       public void setDestfile(File destinationFile) {
           this.destinationFile = destinationFile;
       }
   
       /**
  -     * Sets the behavior when the destination file exists, if set to
  +     * Sets the behavior when the destination file exists. If set to
        * <code>true</code> the stream data will be appended to the
        * existing file, otherwise the existing file will be
        * overwritten. Defaults to <code>false</code>.
  @@ -169,14 +169,14 @@
       // Nested element creators.
   
       /**
  -     * Adds a set of files (nested fileset element).
  +     * Set of files to concatenate.
        */
       public void addFileset(FileSet set) {
           fileSets.addElement(set);
       }
   
       /**
  -     * Adds a list of files (nested filelist element).
  +     * List of files to concatenate.
        */
       public void addFilelist(FileList list) {
           fileSets.addElement(list);
  
  
  
  1.10.2.2  +5 -4      jakarta-ant/src/main/org/apache/tools/ant/taskdefs/ConditionTask.java
  
  Index: ConditionTask.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/ConditionTask.java,v
  retrieving revision 1.10.2.1
  retrieving revision 1.10.2.2
  diff -u -r1.10.2.1 -r1.10.2.2
  --- ConditionTask.java	22 May 2002 17:36:48 -0000	1.10.2.1
  +++ ConditionTask.java	19 Jun 2002 00:42:43 -0000	1.10.2.2
  @@ -60,8 +60,8 @@
   import org.apache.tools.ant.taskdefs.condition.ConditionBase;
   
   /**
  - * &lt;condition&gt; task as a generalization of &lt;available&gt; and
  - * &lt;uptodate&gt;.
  + * Task to set a property conditionally using &lt;uptodate&gt;, &lt;available&gt;,
  + * and many other supported conditions.
    *
    * <p>This task supports boolean logic as well as pluggable conditions
    * to decide, whether a property should be set.</p>
  @@ -89,7 +89,8 @@
       public void setProperty(String p) {property = p;}
   
       /**
  -     * The value for the property to set. Defaults to "true".
  +     * The value for the property to set, if condition evaluates to true.
  +     * Defaults to "true".
        *
        * @since Ant 1.4
        */
  
  
  
  1.42.2.1  +7 -7      jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Copy.java
  
  Index: Copy.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Copy.java,v
  retrieving revision 1.42
  retrieving revision 1.42.2.1
  diff -u -r1.42 -r1.42.2.1
  --- Copy.java	16 Apr 2002 07:15:18 -0000	1.42
  +++ Copy.java	19 Jun 2002 00:42:43 -0000	1.42.2.1
  @@ -154,7 +154,7 @@
       }
   
       /**
  -     * Create a nested filterchain
  +     * Adds a FilterChain.
        */
       public FilterChain createFilterChain() {
           FilterChain filterChain = new FilterChain();
  @@ -163,7 +163,7 @@
       }
   
       /**
  -     * Create a nested filterset
  +     * Adds a filterset.
        */
       public FilterSet createFilterSet() {
           FilterSet filterSet = new FilterSet();
  @@ -217,7 +217,7 @@
       }
   
       /**
  -     * Sets filtering.
  +     * If true, enables filtering.
        */
       public void setFiltering(boolean filtering) {
           this.filtering = filtering;
  @@ -260,7 +260,7 @@
       }
   
       /**
  -     * Note errors to the output, but keep going
  +     * If false, note errors to the output but keep going.
        * @param failonerror true or false
        */
        public void setFailOnError(boolean failonerror) {
  @@ -268,14 +268,14 @@
        }
   
       /**
  -     * Adds a set of files (nested fileset attribute).
  +     * Adds a set of files to copy.
        */
       public void addFileset(FileSet set) {
           filesets.addElement(set);
       }
   
       /**
  -     * Defines the FileNameMapper to use (nested mapper element).
  +     * Defines the mapper to map source to destination files.
        */
       public Mapper createMapper() throws BuildException {
           if (mapperElement != null) {
  
  
  
  1.27.2.1  +2 -0      jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Cvs.java
  
  Index: Cvs.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Cvs.java,v
  retrieving revision 1.27
  retrieving revision 1.27.2.1
  diff -u -r1.27 -r1.27.2.1
  --- Cvs.java	16 Apr 2002 10:36:25 -0000	1.27
  +++ Cvs.java	19 Jun 2002 00:42:43 -0000	1.27.2.1
  @@ -55,6 +55,8 @@
   package org.apache.tools.ant.taskdefs;
   
   /**
  + * Performs operations on a CVS repository.
  + *
    * original 1.20
    *
    *  NOTE: This implementation has been moved to AbstractCvsTask with
  
  
  

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