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/optional Rpm.java Script.java XMLValidateTask.java
Date Sun, 23 Jun 2002 22:46:18 GMT
stevel      2002/06/23 15:46:18

  Modified:    src/main/org/apache/tools/ant/taskdefs/optional Tag:
                        ANT_15_BRANCH Rpm.java Script.java
                        XMLValidateTask.java
  Log:
  more javadocs
  
  Revision  Changes    Path
  No                   revision
  
  
  No                   revision
  
  
  1.8.2.1   +31 -0     jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/Rpm.java
  
  Index: Rpm.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/Rpm.java,v
  retrieving revision 1.8
  retrieving revision 1.8.2.1
  diff -u -r1.8 -r1.8.2.1
  --- Rpm.java	25 Apr 2002 12:14:50 -0000	1.8
  +++ Rpm.java	23 Jun 2002 22:46:18 -0000	1.8.2.1
  @@ -195,14 +195,27 @@
           }
       }
   
  +    /**
  +     * The directory which will have the expected
  +     * subdirectories, SPECS, SOURCES, BUILD, SRPMS ; optional. 
  +     * If this isn't specified,
  +     * the <tt>baseDir</tt> value is used
  +     */
       public void setTopDir(File td) {
           this.topDir = td;
       }
   
  +    /**
  +     * What command to issue to the rpm tool; optional.
  +     * The default is "-bb"
  +     */
       public void setCommand(String c) {
           this.command = c;
       }
   
  +    /**
  +     * The name of the spec File to use; required.
  +     */
       public void setSpecFile(String sf) {
           if ((sf == null) || (sf.trim().equals(""))) {
               throw new BuildException("You must specify a spec file", location);
  @@ -210,22 +223,40 @@
           this.specFile = sf;
       }
   
  +    /**
  +     * Flag (optional, default=false) to remove 
  +     * the generated files in the BUILD directory
  +     */
       public void setCleanBuildDir(boolean cbd) {
           cleanBuildDir = cbd;
       }
   
  +    /**
  +     * Flag (optional, default=false) to remove the spec file from SPECS
  +     */
       public void setRemoveSpec(boolean rs) {
           removeSpec = rs;
       }
   
  +    /**
  +     * Flag (optional, default=false) 
  +     * to remove the sources after the build.
  +     * See the the <tt>--rmsource</tt>  option of rpmbuild.
  +     */
       public void setRemoveSource(boolean rs) {
           removeSource = rs;
       }
   
  +    /**
  +     * Optional file to save stdout to.
  +     */
       public void setOutput(File output) {
           this.output = output;
       }
   
  +    /**
  +     * Optional file to save stderr to
  +     */
       public void setError(File error) {
           this.error = error;
       }
  
  
  
  1.14.2.3  +2 -2      jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/Script.java
  
  Index: Script.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/Script.java,v
  retrieving revision 1.14.2.2
  retrieving revision 1.14.2.3
  diff -u -r1.14.2.2 -r1.14.2.3
  --- Script.java	29 May 2002 11:12:59 -0000	1.14.2.2
  +++ Script.java	23 Jun 2002 22:46:18 -0000	1.14.2.3
  @@ -154,7 +154,7 @@
       }
   
       /**
  -     * Load the script from an external file 
  +     * Load the script from an external file ; optional.
        *
        * @param msg Sets the value for the script variable.
        */
  @@ -179,7 +179,7 @@
       }
   
       /**
  -     * Defines the script.
  +     * The script text.
        *
        * @param msg Sets the value for the script variable.
        */
  
  
  
  1.19.2.1  +17 -11    jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java
  
  Index: XMLValidateTask.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java,v
  retrieving revision 1.19
  retrieving revision 1.19.2.1
  diff -u -r1.19 -r1.19.2.1
  --- XMLValidateTask.java	23 Apr 2002 11:42:51 -0000	1.19
  +++ XMLValidateTask.java	23 Jun 2002 22:46:18 -0000	1.19.2.1
  @@ -87,8 +87,10 @@
   import org.xml.sax.helpers.ParserAdapter;
   
   /**
  - * The <code>XMLValidateTask</code> checks that an XML document is valid,
  - * with a SAX validating parser.
  + * Checks XML files are valid (or only well formed). The
  + * task uses the SAX2 parser implementation provided by JAXP by default
  + * (probably the one that is used by Ant itself), but one can specify any
  + * SAX1/2 parser if needed
    * @author Raphael Pierquin <a href="mailto:raphael.pierquin@agisphere.com">raphael.pierquin@agisphere.com</a>
    */
   public class XMLValidateTask extends Task {
  @@ -122,7 +124,8 @@
       private XMLCatalog xmlCatalog = new XMLCatalog();
   
       /**
  -     * Specify how parser error are to be handled.
  +     * Specify how parser error are to be handled; 
  +     * optional, default=true
        * <p>
        * If set to <code>true</code> (default), throw a buildException if the
parser yields an error.
        */
  @@ -193,6 +196,7 @@
       }
   
       /**
  +     * Where to find the parser class; optional. 
        * @see #setClasspath
        */
       public void setClasspathRef(Reference r) {
  @@ -200,21 +204,21 @@
       }
   
       /**
  -     * specifify the file to be checked
  +     * specify the file to be checked; optional.
        */
       public void setFile(File file) {
           this.file = file;
       }
   
       /**
  -     *
  +     * add an XMLCatalog as a nested element; optional.
        */
       public void addConfiguredXMLCatalog(XMLCatalog catalog) {
           xmlCatalog.addConfiguredXMLCatalog(catalog);
       }
   
       /**
  -     * specifify a set of file to be checked
  +     * specify a set of file to be checked
        */
       public void addFileset(FileSet set) {
           filesets.addElement(set);
  @@ -226,7 +230,8 @@
       }
   
       /**
  -     * Create a DTD location record. This stores the location of a DTD. The DTD is identified
  +     * Create a DTD location record; optional.
  +     * This stores the location of a DTD. The DTD is identified
        * by its public Id.
        */
       public DTDLocation createDTD() {
  @@ -353,9 +358,9 @@
           }
       }
   
  -    /*
  +    /**
        * set a feature on the parser.
  -     * TODO: find a way to set any feature from build.xml
  +     * @todo find a way to set any feature from build.xml
        */
       private boolean setFeature(String feature, boolean value, boolean warn) {
   
  @@ -380,7 +385,8 @@
           }
           return toReturn;
       }
  -    /*
  +    
  +    /**
        * parse the file
        */
       private void doValidate(File afile) {
  @@ -415,7 +421,7 @@
           }
       }
   
  -    /*
  +    /**
        * ValidatorErrorHandler role :
        * <ul>
        * <li> log SAX parse exceptions,
  
  
  

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