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 Ant.java CallTarget.java
Date Tue, 18 Jun 2002 17:51:47 GMT
ehatcher    2002/06/18 10:51:47

  Modified:    src/main/org/apache/tools/ant/taskdefs Tag: ANT_15_BRANCH
                        Ant.java CallTarget.java
  Log:
  First of the Javadoc cleanups to get attributes and elements to match our better HTML documentation.
  
  Revision  Changes    Path
  No                   revision
  
  
  No                   revision
  
  
  1.56.2.5  +23 -18    jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Ant.java
  
  Index: Ant.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Ant.java,v
  retrieving revision 1.56.2.4
  retrieving revision 1.56.2.5
  diff -u -r1.56.2.4 -r1.56.2.5
  --- Ant.java	11 Jun 2002 08:14:15 -0000	1.56.2.4
  +++ Ant.java	18 Jun 2002 17:51:46 -0000	1.56.2.5
  @@ -130,18 +130,16 @@
       private PrintStream out = null;
   
       /**
  -     * If true, inherit all properties from parent Project
  -     * If false, inherit only userProperties and those defined
  -     * inside the ant call itself
  +     * If true, pass all properties to the new Ant project.
  +     * Defaults to true.
        */
       public void setInheritAll(boolean value) {
           inheritAll = value;
       }
   
       /**
  -     * If true, inherit all references from parent Project
  -     * If false, inherit only those defined
  -     * inside the ant call itself
  +     * If true, pass all references to the new Ant project.
  +     * Defaults to false.
        */
       public void setInheritRefs(boolean value) {
           inheritRefs = value;
  @@ -489,16 +487,19 @@
       }
   
       /**
  -     * Set the dir attribute.
  +     * The directory to use as a basedir for the new Ant project.
  +     * Defaults to the current project's basedir, unless inheritall
  +     * has been set to false, in which case it doesn't have a default
  +     * value. This will override the basedir setting of the called project.
        */
       public void setDir(File d) {
           this.dir = d;
       }
   
       /**
  -     * set the build file, it can be either absolute or relative.
  -     * If it is absolute, <tt>dir</tt> will be ignored, if it is
  -     * relative it will be resolved relative to <tt>dir</tt>.
  +     * The build file to use.
  +     * Defaults to "build.xml". This file is expected to be a filename relative
  +     * to the dir attribute given.
        */
       public void setAntfile(String s) {
           // @note: it is a string and not a file to handle relative/absolute
  @@ -508,23 +509,27 @@
       }
   
       /**
  -     * set the target to execute. If none is defined it will
  -     * execute the default target of the build file
  +     * The target of the new Ant project to execute.
  +     * Defaults to the new project's default target.
        */
       public void setTarget(String s) {
           this.target = s;
       }
   
       /**
  -     * Set the name of a log file.  This will be resolved relative to
  -     * the dir attribute if specified, relative to the current
  -     * project's basedir otherwise.
  +     * Filename to write the output to.
  +     * This is relative to the value of the dir attribute
  +     * if it has been set or to the base directory of the
  +     * current project otherwise.
        */
       public void setOutput(String s) {
           this.output = s;
       }
   
  -    /** create a property to pass to the new project as a 'user property' */
  +    /**
  +     * Property to pass to the new project.
  +     * The property is passed as a 'user property'
  +     */
       public Property createProperty() {
           if (newProject == null) {
               reinit();
  @@ -537,8 +542,8 @@
       }
   
       /**
  -     * create a reference element that identifies a data type that
  -     * should be carried over to the new project.
  +     * Reference element identifying a data type to carry
  +     * over to the new project.
        */
       public void addReference(Reference r) {
           references.addElement(r);
  
  
  
  1.21.2.1  +10 -11    jakarta-ant/src/main/org/apache/tools/ant/taskdefs/CallTarget.java
  
  Index: CallTarget.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/CallTarget.java,v
  retrieving revision 1.21
  retrieving revision 1.21.2.1
  diff -u -r1.21 -r1.21.2.1
  --- CallTarget.java	15 Apr 2002 13:36:17 -0000	1.21
  +++ CallTarget.java	18 Jun 2002 17:51:46 -0000	1.21.2.1
  @@ -93,16 +93,16 @@
       private boolean inheritRefs = false;
   
       /**
  -     * If true, inherit all properties from parent Project
  -     * If false, inherit only userProperties and those defined
  -     * inside the antcall call itself
  -     **/
  +     * If true, pass all properties to the new Ant project.
  +     * Defaults to true.
  +     */
       public void setInheritAll(boolean inherit) {
          inheritAll = inherit;
       }
   
       /**
  -     * set the inherit refs flag
  +     * If true, pass all references to the new Ant project.
  +     * Defaults to false
        * @param inheritRefs new value
        */
       public void setInheritRefs(boolean inheritRefs) {
  @@ -145,7 +145,7 @@
       }
   
       /**
  -     * Create a nested param element.
  +     * Property to pass to the invoked target.
        */
       public Property createParam() {
           if (callee == null) {
  @@ -154,10 +154,9 @@
           return callee.createProperty();
       }
   
  -    /** 
  -     * create a reference element that identifies a data type that
  -     * should be carried over to the new project.
  -     *
  +    /**
  +     * Reference element identifying a data type to carry
  +     * over to the invoked target.
        * @since Ant 1.5
        */
       public void addReference(Ant.Reference r) {
  @@ -168,7 +167,7 @@
       }
   
       /**
  -     * Sets the target attribute, required.
  +     * Target to execute, required.
        */
       public void setTarget(String target) {
           subTarget = target;
  
  
  

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