ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jgl...@apache.org
Subject cvs commit: ant/src/main/org/apache/tools/ant/taskdefs Javadoc.java
Date Wed, 30 Mar 2005 16:59:26 GMT
jglick      2005/03/30 08:59:26

  Modified:    .        WHATSNEW
               docs/manual/CoreTasks javadoc.html
               src/main/org/apache/tools/ant/taskdefs Javadoc.java
  Log:
  Misc. cleanups relating to #30606.
  
  Revision  Changes    Path
  1.799     +4 -4      ant/WHATSNEW
  
  Index: WHATSNEW
  ===================================================================
  RCS file: /home/cvs/ant/WHATSNEW,v
  retrieving revision 1.798
  retrieving revision 1.799
  diff -u -r1.798 -r1.799
  --- WHATSNEW	29 Mar 2005 21:48:36 -0000	1.798
  +++ WHATSNEW	30 Mar 2005 16:59:26 -0000	1.799
  @@ -84,8 +84,6 @@
   
   * Log fine-grained events at verbose level from JUnit. Bugzilla report 31885.
   
  -* <javadoc> can now take an attribute 'executable'. Bugzilla report 30606.
  -
   * <WsdlToDotnet> and <style> are now deprecated in favor of <wsdltodotnet>
and
     <xslt>, respectively. Bugzilla report 25832.
   
  @@ -194,6 +192,8 @@
   Other changes:
   --------------
   
  +* <javadoc> can now take an attribute 'executable'. Bugzilla report 30606.
  +
   * New attribute ignorecontents for <different> selector
   
   * Javadoc fixes for Location, Project, and RuntimeConfigurable
  @@ -982,7 +982,7 @@
     argument using <javadoc> and JDK 1.4.  Bugzilla Report 16871.
   
   * <junit> didn't work with custom formatters that were only available
  -  on the user specified classpath when a timeout occured.  Bugzilla
  +  on the user specified classpath when a timeout occurred.  Bugzilla
     Report 19953.
   
   * <different> selector : make ignoreFileTimes effectively default to true
  @@ -1580,7 +1580,7 @@
     again (like Ant 1.5 did).
   
   * The "plain" <junit> <formatter> could throw a NullPointerException
  -  if an error occured in setUp.
  +  if an error occurred in setUp.
   
   * <junit> will now produce output when a test times out as well.
   
  
  
  
  1.34      +1 -1      ant/docs/manual/CoreTasks/javadoc.html
  
  Index: javadoc.html
  ===================================================================
  RCS file: /home/cvs/ant/docs/manual/CoreTasks/javadoc.html,v
  retrieving revision 1.33
  retrieving revision 1.34
  diff -u -r1.33 -r1.34
  --- javadoc.html	29 Mar 2005 18:23:47 -0000	1.33
  +++ javadoc.html	30 Mar 2005 16:59:26 -0000	1.34
  @@ -698,7 +698,7 @@
       <td valign="top">executable</td>
       <td valign="top">Specify a particular <code>javadoc</code> executable
         to use in place of the default binary (found in the same JDK as Ant is running in).
  -      <em>since Ant 1.7</em>.</td>
  +      <em>since Ant 1.6.3</em>.</td>
       <td align="center" valign="top">all</td>
       <td align="center" valign="top">No</td>
     </tr>
  
  
  
  1.141     +25 -25    ant/src/main/org/apache/tools/ant/taskdefs/Javadoc.java
  
  Index: Javadoc.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/Javadoc.java,v
  retrieving revision 1.140
  retrieving revision 1.141
  diff -u -r1.140 -r1.141
  --- Javadoc.java	29 Mar 2005 18:23:47 -0000	1.140
  +++ Javadoc.java	30 Mar 2005 16:59:26 -0000	1.141
  @@ -54,7 +54,7 @@
    *    <li>patterns must be of the form "xxx.*", every other pattern doesn't
    *        work.
    *    <li>there is no control on arguments sanity since they are left
  - *        to the javadoc implementation.
  + *        to the Javadoc implementation.
    * </ul>
    *
    * <p>If no <code>doclet</code> is set, then the <code>version</code>
