ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From peterrei...@apache.org
Subject cvs commit: ant/src/main/org/apache/tools/ant/types CommandlineJava.java
Date Thu, 13 Jan 2005 10:10:11 GMT
peterreilly    2005/01/13 02:10:10

  Modified:    src/main/org/apache/tools/ant/types CommandlineJava.java
  Log:
  javadoc
  
  Revision  Changes    Path
  1.63      +25 -10    ant/src/main/org/apache/tools/ant/types/CommandlineJava.java
  
  Index: CommandlineJava.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/types/CommandlineJava.java,v
  retrieving revision 1.62
  retrieving revision 1.63
  diff -u -r1.62 -r1.63
  --- CommandlineJava.java	13 Jan 2005 09:05:35 -0000	1.62
  +++ CommandlineJava.java	13 Jan 2005 10:10:05 -0000	1.63
  @@ -81,7 +81,7 @@
            * get the properties as an array; this is an override of the
            * superclass, as it evaluates all the properties
            * @return the array of definitions; may be null
  -         * @throws BuildException
  +         * @throws BuildException on error
            */
           public String[] getVariables() throws BuildException {
   
  @@ -170,6 +170,7 @@
           /**
            *  deep clone
            * @return a cloned instance of SysProperties
  +         * @exception CloneNotSupportedException for signature
            */
           public Object clone() throws CloneNotSupportedException {
               try {
  @@ -246,16 +247,16 @@
       }
   
       /**
  -     * set the executable used to start the new JVM
  -     * @param vm
  +     * Set the executable used to start the new JVM.
  +     * @param vm the executable to use
        */
       public void setVm(String vm) {
           vmCommand.setExecutable(vm);
       }
   
       /**
  -     * set the JVM version required
  -     * @param value
  +     * Set the JVM version required.
  +     * @param value the version required
        */
       public void setVmversion(String value) {
           vmVersion = value;
  @@ -265,6 +266,7 @@
        * If set, system properties will be copied to the cloned VM - as
        * well as the bootclasspath unless you have explicitly specified
        * a bootclaspath.
  +     * @param cloneVm if true copy the system properties
        * @since Ant 1.7
        */
       public void setCloneVm(boolean cloneVm) {
  @@ -328,6 +330,11 @@
           return null;
       }
   
  +    /**
  +     * Create a classpath.
  +     * @param p the project to use to create the path in
  +     * @return a path to be configured
  +     */
       public Path createClasspath(Project p) {
           if (classpath == null) {
               classpath = new Path(p);
  @@ -336,6 +343,9 @@
       }
   
       /**
  +     * Create a boot classpath.
  +     * @param p the project to use to create the path in
  +     * @return a path to be configured
        * @since Ant 1.6
        */
       public Path createBootclasspath(Project p) {
  @@ -345,6 +355,10 @@
           return bootclasspath;
       }
   
  +    /**
  +     * Get the vm version.
  +     * @return the vm version
  +     */
       public String getVmversion() {
           return vmVersion;
       }
  @@ -390,7 +404,7 @@
           if (bcp.size() > 0) {
               listIterator.add("-Xbootclasspath:" + bcp.toString());
           }
  -        
  +
           //main classpath
           if (haveClasspath()) {
               listIterator.add("-classpath");
  @@ -418,6 +432,7 @@
       /**
        * Specify max memory of the JVM
        * -mx or -Xmx depending on VM version
  +     * @param max the string to pass to the jvm to specifiy the max memory
        */
       public void setMaxmemory(String max) {
           this.maxMemory = max;
  @@ -436,7 +451,7 @@
        * Returns a String that describes the command and arguments
        * suitable for verbose output before a call to
        * <code>Runtime.exec(String[])<code>
  -     *
  +     * @return the description string
        * @since Ant 1.5
        */
       public String describeCommand() {
  @@ -448,7 +463,7 @@
        * for in VM executions.
        *
        * <p>The class name is the executable in this context.</p>
  -     *
  +     * @return the description string
        * @since Ant 1.5
        */
       public String describeJavaCommand() {
  @@ -599,7 +614,7 @@
       /**
        * Has the classpath been specified and shall it really be used or
        * will build.sysclasspath null it?
  -     *
  +     * @return true if the classpath is to be used
        * @since Ant 1.6
        */
       protected boolean haveClasspath() {
  @@ -616,7 +631,7 @@
        *
        * @param log whether to log a warning if a bootclasspath has been
        * specified but will be ignored.
  -     *
  +     * @return true if the bootclasspath is to be used
        * @since Ant 1.6
        */
       protected boolean haveBootclasspath(boolean log) {
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org


Mime
View raw message