First pass of JavaDoc work just to get rid of warnings.

When this is complete, whole source tree should JavaDoc (with 1.4)
with no warnings. (With JDK1.3.1 the 1.4-regexp stuff generates
warnings, but that's all.)


git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@271543 13f79535-47bb-0310-9956-ffa450edef68

src/main/org/apache/tools/ant/AntClassLoader.java

@@ -87,9 +87,8 @@ public class AntClassLoader extends ClassLoader implements BuildListener {
     /**
      * An enumeration of all resources of a given name found within the
      * classpath of this class loader. This enumeration is used by the
-     * {@link #findResources(String) findResources} method, which is in
-     * turn used by the
-     * {@link ClassLoader#getResources ClassLoader.getResources} method.
+     * ClassLoader.findResources method, which is in
+     * turn used by the ClassLoader.getResources method.
      *
      * @see AntClassLoader#findResources(String)
      * @see java.lang.ClassLoader#getResources(String)

src/main/org/apache/tools/ant/taskdefs/optional/EchoProperties.java

@@ -100,7 +100,6 @@ import java.io.FileOutputStream;
  *
  *@author     Matt Albrecht <a href="mailto:groboclown@users.sourceforge.net">
  *      groboclown@users.sourceforge.net</a>
- *@created    17-Jan-2002
  *@since      Ant 1.5
  */
 public class EchoProperties extends Task {

src/main/org/apache/tools/ant/taskdefs/optional/IContract.java

@@ -451,7 +451,7 @@ public class IContract extends MatchingTask {
     /**
      * Sets the classpath to be used for invocation of iContract.
      *
-     * @path the classpath
+     * @param path the classpath
      */
     public void setClasspath( Path path ) {
         createClasspath().append( path );

src/main/org/apache/tools/ant/taskdefs/optional/NetRexxC.java

@@ -427,7 +427,7 @@ public class NetRexxC extends MatchingTask {
     }
 
     /**
-     * Executes the task, i.e. does the actual compiler call
+     * Executes the task - performs the actual compiler call.
      */
     public void execute() throws BuildException {
 

src/main/org/apache/tools/ant/taskdefs/optional/PropertyFile.java

@@ -522,7 +522,7 @@ public class PropertyFile extends Task
         
         /**
          * Check if parameter combinations can be supported
-         * @todo make sure the 'unit' attribute is only specified on date
+         * To-do: make sure the 'unit' attribute is only specified on date
          *      fields
          */
         private void checkParameters() throws BuildException {

src/main/org/apache/tools/ant/taskdefs/optional/RenameExtensions.java

@@ -120,7 +120,7 @@ public class RenameExtensions extends MatchingTask {
     }
 
     /**
-     * Executes the task, i.e. does the actual compiler call
+     * Executes the task.
      */
     public void execute() throws BuildException {
 

src/main/org/apache/tools/ant/taskdefs/optional/ccm/Continuus.java

@@ -64,7 +64,7 @@ import org.apache.tools.ant.types.Commandline;
 
 
 /**
- * A base class for creating tasks for executing commands on Continuus 5.1
+ * A base class for creating tasks for executing commands on Continuus 5.1.
  * <p>
  * The class extends the  task as it operates by executing the ccm.exe program
  * supplied with Continuus/Synergy. By default the task expects the ccm executable to be

src/main/org/apache/tools/ant/taskdefs/optional/dotnet/CSharp.java

@@ -145,8 +145,9 @@ public class CSharp
         setIncludes(csc_file_pattern);
     }
 
-    /** name of the executable. the .exe suffix is deliberately not included
-     * in anticipation of the unix version
+    /** 
+     * Name of the executable. The .exe suffix is deliberately not 
+     * included in anticipation of the unix version
      */
     protected final static String csc_exe_name = "csc";
 

src/main/org/apache/tools/ant/taskdefs/optional/dotnet/Ilasm.java

@@ -120,7 +120,8 @@ public class Ilasm
         setIncludes(file_pattern);
     }
 
-    /** name of the executable. the .exe suffix is deliberately not included
+    /** 
+     * Name of the executable. The .exe suffix is deliberately not included
      * in anticipation of the unix version
      */
     protected final static String exe_name = "ilasm";
@@ -225,7 +226,7 @@ public class Ilasm
 
     /** test for a string containing something useful
      * @param string to test
-     * @returns true if the argument is not null or empty
+     * @return true if the argument is not null or empty
      */
     protected boolean notEmpty(String s) {
         return s != null && s.length() != 0;

src/main/org/apache/tools/ant/taskdefs/optional/dotnet/NetCommand.java

@@ -84,7 +84,6 @@ all the command line/exe construction stuff. However, it may be handy in future
 to have a means of setting the path to point to the dotnet bin directory; in which
 case the shared code should go in here.
  @author Steve Loughran steve_l@iseran.com
- @created 2000-11-01
  @version 0.3
  */
 

src/main/org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.java

@@ -419,7 +419,7 @@ public class GenericDeploymentTool implements EJBDeploymentTool {
      *                           descriptor to be processed
      * @param saxParser          SAXParser which may be used to parse the XML
      *                           descriptor
-     * @thows BuildException     Thrown if the configuration is invalid
+     * @exception BuildException     Thrown if the configuration is invalid
      */
     protected void checkConfiguration(String descriptorFileName,
                                     SAXParser saxParser) throws BuildException {

src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.java

@@ -84,7 +84,7 @@ import org.xml.sax.AttributeList;
  * Server (iAS).  The class will read a standard EJB descriptor (as well as an
  * EJB descriptor specific to iPlanet Application Server) to identify one or
  * more EJBs to process.  It will search for EJB "source" classes (the remote
- * interface, home interface, and EJB implementation class) and the EJB stubs
+; * interface, home interface, and EJB implementation class) and the EJB stubs
  * and skeletons in the specified destination directory.  Only if the stubs and
  * skeletons cannot be found or if they're out of date will the iPlanet
  * Application Server ejbc utility be run.
@@ -638,7 +638,7 @@ public class IPlanetEjbc {
      * have been processed, the list of EJBs found can be obtained by calling
      * the <code>getEjbs()</code> method.
      *
-     * @see    EjbInfo
+     * @see    IPlanetEjbc.EjbInfo
      * @author Greg Nelson
      *         <a href="mailto:greg@netscape.com">greg@netscape.com</a>
      */

src/main/org/apache/tools/ant/taskdefs/optional/ejb/JonasDeploymentTool.java

@@ -191,7 +191,7 @@ public class JonasDeploymentTool extends GenericDeploymentTool {
     }
 
     /**
-     * Modify the RMI Skel. and Stub. to implement
+     * Modify the RMI Skeleton and Stub to implement
      * the implicit propagation of the transactionnal
      * context and security context.
      * For JOnAS 2.4 and next.

src/main/org/apache/tools/ant/taskdefs/optional/i18n/Translate.java

@@ -119,7 +119,8 @@ public class Translate extends MatchingTask {
      */
     private String endToken;
     /**
-     * Create new destination file?  Defaults to false.
+     * Whether or not to create a new destination file.
+     * Defaults to <code>false</code>.
      */
     private boolean forceOverwrite;
     /**
@@ -227,9 +228,10 @@ public class Translate extends MatchingTask {
     }
 
     /**
-     * Overwrite existing file irrespective of whether it is newer than
-     * the source file as well as the resource bundle file?  Defaults to
-     * false.
+     * Whether or not to overwrite existing file irrespective of 
+     * whether it is newer than the source file as well as the 
+     * resource bundle file.
+     * Defaults to false.
      */
     public void setForceOverwrite(boolean forceOverwrite) {
         this.forceOverwrite = forceOverwrite;

src/main/org/apache/tools/ant/taskdefs/optional/jdepend/JDependTask.java

@@ -125,7 +125,7 @@ public class JDependTask extends Task {
     }
 
     /**
-     * Halt on Failure? default: false.
+     * Whether or not to halt on failure. Default: false.
      */
     public void setHaltonerror(boolean value) {
         _haltonerror = value;

src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java

@@ -215,7 +215,7 @@ public class JspC extends MatchingTask
     }
         
     /**
-     *  -uribase. the uri context of relative URI 
+     * The -uribase option. The uri context of relative URI 
      * references in the JSP pages. If it does not 
      * exist then it is derived from the location of the file
      * relative to the declared or derived value of -uriroot. 
@@ -231,7 +231,8 @@ public class JspC extends MatchingTask
     }
 
     /**
-     *  -uriroot <dir>The root directory that uri files should be resolved
+     *  The -uriroot option.
+     * <p>The root directory that uri files should be resolved
      *  against, (Default is the directory jspc is invoked from)
      *
      * @param  uriroot  The new Uribase value

src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.java

@@ -130,7 +130,7 @@ public abstract class MSVSS extends Task {
     }
 
     /**
-     * Set the path to the item in vss to operate on
+     * Set the path to the item in vss to operate on.
      * <p>
      * Ant can't cope with a '$' sign in an attribute so we have to add it here.
      * Also we strip off any 'vss://' prefix which is an XMS special and should probably be removed!

src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKIN.java

@@ -127,7 +127,7 @@ public class MSVSSCHECKIN extends MSVSS {
     }
 
     /**
-     * Builds and returns the -GL flag command if required
+     * Builds and returns the -GL flag command if required.
      * <p>
      * The localpath is created if it didn't exist
      */
@@ -217,7 +217,7 @@ public class MSVSSCHECKIN extends MSVSS {
     }
 
     /**
-     * Set the comment to apply in SourceSafe
+     * Set the comment to apply in SourceSafe.
      * <p>
      * If this is null or empty, it will be replaced with "-" which
      * is what SourceSafe uses for an empty comment.

src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKOUT.java

@@ -126,7 +126,7 @@ public class MSVSSCHECKOUT extends MSVSS {
     }
 
     /**
-     * Builds and returns the -GL flag command if required
+     * Builds and returns the -GL flag command if required.
      * <p>
      * The localpath is created if it didn't exist
      */
@@ -169,7 +169,7 @@ public class MSVSSCHECKOUT extends MSVSS {
     }
 
     /**
-     * Set the stored version string
+     * Set the stored version string.
      * <p>
      * Note we assume that if the supplied string has the value "null" that something
      * went wrong and that the string value got populated from a null object. This
@@ -185,7 +185,7 @@ public class MSVSSCHECKOUT extends MSVSS {
     }
 
     /**
-     * Set the stored date string
+     * Set the stored date string.
      * <p>
      * Note we assume that if the supplied string has the value "null" that something
      * went wrong and that the string value got populated from a null object. This
@@ -201,7 +201,7 @@ public class MSVSSCHECKOUT extends MSVSS {
     }
 
     /**
-     * Set the labeled version to operate on in SourceSafe
+     * Set the labeled version to operate on in SourceSafe.
      * <p>
      * Note we assume that if the supplied string has the value "null" that something
      * went wrong and that the string value got populated from a null object. This

src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSGET.java

@@ -194,7 +194,7 @@ public class MSVSSGET extends MSVSS {
     }
 
     /**
-     * Builds and returns the -GL flag command if required
+     * Builds and returns the -GL flag command if required.
      * <p>
      * The localpath is created if it didn't exist
      */
@@ -268,7 +268,7 @@ public class MSVSSGET extends MSVSS {
     }
 
     /**
-     * Set the stored version string
+     * Set the stored version string.
      * <p>
      * Note we assume that if the supplied string has the value "null" that something
      * went wrong and that the string value got populated from a null object. This
@@ -284,7 +284,7 @@ public class MSVSSGET extends MSVSS {
     }
 
     /**
-     * Set the stored date string
+     * Set the stored date string.
      * <p>
      * Note we assume that if the supplied string has the value "null" that something
      * went wrong and that the string value got populated from a null object. This
@@ -300,7 +300,7 @@ public class MSVSSGET extends MSVSS {
     }
 
     /**
-     * Set the labeled version to operate on in SourceSafe
+     * Set the labeled version to operate on in SourceSafe.
      * <p>
      * Note we assume that if the supplied string has the value "null" that something
      * went wrong and that the string value got populated from a null object. This
@@ -316,7 +316,7 @@ public class MSVSSGET extends MSVSS {
     }
 
     /**
-     * Simple order of priority. Returns the first specified of version, date, label
+     * Simple order of priority. Returns the first specified of version, date, label.
      * If none of these was specified returns ""
      */
     public void getVersionCommand(Commandline cmd) {

src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSHISTORY.java

@@ -198,7 +198,7 @@ public class MSVSSHISTORY extends MSVSS {
     }
 
     /**
-     * Set the number of days to go back for Comparison
+     * Set the number of days to go back for Comparison.
      * <p>
      * The default value is 2 days. 
      */
@@ -207,7 +207,7 @@ public class MSVSSHISTORY extends MSVSS {
     }
     
     /**
-     * Set the output file name for SourceSafe output
+     * Set the output file name for SourceSafe output.
      */
     public void setOutput(File outfile) {
         if ( outfile == null ) {
@@ -218,7 +218,7 @@ public class MSVSSHISTORY extends MSVSS {
     }
 
     /**
-     * Set the Start Date for the Comparison of two versions in SourceSafe History
+     * Set the Start Date for the Comparison of two versions in SourceSafe History.
      */
     public void setDateFormat(String dateFormat) {
         if ( !(dateFormat.equals("") || dateFormat == null) ) {
@@ -344,7 +344,7 @@ public class MSVSSHISTORY extends MSVSS {
     }
 
     /**
-     * Specify the detail of output
+     * Specify the detail of output.
      *
      * @param option valid values:
      * <ul>

src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSLABEL.java

@@ -175,7 +175,7 @@ public class MSVSSLABEL extends MSVSS
     }
 
     /**
-     * Set the label to apply in SourceSafe
+     * Set the label to apply in SourceSafe.
      * <p>
      * Note we assume that if the supplied string has the value "null" that something
      * went wrong and that the string value got populated from a null object. This
@@ -211,7 +211,7 @@ public class MSVSSLABEL extends MSVSS
     }
 
     /**
-     * Set the stored version string
+     * Set the stored version string.
      * <p>
      * Note we assume that if the supplied string has the value "null" that something
      * went wrong and that the string value got populated from a null object. This
@@ -235,7 +235,7 @@ public class MSVSSLABEL extends MSVSS
     }
 
     /**
-     * Set the comment to apply in SourceSafe
+     * Set the comment to apply in SourceSafe.
      * <p>
      * If this is null or empty, it will be replaced with "-" which
      * is what SourceSafe uses for an empty comment.