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 Basename.java BuildNumber.java BZip2.java Checksum.java Chmod.java ExecuteOn.java Unpack.java
Date Wed, 19 Jun 2002 00:03:16 GMT
ehatcher    2002/06/18 17:03:16

  Modified:    src/main/org/apache/tools/ant/taskdefs Tag: ANT_15_BRANCH
                        Basename.java BuildNumber.java BZip2.java
                        Checksum.java Chmod.java ExecuteOn.java Unpack.java
  Log:
  Javadoc cleanups for xdocs generation.
  
  Revision  Changes    Path
  No                   revision
  
  
  No                   revision
  
  
  1.2.2.2   +4 -4      jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Basename.java
  
  Index: Basename.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Basename.java,v
  retrieving revision 1.2.2.1
  retrieving revision 1.2.2.2
  diff -u -r1.2.2.1 -r1.2.2.2
  --- Basename.java	3 Jun 2002 03:32:32 -0000	1.2.2.1
  +++ Basename.java	19 Jun 2002 00:03:16 -0000	1.2.2.2
  @@ -95,21 +95,21 @@
     private String suffix;
   
     /**
  -   * File or directory to get base name from
  +   * File or directory to get base name from.
      */
     public void setFile(File file) {
       this.file = file;
     }
   
     /**
  -   * Property to set base name to
  +   * Property to set base name to.
      */
     public void setProperty(String property) {
       this.property  = property ;
     }
   
     /**
  -   * Optional suffix to remove from base name
  +   * Optional suffix to remove from base name.
      */
     public void setSuffix(String suffix) {
       this.suffix = suffix;
  
  
  
  1.6.2.1   +2 -2      jakarta-ant/src/main/org/apache/tools/ant/taskdefs/BuildNumber.java
  
  Index: BuildNumber.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/BuildNumber.java,v
  retrieving revision 1.6
  retrieving revision 1.6.2.1
  diff -u -r1.6 -r1.6.2.1
  --- BuildNumber.java	15 Apr 2002 12:11:47 -0000	1.6
  +++ BuildNumber.java	19 Jun 2002 00:03:16 -0000	1.6.2.1
  @@ -89,7 +89,7 @@
   
   
       /**
  -     * Specify the file in which the build numberis stored. Defaults to
  +     * The file in which the build number is stored. Defaults to
        * "build.number" if not specified.
        *
        * @param file the file in which build number is stored.
  
  
  
  1.8.2.1   +1 -1      jakarta-ant/src/main/org/apache/tools/ant/taskdefs/BZip2.java
  
  Index: BZip2.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/BZip2.java,v
  retrieving revision 1.8
  retrieving revision 1.8.2.1
  diff -u -r1.8 -r1.8.2.1
  --- BZip2.java	15 Apr 2002 13:36:17 -0000	1.8
  +++ BZip2.java	19 Jun 2002 00:03:16 -0000	1.8.2.1
  @@ -62,7 +62,7 @@
   import org.apache.tools.bzip2.CBZip2OutputStream;
   
   /**
  - * Compresses a file with the BZip2 algorithm. Normally used to compress
  + * Compresses a file with the BZIP2 algorithm. Normally used to compress
    * non-compressed archives such as TAR files.
    *
    * @author <a href="mailto:umagesh@rediffmail.com">Magesh Umasankar</a>
  
  
  
  1.22.2.2  +8 -9      jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Checksum.java
  
  Index: Checksum.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Checksum.java,v
  retrieving revision 1.22.2.1
  retrieving revision 1.22.2.2
  diff -u -r1.22.2.1 -r1.22.2.2
  --- Checksum.java	11 Jun 2002 14:14:48 -0000	1.22.2.1
  +++ Checksum.java	19 Jun 2002 00:03:16 -0000	1.22.2.2
  @@ -73,8 +73,7 @@
   import org.apache.tools.ant.types.FileSet;
   
   /**
  - * This task can be used to create checksums for files.
  - * It can also be used to verify checksums.
  + * Used to create or verify file checksums.
    *
    * @author <a href="mailto:umagesh@apache.org">Magesh Umasankar</a>
    *
  @@ -142,8 +141,8 @@
       }
   
       /**
  -     * Sets the MessageDigest algorithm to be used
  -     * to calculate the checksum.
  +     * Specifies the algorithm to be used to compute the checksum.
  +     * Defaults to "MD5". Other popular algorithms like "SHA" may be used as well.
        */
       public void setAlgorithm(String algorithm) {
           this.algorithm = algorithm;
  @@ -158,22 +157,22 @@
       }
   
       /**
  -     * Sets the File Extension that is be to used to
  -     * create or identify destination file
  +     * Sets the file extension that is be to used to
  +     * create or identify destination file.
        */
       public void setFileext(String fileext) {
           this.fileext = fileext;
       }
   
       /**
  -     * Sets the property to hold the generated checksum
  +     * Sets the property to hold the generated checksum.
        */
       public void setProperty(String property) {
           this.property = property;
       }
   
       /**
  -     * Sets verify property.  This project property holds
  +     * Sets the verify property.  This project property holds
        * the result of a checksum verification - "true" or "false"
        */
       public void setVerifyproperty(String verifyProperty) {
  @@ -197,7 +196,7 @@
       }
   
       /**
  -     * Adds a set of files (nested fileset attribute).
  +     * Files to generate checksums for.
        */
       public void addFileset(FileSet set) {
           filesets.addElement(set);
  
  
  
  1.27.2.1  +27 -4     jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Chmod.java
  
  Index: Chmod.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Chmod.java,v
  retrieving revision 1.27
  retrieving revision 1.27.2.1
  diff -u -r1.27 -r1.27.2.1
  --- Chmod.java	17 Apr 2002 05:50:10 -0000	1.27
  +++ Chmod.java	19 Jun 2002 00:03:16 -0000	1.27.2.1
  @@ -99,6 +99,10 @@
           defaultSet.setProject(project);
       }
   
  +    /**
  +     * The file or single directory of which the permissions must be changed.
  +     * @param src
  +     */
       public void setFile(File src) {
           FileSet fs = new FileSet();
           fs.setDir(new File(src.getParent()));
  @@ -106,17 +110,25 @@
           addFileset(fs);
       }
   
  +    /**
  +     * The directory which holds the files whose permissions must be changed.
  +     * @param src
  +     */
       public void setDir(File src) {
           defaultSet.setDir(src);
       }
   
  +    /**
  +     * The new permissions.
  +     * @param perm
  +     */
       public void setPerm(String perm) {
           createArg().setValue(perm);
           havePerm = true;
       }
   
       /**
  -     * add a name entry on the include list
  +     * Add a name entry on the include list.
        */
       public PatternSet.NameEntry createInclude() {
           defaultSetDefined = true;
  @@ -124,7 +136,7 @@
       }
   
       /**
  -     * add a name entry on the exclude list
  +     * Add a name entry on the exclude list.
        */
       public PatternSet.NameEntry createExclude() {
           defaultSetDefined = true;
  @@ -132,7 +144,7 @@
       }
   
       /**
  -     * add a set of patterns
  +     * Add a set of patterns.
        */
       public PatternSet createPatternSet() {
           defaultSetDefined = true;
  @@ -218,17 +230,28 @@
           }
       }
   
  -
  +    /**
  +     * Not supported.
  +     * @param e
  +     */
       public void setExecutable(String e) {
           throw new BuildException(taskType 
               + " doesn\'t support the executable attribute", location);
       }
   
  +    /**
  +     * Not supported.
  +     * @param cmdl
  +     */
       public void setCommand(Commandline cmdl) {
           throw new BuildException(taskType 
               + " doesn\'t support the command attribute", location);
       }
   
  +    /**
  +     * Not supported.
  +     * @param skip
  +     */
       public void setSkipEmptyFilesets(boolean skip) {
           throw new BuildException(taskType 
               + " doesn\'t support the skipemptyfileset attribute", location);
  
  
  
  1.30.2.2  +1 -1      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.2.1
  retrieving revision 1.30.2.2
  diff -u -r1.30.2.1 -r1.30.2.2
  --- ExecuteOn.java	18 Jun 2002 20:33:29 -0000	1.30.2.1
  +++ ExecuteOn.java	19 Jun 2002 00:03:16 -0000	1.30.2.2
  @@ -124,7 +124,7 @@
       }
   
       /**
  -     * Shall the command work only on files, directories or both?
  +     * Whether the command works only on files, directories or both?
        */
       public void setType(FileDirBoth type) {
           this.type = type.getValue();
  
  
  
  1.11.2.1  +8 -0      jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Unpack.java
  
  Index: Unpack.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Unpack.java,v
  retrieving revision 1.11
  retrieving revision 1.11.2.1
  diff -u -r1.11 -r1.11.2.1
  --- Unpack.java	15 Apr 2002 08:39:18 -0000	1.11
  +++ Unpack.java	19 Jun 2002 00:03:16 -0000	1.11.2.1
  @@ -96,10 +96,18 @@
           setDest(project.resolveFile(dest));
       }
   
  +    /**
  +     * The file to expand.
  +     * @param src file to expand
  +     */
       public void setSrc(File src) {
           source = src;
       }
   
  +    /**
  +     * The destination file or directory.
  +     * @param dest destination file or directory
  +     */
       public void setDest(File dest) {
           this.dest = dest;
       }
  
  
  

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