and
  @@ -301,9 +301,9 @@
       }
   
       /**
  -     * An HTML element in the javadoc.
  +     * An HTML element in the Javadoc.
        *
  -     * This class is used for those javadoc elements which contain HTML such as
  +     * This class is used for those Javadoc elements which contain HTML such as
        * footers, headers, etc.
        */
       public static class Html {
  @@ -330,7 +330,7 @@
       }
   
       /**
  -     * EnumeratedAttribute implementation supporting the javadoc scoping
  +     * EnumeratedAttribute implementation supporting the Javadoc scoping
        * values.
        */
       public static class AccessType extends EnumeratedAttribute {
  @@ -363,7 +363,7 @@
       }
   
       /**
  -     * Utility method to add a javadoc argument.
  +     * Utility method to add a Javadoc argument.
        *
        * @param key the argument name.
        * @param value the argument value.
  @@ -380,7 +380,7 @@
   
       /**
        * Flag which indicates if the task should fail if there is a
  -     * javadoc error.
  +     * Javadoc error.
        */
       private boolean failOnError = false;
       private Path sourcePath = null;
  @@ -581,7 +581,7 @@
       }
   
       /**
  -     * Add a package to be excluded from the javadoc run.
  +     * Add a package to be excluded from the Javadoc run.
        *
        * @param pn the name of the package (wildcards are not permitted).
        */
  @@ -724,7 +724,7 @@
       }
   
       /**
  -     * Set the classpath to be used for this javadoc run.
  +     * Set the classpath to be used for this Javadoc run.
        *
        * @param path an Ant Path object containing the compilation
        *        classpath.
  @@ -828,7 +828,7 @@
        * @param locale the locale to use.
        */
       public void setLocale(String locale) {
  -        // createArgument(true) is necessary to make sure, -locale
  +        // createArgument(true) is necessary to make sure -locale
           // is the first argument (required in 1.3+).
           cmd.createArgument(true).setValue(locale);
           cmd.createArgument(true).setValue("-locale");
  @@ -1007,7 +1007,7 @@
       }
   
       /**
  -     * Create links to javadoc output at the given URL.
  +     * Create links to Javadoc output at the given URL.
        * @param src the URL to link to
        */
       public void setLink(String src) {
  @@ -1117,7 +1117,7 @@
       }
   
       /**
  -     * Create link to javadoc output at the given URL.
  +     * Create link to Javadoc output at the given URL.
        *
        * @return link argument to configure
        */
  @@ -1211,7 +1211,7 @@
   
       /**
        * Creates and adds a -tag argument. This is used to specify
  -     * custom tags. This argument is only available for JavaDoc 1.4,
  +     * custom tags. This argument is only available for Javadoc 1.4,
        * and will generate a verbose message (and then be ignored)
        * when run on Java versions below 1.4.
        * @return tag argument to be configured
  @@ -1417,7 +1417,7 @@
           }
   
           /**
  -         * Set the packages to javadoc on.
  +         * Set the packages to Javadoc on.
            * @param src a comma separated list of packages
            */
           public void setPackages(String src) {
  @@ -1462,7 +1462,7 @@
       }
   
       /**
  -     * Should the build process fail if javadoc fails (as indicated by
  +     * Should the build process fail if Javadoc fails (as indicated by
        * a non zero return code)?
        *
        * <p>Default is false.</p>
  @@ -1473,7 +1473,7 @@
       }
   
       /**
  -     * Enables the -source switch, will be ignored if javadoc is not
  +     * Enables the -source switch, will be ignored if Javadoc is not
        * the 1.4 version.
        * @param source a <code>String</code> value
        * @since Ant 1.5
  @@ -1485,7 +1485,7 @@
       /**
        * Sets the actual executable command to invoke, instead of the binary
        * <code>javadoc</code> found in Ant's JDK.
  -     * @since Ant 1.7
  +     * @since Ant 1.6.3
        */
       public void setExecutable(String executable) {
           this.executable = executable;
  @@ -1518,7 +1518,7 @@
       }
   
       /**
  -     * Enables the -linksource switch, will be ignored if javadoc is not
  +     * Enables the -linksource switch, will be ignored if Javadoc is not
        * the 1.4 version. Default is false
        * @param b a <code>String</code> value
        * @since Ant 1.6
  @@ -1528,7 +1528,7 @@
       }
   
       /**
  -     * Enables the -linksource switch, will be ignored if javadoc is not
  +     * Enables the -linksource switch, will be ignored if Javadoc is not
        * the 1.4 version. Default is false
        * @param b a <code>String</code> value
        * @since Ant 1.6
  @@ -1538,7 +1538,7 @@
       }
   
       /**
  -     * Enables the -noqualifier switch, will be ignored if javadoc is not
  +     * Enables the -noqualifier switch, will be ignored if Javadoc is not
        * the 1.4 version.
        * @param noqualifier the parameter to the -noqualifier switch
        * @since Ant 1.6
  @@ -1609,7 +1609,7 @@
               toExecute.setExecutable(JavaEnvUtils.getJdkExecutable("javadoc"));
           }
   
  -        // ------------------------------------------ general javadoc arguments
  +        // ------------------------------------------ general Javadoc arguments
           if (doctitle != null) {
               toExecute.createArgument().setValue("-doctitle");
               toExecute.createArgument().setValue(expand(doctitle.getText()));
  @@ -1819,7 +1819,7 @@
               }
           }
   
  -        // JavaDoc 1.4 parameters
  +        // Javadoc 1.4 parameters
           if (javadoc4 || executable != null) {
               for (Enumeration e = tags.elements(); e.hasMoreElements();) {
                   Object element = e.nextElement();
  @@ -1900,19 +1900,19 @@
                        Project.MSG_VERBOSE);
               }
               if (source != null) {
  -                log("-source option not supported on JavaDoc < 1.4",
  +                log("-source option not supported on Javadoc < 1.4",
                        Project.MSG_VERBOSE);
               }
               if (linksource) {
  -                log("-linksource option not supported on JavaDoc < 1.4",
  +                log("-linksource option not supported on Javadoc < 1.4",
                        Project.MSG_VERBOSE);
               }
               if (breakiterator) {
  -                log("-breakiterator option not supported on JavaDoc < 1.4",
  +                log("-breakiterator option not supported on Javadoc < 1.4",
                        Project.MSG_VERBOSE);
               }
               if (noqualifier != null) {
  -                log("-noqualifier option not supported on JavaDoc < 1.4",
  +                log("-noqualifier option not supported on Javadoc < 1.4",
                        Project.MSG_VERBOSE);
               }
           }
  
  
  

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


Mime
View raw message