Erik's big javadoc fixup, bugzilla ID #4992

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

src/main/org/apache/tools/ant/listener/Log4jListener.java

@@ -67,7 +67,7 @@ import org.apache.log4j.helpers.NullEnumeration;
 /**
  *  Listener which sends events to Log4j logging system
  *
- * @author <a href="mailto:conor@apache.org>Conor MacNeill </a>
+ * @author <a href="mailto:conor@apache.org">Conor MacNeill</a>
  */
 public class Log4jListener implements BuildListener {
     final static String LOG4J_CONFIG_PROPERTY = "log4j.configuration";

src/main/org/apache/tools/ant/taskdefs/Ant.java

@@ -73,16 +73,16 @@ import java.util.Enumeration;
  * Call Ant in a sub-project
  *
  *  <pre>
- *    <target name="foo" depends="init">
- *    <ant antfile="build.xml" target="bar" >
- *      <property name="property1" value="aaaaa" />
- *      <property name="foo" value="baz" />
- *     </ant>
- *  </target>
+ *  &lt;target name=&quot;foo&quot; depends=&quot;init&quot;&gt;
+ *    &lt;ant antfile=&quot;build.xml&quot; target=&quot;bar&quot; &gt;
+ *      &lt;property name=&quot;property1&quot; value=&quot;aaaaa&quot; /&gt;
+ *      &lt;property name=&quot;foo&quot; value=&quot;baz&quot; /&gt;
+ *    &lt;/ant&gt;</SPAN>
+ *  &lt;/target&gt;</SPAN>
  *
- * <target name="bar" depends="init">
- *    <echo message="prop is ${property1} ${foo}" />
- * </target>
+ *  &lt;target name=&quot;bar&quot; depends=&quot;init&quot;&gt;
+ *    &lt;echo message=&quot;prop is ${property1} ${foo}&quot; /&gt;
+ *  &lt;/target&gt;
  * </pre>
  *
  *

src/main/org/apache/tools/ant/taskdefs/CallTarget.java

@@ -61,16 +61,16 @@ import org.apache.tools.ant.BuildException;
  * Call another target in the same project.
  *
  *  <pre>
- *    <target name="foo">
- *      <antcall target="bar">
- *        <param name="property1" value="aaaaa" />
- *        <param name="foo" value="baz" />
- *       </antcall>
- *    </target>
+ *    &lt;target name="foo"&gt;
+ *      &lt;antcall target="bar"&gt;
+ *        &lt;param name="property1" value="aaaaa" /&gt;
+ *        &lt;param name="foo" value="baz" /&gt;
+ *       &lt;/antcall&gt;
+ *    &lt;/target&gt;
  *
- *    <target name="bar" depends="init">
- *      <echo message="prop is ${property1} ${foo}" />
- *    </target>
+ *    &lt;target name="bar" depends="init"&gt;
+ *      &lt;echo message="prop is ${property1} ${foo}" /&gt;
+ *    &lt;/target&gt;
  * </pre>
  *
  * <p>This only works as expected if neither property1 nor foo are

src/main/org/apache/tools/ant/taskdefs/DependSet.java

@@ -95,7 +95,7 @@ import org.apache.tools.ant.types.FileList;
  * source vs target combination unnecessarily.
  * </p><p>
  * Example uses: 
- * <ulist><li>
+ * <ul><li>
  * Record the fact that an XML file must be up to date
  * with respect to its XSD (Schema file), even though the XML file
  * itself includes no reference to its XSD.
@@ -105,7 +105,7 @@ import org.apache.tools.ant.types.FileList;
  * </li><li>
  * Record the fact that java files must be recompiled if the ant build
  * file changes
- * </li></ulist>
+ * </li></ul>
  * 
  * @author <a href="mailto:cstrong@arielpartners.com">Craeg Strong</a>
  * @version $Revision$ $Date$

src/main/org/apache/tools/ant/taskdefs/Exit.java

@@ -62,7 +62,7 @@ import org.apache.tools.ant.ProjectHelper;
  * Just exit the active build, giving an additional message 
  * if available.
  *
- * @author Nico Seessle <nico@seessle.de>
+ * @author <a href="mailto:nico@seessle.de">Nico Seessle</a>
  */
 public class Exit extends Task { 
     private String message;

src/main/org/apache/tools/ant/taskdefs/Javac.java

@@ -168,10 +168,10 @@ public class Javac extends MatchingTask {
     }
 
     /**
-     * Create a nested <src ...> element for multiple source path
+     * Create a nested src element for multiple source path
      * support.
      *
-     * @return a nexted src element.
+     * @return a nested src element.
      */
     public Path createSrc() {
         if (src == null) {

src/main/org/apache/tools/ant/taskdefs/Property.java

@@ -74,8 +74,8 @@ import java.util.Enumeration;
  * Will not override values set by the command line or parent projects.
  *
  * @author costin@dnt.ro
- * @author Sam Ruby <rubys@us.ibm.com>
- * @author Glenn McAllister <glennm@ca.ibm.com>
+ * @author <a href="mailto:rubys@us.ibm.com">Sam Ruby</a>
+ * @author <a href="mailto:glennm@ca.ibm.com">Glenn McAllister</a>
  */
 public class Property extends Task {
 

src/main/org/apache/tools/ant/taskdefs/Recorder.java

@@ -70,7 +70,7 @@ import java.util.Hashtable;
 
 /**
  * This task is the manager for RecorderEntry's.  It is this class
- * that holds all entries, modifies them every time the <recorder>
+ * that holds all entries, modifies them every time the &lt;recorder&gt;
  * task is called, and addes them to the build listener process.
  * @see RecorderEntry
  * @author <a href="mailto:jayglanville@home.com">J D Glanville</a>

src/main/org/apache/tools/ant/taskdefs/Replace.java

@@ -463,7 +463,7 @@ public class Replace extends MatchingTask {
     }
     
     /**
-     * Nested <replacetoken> element.
+     * Nested &lt;replacetoken&gt; element.
      */
     public NestedString createReplaceToken() {
         if (token == null) {
@@ -473,7 +473,7 @@ public class Replace extends MatchingTask {
     }
 
     /**
-     * Nested <replacevalue> element.
+     * Nested &lt;replacevalue&gt; element.
      */
     public NestedString createReplaceValue() {
         return value;
@@ -487,7 +487,7 @@ public class Replace extends MatchingTask {
     }
 
     /**
-     * Add nested <replacefilter> element.
+     * Add nested &lt;replacefilter&gt; element.
      */
     public Replacefilter createReplacefilter() {
         Replacefilter filter = new Replacefilter();

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

@@ -69,7 +69,7 @@ import java.io.File;
 /**
  * Convert files from native encodings to ascii.
  *
- * @author Drew Sudell <asudell@acm.org>
+ * @author <a href="asudell@acm.org">Drew Sudell</a>
  * @author <a href="mailto:stefan.bodewig@epost.de">Stefan Bodewig</a>
  */
 public class Native2Ascii extends MatchingTask {

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

@@ -149,7 +149,7 @@ import java.text.DecimalFormat;
  *a newline delimiter charater.
  *
  * @author Thomas Christen <a href="mailto:chr@active.ch">chr@active.ch</a>
- * @author Jeremy Mawson <a href="mailto:jem@loftinspace.com.au>jem@loftinspace.com.au</a>
+ * @author Jeremy Mawson <a href="mailto:jem@loftinspace.com.au">jem@loftinspace.com.au</a>
 */
 public class PropertyFile extends Task
 {

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

@@ -295,7 +295,7 @@ public class CCMCreateTask extends Continuus implements ExecuteStreamHandler  {
     
     /**
      *
-     * @exception java.io.IOException <description>
+     * @exception java.io.IOException
      */
     public void start() throws IOException  {                                
     }
@@ -308,16 +308,16 @@ public class CCMCreateTask extends Continuus implements ExecuteStreamHandler  {
 
     /**
      *
-     * @param param1 <description>
-     * @exception java.io.IOException <description>
+     * @param param1
+     * @exception java.io.IOException
      */
     public void setProcessInputStream(OutputStream param1) throws IOException    {    
     }
 
     /**
      *
-     * @param param1 <description>
-     * @exception java.io.IOException <description>
+     * @param param1
+     * @exception java.io.IOException
      */
     public void setProcessErrorStream(InputStream is) throws IOException    {
         BufferedReader reader = new BufferedReader(new InputStreamReader(is));

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

@@ -431,8 +431,8 @@ public class BorlandDeploymentTool extends GenericDeploymentTool  implements Exe
 
     /**
      *
-     * @param param1 <description>
-     * @exception java.io.IOException <description>
+     * @param is
+     * @exception java.io.IOException
      */
     public void setProcessOutputStream(InputStream is) throws IOException
     {
@@ -458,8 +458,8 @@ public class BorlandDeploymentTool extends GenericDeploymentTool  implements Exe
     }
 
     /**
-     * @param param1 <description>
-     * @exception java.io.IOException <description>
+     * @param param1
+     * @exception java.io.IOException
      */
     public void setProcessErrorStream(InputStream is) throws IOException
     {

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

@@ -132,7 +132,7 @@ public class DescriptorHandler extends org.xml.sax.HandlerBase {
     protected Hashtable ejbFiles = null;
 
     /**
-     * Instance variable that stores the value found in the <ejb-name> element
+     * Instance variable that stores the value found in the &lt;ejb-name&gt; element
      */
     protected String ejbName = null;
 
@@ -243,7 +243,7 @@ public class DescriptorHandler extends org.xml.sax.HandlerBase {
     }
 
      /**
-     * Getter method that returns the value of the <ejb-name> element.
+     * Getter method that returns the value of the &lt;ejb-name&gt; element.
      */
     public String getEjbName() {
         return ejbName;

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

@@ -100,15 +100,15 @@ import java.util.StringTokenizer;
  * 
  * <pre>
  * example
- * <target name="jspcompile" depends="compile">
- *   <wljspc src="c:\\weblogic\\myserver\\public_html" dest="c:\\weblogic\\myserver\\serverclasses" package="myapp.jsp" >
- *   <classpath>
- *          <pathelement location="${weblogic.classpath}" />
- *           <pathelement path="${compile.dest}" />
- *      </classpath>
+ * &lt;target name="jspcompile" depends="compile"&gt;
+ *   &lt;wljspc src="c:\\weblogic\\myserver\\public_html" dest="c:\\weblogic\\myserver\\serverclasses" package="myapp.jsp"&gt;
+ *   &lt;classpath&gt;
+ *          &lt;pathelement location="${weblogic.classpath}" /&gt;
+ *           &lt;pathelement path="${compile.dest}" /&gt;
+ *      &lt;/classpath&gt;
  * 
- *   </wljspc>
- * </target>
+ *   &lt;/wljspc&gt;
+ * &lt;/target&gt;
  * </pre>
  * 
  */

src/main/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.java

@@ -69,7 +69,7 @@ import java.util.Vector;
 /**
  * Class to provide automated telnet protocol support for the Ant build tool
  *
- * @author Scott Carlson<a href="mailto:ScottCarlson@email.com">ScottCarlson@email.com</a>
+ * @author <a href="mailto:ScottCarlson@email.com">ScottCarlson@email.com</a>
  * @version $Revision$
  */
 
@@ -206,7 +206,7 @@ public class TelnetTask extends Task {
     }
 
     /**
-     *  A subTask <read> tag was found.  Create the object, 
+     *  A subTask &lt;read&gt; tag was found.  Create the object, 
      *  Save it in our list, and return it.
      */
    
@@ -218,7 +218,7 @@ public class TelnetTask extends Task {
     }
 
     /**
-     *  A subTask <write> tag was found.  Create the object, 
+     *  A subTask &lt;write&gt; tag was found.  Create the object, 
      *  Save it in our list, and return it.
      */
     public TelnetSubTask createWrite()

src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Label.java

@@ -72,7 +72,10 @@ import java.text.SimpleDateFormat;
  *
  *  Label name defaults to AntLabel if none set.
  *
- * Example Usage: <P4Label name="MyLabel-${TSTAMP}-${DSTAMP}" desc="Auto Build Label" />
+ * Example Usage: 
+ * <pre>
+ *   &lt;P4Label name="MyLabel-${TSTAMP}-${DSTAMP}" desc="Auto Build Label" /&gt;
+ * </pre>
  *
  * @author <A HREF="mailto:leslie.hughes@rubus.com">Les Hughes</A>
  */

src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java

@@ -93,9 +93,9 @@ import org.apache.tools.ant.types.Commandline;
  * update those files that have a modification time (in PVCS) that is newer 
  * than the existing workfile.
  *
- * @author Thomas Christensen <tchristensen@nordija.com>
- * @author Don Jeffery <donj@apogeenet.com>
- * @author Steven E. Newton <snewton@standard.com>
+ * @author <a href="mailto:tchristensen@nordija.com">Thomas Christensen</a>
+ * @author <a href="mailto:donj@apogeenet.com">Don Jeffery</a>
+ * @author <a href="snewton@standard.com">Steven E. Newton</a>
  */
 public class Pvcs extends org.apache.tools.ant.Task {
     private String pvcsbin;

src/main/org/apache/tools/ant/taskdefs/optional/sitraka/Socket.java

@@ -78,7 +78,7 @@ public class Socket {
         port = value.intValue();
     }
 
-    /** if no host is set, returning ':<port>', will take localhost */
+    /** if no host is set, returning ':&lt;port&gt;', will take localhost */
     public String toString() {
         return host + ":" + port;
     }

src/main/org/apache/tools/ant/taskdefs/optional/sitraka/XMLReport.java

@@ -258,7 +258,7 @@ public class XMLReport {
     }
 
     /**
-     * Convert to a CovReport-like signature ie, <classname>.<method>()
+     * Convert to a CovReport-like signature ie, &lt;classname&gt;.&lt;method&gt;()
      */
     protected String getMethodSignature(ClassFile clazz, MethodInfo method) {
         StringBuffer buf = new StringBuffer(clazz.getFullName());

src/main/org/apache/tools/ant/taskdefs/rmic/KaffeRmic.java

@@ -66,7 +66,7 @@ import java.lang.reflect.Method;
 /**
  * The implementation of the rmic for Kaffe
  *
- * @author Takashi Okamoto <tokamoto@rd.nttdata.co.jp>
+ * @author <a href="mailto:tokamoto@rd.nttdata.co.jp">Takashi Okamoto</a>
  */
 public class KaffeRmic extends DefaultRmicAdapter {
 

src/main/org/apache/tools/ant/taskdefs/rmic/RmicAdapter.java

@@ -69,7 +69,7 @@ import org.apache.tools.ant.util.FileNameMapper;
  * task, the execute command and a parameterless constructor (for
  * reflection).</p>
  *
- * @author Takashi Okamoto <tokamoto@rd.nttdata.co.jp>
+ * @author <a href="mailto:tokamoto@rd.nttdata.co.jp">Takashi Okamoto</a>
  * @author <a href="mailto:stefan.bodewig@epost.de">Stefan Bodewig</a> 
  */
 

src/main/org/apache/tools/ant/taskdefs/rmic/RmicAdapterFactory.java

@@ -61,7 +61,7 @@ import org.apache.tools.ant.Task;
 /**
  * Creates the necessary rmic adapter, given basic criteria.
  *
- * @author Takashi Okamoto <tokamoto@rd.nttdata.co.jp>
+ * @author <a href="mailto:tokamoto@rd.nttdata.co.jp">Takashi Okamoto</a>
  * @author <a href="mailto:jayglanville@home.com">J D Glanville</a>
  */
 public class RmicAdapterFactory {

src/main/org/apache/tools/ant/taskdefs/rmic/SunRmic.java

@@ -67,7 +67,7 @@ import java.lang.reflect.Method;
 /**
  * The implementation of the rmic for SUN's JDK.
  *
- * @author Takashi Okamoto <tokamoto@rd.nttdata.co.jp>
+ * @author <a href="mailto:tokamoto@rd.nttdata.co.jp">Takashi Okamoto</a>
  */
 public class SunRmic extends DefaultRmicAdapter {
 

src/main/org/apache/tools/ant/taskdefs/rmic/WLRmic.java

@@ -67,7 +67,7 @@ import java.lang.reflect.Method;
 /**
  * The implementation of the rmic for WebLogic
  *
- * @author Takashi Okamoto <tokamoto@rd.nttdata.co.jp>
+ * @author <a href="mailto:tokamoto@rd.nttdata.co.jp">Takashi Okamoto</a>
  */
 public class WLRmic extends DefaultRmicAdapter {
 

src/main/org/apache/tools/ant/types/Description.java

@@ -59,7 +59,7 @@ package org.apache.tools.ant.types;
 /**
  * Description is used to provide a project-wide description element
  * (that is, a description that applies to a buildfile as a whole).
- * If present, the <description> element is printed out before the
+ * If present, the &lt;description&gt; element is printed out before the
  * target descriptions.
  * 
  * Description has no attributes, only text.  There can only be one