Document new methods in XMLLogger

Cleanup Javadoc errors.


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

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

@@ -427,10 +427,23 @@ public class XmlLogger implements BuildLogger {
 
     // -------------------------------------------------- BuildLogger interface
 
+    /**
+     * Set the logging level when using this as a Logger
+     *
+     * @param level the logging level - 
+     *        see {@link org.apache.tools.ant.Project#MSG_ERR Project} 
+     *        class for level definitions
+     */
     public void setMessageOutputLevel(int level) {
         msgOutputLevel = level;
     }
 
+    /**
+     * Set the output stream to which logging output is sent when operating 
+     * as a logger.
+     *
+     * @param output the output PrintStream.
+     */
     public void setOutputPrintStream(PrintStream output) {
         this.outStream = new PrintStream(output, true);
     }

src/main/org/apache/tools/ant/filters/StringInputStream.java

@@ -106,8 +106,11 @@ public class StringInputStream
         in.reset();
     }
 
+    /**
+     * @see InputStream#markSupported
+     */
     public boolean markSupported() {
-        return true;
+        return in.markSupported();
     }
 }
 

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

@@ -92,7 +92,7 @@ public class Chmod extends ExecuteOn {
     }
 
     /**
-     * @see ProjectComponent#setProject
+     * @see org.apache.tools.ant.ProjectComponent#setProject
      */
     public void setProject(Project project) {
         super.setProject(project);

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

@@ -83,7 +83,7 @@ public abstract class MatchingTask extends Task {
     protected FileSet fileset = new FileSet();
 
     /**
-     * @see ProjectComponent#setProject
+     * @see org.apache.tools.ant.ProjectComponent#setProject
      */
     public void setProject(Project project) {
         super.setProject(project);

src/main/org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.java

@@ -138,7 +138,7 @@ public abstract class AbstractHotDeploymentTool implements HotDeploymentTool {
     }
 
     /**
-     *  Perform the actual deployment.<br>
+     *  Perform the actual deployment.
      *  It's up to the subclasses to implement the actual behavior.
      *  @exception org.apache.tools.ant.BuildException if the attributes are invalid or incomplete.
      */

src/main/org/apache/tools/ant/taskdefs/optional/j2ee/GenericHotDeploymentTool.java

@@ -121,7 +121,7 @@ public class GenericHotDeploymentTool extends AbstractHotDeploymentTool {
     }
 
     /**
-     *  Perform the actual deployment.<br>
+     *  Perform the actual deployment.
      *  For this generic implementation, a JVM is spawned using the
      *  supplied classpath, classname, JVM args, and command line arguments.
      *  @exception org.apache.tools.ant.BuildException if the attributes are invalid or incomplete.

src/main/org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.java

@@ -86,7 +86,7 @@ public interface HotDeploymentTool {
     public void validateAttributes() throws BuildException;
 
     /**
-     *  Perform the actual deployment.<br>
+     *  Perform the actual deployment.
      *  @exception org.apache.tools.ant.BuildException if the attributes are invalid or incomplete.
      */
     public void deploy() throws BuildException;

src/main/org/apache/tools/ant/taskdefs/optional/j2ee/JonasHotDeploymentTool.java

@@ -70,11 +70,10 @@ import org.apache.tools.ant.types.Path;
  *  In the end, this task assembles the commadline parameters and
  *  runs the weblogic.deploy tool in a seperate JVM.
  *
- *@author     Cyrille Morvan
- *@created    March 30, 2002
- *@see        org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool
- *@see        org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool
- *@see        org.apache.tools.ant.taskdefs.optional.j2ee.ServerDeploy
+ *@author Cyrille Morvan
+ *@see org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool
+ *@see org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool
+ *@see org.apache.tools.ant.taskdefs.optional.j2ee.ServerDeploy
  */
 public class JonasHotDeploymentTool extends GenericHotDeploymentTool implements HotDeploymentTool {
 

src/main/org/apache/tools/ant/taskdefs/optional/j2ee/WebLogicHotDeploymentTool.java

@@ -91,7 +91,7 @@ public class WebLogicHotDeploymentTool extends AbstractHotDeploymentTool impleme
     private String component;
 
     /**
-     *  Perform the actual deployment.<br>
+     *  Perform the actual deployment.
      *  For this implementation, a JVM is spawned and the weblogic.deploy
      *  tools is executed.
      *  @exception org.apache.tools.ant.BuildException if the attributes are invalid or incomplete.

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

@@ -66,10 +66,8 @@ import org.apache.tools.ant.*;
  * @see <a href="http://java.sun.com/j2se/1.4/docs/guide/net/properties.html">
  *  java 1.4 network property list</a>
  * @author Steve Loughran
- * @created March 17, 2001
  * @ant.task
  */
-
 public class SetProxy extends Task {
 
     /**
@@ -99,7 +97,7 @@ public class SetProxy extends Task {
     private String nonProxyHosts = null;
 
     /**
-     * set a proxy host. the port should be defined too
+     * Set a proxy host. The port should be defined too.
      *
      * @param hostname the new proxy hostname
      */
@@ -137,8 +135,8 @@ public class SetProxy extends Task {
     }
 
     /**
-     * specify a list of hosts to bypass the proxy on; separate them with the 
-     * vertical bar character '|'
+     * Specify a list of hosts to bypass the proxy on. These should be separated
+     * with the vertical bar character '|'.
      * e.g. fozbot.corp.sun.com|*.eng.sun.com
      * @param nonProxyHosts lists of hosts to talk direct to
      */ 

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

@@ -136,7 +136,8 @@ public final class AntFilterReader
     }
 
     /**
-     * Makes this instance in effect a reference to another AntFilterReader instance
+     * Makes this instance in effect a reference to another AntFilterReader 
+     * instance.
      *
      * <p>You must not set another attribute or nest elements inside
      * this element if you make it a reference.</p>

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

@@ -139,7 +139,8 @@ public final class FilterChain extends DataType implements Cloneable {
     }
 
     /**
-     * Makes this instance in effect a reference to another FilterChain instance
+     * Makes this instance in effect a reference to another FilterChain 
+     * instance.
      *
      * <p>You must not set another attribute or nest elements inside
      * this element if you make it a reference.</p>

src/main/org/apache/tools/ant/util/FileUtils.java

@@ -803,7 +803,7 @@ public class FileUtils {
     }
 
     /**
-     * Emulation of File.createNewFile for JDK 1.1
+     * Emulation of File.createNewFile for JDK 1.1.
      *
      * <p>This method does <strong>not</strong> guarantee that the
      * operation is atomic.</p>