ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ste...@apache.org
Subject cvs commit: jakarta-ant/src/main/org/apache/tools/ant/taskdefs War.java Zip.java
Date Fri, 21 Jun 2002 07:08:17 GMT
stevel      2002/06/21 00:08:16

  Modified:    src/main/org/apache/tools/ant/taskdefs Tag: ANT_15_BRANCH
                        War.java Zip.java
  Log:
  more javadoc updates. That should be core tasks up to date for an automated generation of
summary docs.
  
  Revision  Changes    Path
  No                   revision
  
  
  No                   revision
  
  
  1.23.2.2  +1 -1      jakarta-ant/src/main/org/apache/tools/ant/taskdefs/War.java
  
  Index: War.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/War.java,v
  retrieving revision 1.23.2.1
  retrieving revision 1.23.2.2
  diff -u -r1.23.2.1 -r1.23.2.2
  --- War.java	21 Jun 2002 06:30:46 -0000	1.23.2.1
  +++ War.java	21 Jun 2002 07:08:16 -0000	1.23.2.2
  @@ -102,7 +102,7 @@
        * <i>Deprecated<i> name of the file to create 
        * -use <tt>destfile</tt> instead. 
        * @deprecated Use setDestFile(File) instead
  -     * @ant attribute ignored="true"
  +     * @ant.attribute ignored="true"
        */
       public void setWarfile(File warFile) {
           setDestFile(warFile);
  
  
  
  1.78.2.2  +33 -12    jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Zip.java
  
  Index: Zip.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Zip.java,v
  retrieving revision 1.78.2.1
  retrieving revision 1.78.2.2
  diff -u -r1.78.2.1 -r1.78.2.2
  --- Zip.java	19 Jun 2002 01:51:01 -0000	1.78.2.1
  +++ Zip.java	21 Jun 2002 07:08:16 -0000	1.78.2.2
  @@ -84,7 +84,7 @@
   import org.apache.tools.zip.ZipEntry;
   
   /**
  - * Create a ZIP archive.
  + * Create a zipfile.
    *
    * @author James Davidson <a href="mailto:duncan@x180.com">duncan@x180.com</a>
    * @author Jon S. Stevens <a href="mailto:jon@clearink.com">jon@clearink.com</a>
  @@ -133,6 +133,7 @@
        * create the .zip file.
        *
        * @deprecated Use setDestFile(File) instead.
  +     * @ant.attribute ignore="true"
        */
       public void setZipfile(File zipFile) {
           setDestFile(zipFile);
  @@ -140,9 +141,10 @@
   
       /**
        * This is the name/location of where to
  -     * create the .zip file.
  -     * @since Ant 1.5alpha
  +     * create the file.
  +     * @since Ant 1.5
        * @deprecated Use setDestFile(File) instead
  +     * @ant.attribute ignore="true"
        */
       public void setFile(File file) {
           setDestFile(file);
  @@ -150,7 +152,7 @@
   
   
       /**
  -     * Archive file to create.
  +     * The file to create; required.
        * @since Ant 1.5
        * @param destFile The new destination File
        */
  @@ -160,28 +162,31 @@
   
   
       /**
  -     * Directory from which to archive files.
  +     * Directory from which to archive files; optional.
        */
       public void setBasedir(File baseDir) {
           this.baseDir = baseDir;
       }
   
       /**
  -     * Whether we want to compress the files or only store them.
  +     * Whether we want to compress the files or only store them;
  +     * optional, default=true;
        */
       public void setCompress(boolean c) {
           doCompress = c;
       }
   
       /**
  -     * If true, emulate Sun's jar utility by not adding parent directories.
  +     * If true, emulate Sun's jar utility by not adding parent directories;
  +     * optional, defaults to false.
        */
       public void setFilesonly(boolean f) {
           doFilesonly = f;
       }
   
       /**
  -     * If true, updates an existing file, otherwise create a new one.
  +     * If true, updates an existing file, otherwise overwrite
  +     * any existing one; optional defaults to false.
        */
       public void setUpdate(boolean c) {
           doUpdate = c;
  @@ -218,7 +223,8 @@
       }
   
       /**
  -     * Sets behavior for when a duplicate file is about to be added.
  +     * Sets behavior for when a duplicate file is about to be added -
  +     * one of <code>keep</code>, <code>skip</code> or <code>overwrite</code>.
        * Possible values are: <code>keep</code> (keep both
        * of the files); <code>skip</code> (keep the first version
        * of the file found); <code>overwrite</code> overwrite the file
  @@ -229,7 +235,10 @@
           duplicate = df.getValue();
       }
   
  -    /** Possible behaviors when there are no matching files for the task. */
  +    /**
  +     * Possible behaviors when there are no matching files for the task:
  +     * "fail", "skip", or "create".
  +     */
       public static class WhenEmpty extends EnumeratedAttribute {
           public String[] getValues() {
               return new String[] {"fail", "skip", "create"};
  @@ -260,6 +269,9 @@
           this.encoding = encoding;
       }
   
  +    /**
  +     * validate and build
  +     */
       public void execute() throws BuildException {
           if (baseDir == null && filesets.size() == 0
               && groupfilesets.size() == 0 && "zip".equals(archiveType))
{
  @@ -534,10 +546,16 @@
           }
       }
   
  +    /**
  +     * method for subclasses to override
  +     */
       protected void initZipOutputStream(ZipOutputStream zOut)
           throws IOException, BuildException {
       }
   
  +    /**
  +     * method for subclasses to override
  +     */
       protected void finalizeZipOutputStream(ZipOutputStream zOut)
           throws IOException, BuildException {
       }
  @@ -893,7 +911,7 @@
        * Makes this instance reset all attributes to their default
        * values and forget all children.
        *
  -     * @since 1.72, Ant 1.5
  +     * @since Ant 1.5
        *
        * @see #cleanUp
        */
  @@ -911,7 +929,10 @@
           encoding = null;
       }
   
  -    /** Possible behaviors when a duplicate file is added. */
  +    /**
  +     * Possible behaviors when a duplicate file is added:
  +     * "add", "preserve" or "fail"
  +     */
       public static class Duplicate extends EnumeratedAttribute {
           public String[] getValues() {
               return new String[] {"add", "preserve", "fail"};
  
  
  

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