Some simple Javadocs - also reduce scope of Javadoc work to public

for now


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

check.xml

@@ -1,13 +1,15 @@
 <project default="checkstyle" name="CheckAnt">
   <property name="java.dir" value="src/main"/>
   <property name="tocheck" value="**/*.java"/>  
-
+  <property name="javadoc.scope" value="public"/>
+  
   <target name="checkstyle">
     <taskdef name="checkstyle"
              classname="com.puppycrawl.tools.checkstyle.CheckStyleTask"/>
     <checkstyle headerFile="src/etc/RequiredHeader.txt"
                 headerIgnoreLine="4"
-                allowProtected="true">
+                allowProtected="true"
+                javadocScope="${javadoc.scope}">
       <fileset dir="${java.dir}">
         <include name="${tocheck}"/>
       </fileset>

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

@@ -100,7 +100,7 @@ public class StringInputStream
     }
 
     /**
-     * Resetthe StringReader
+     * Reset the StringReader.
      */
     public synchronized void reset() throws IOException {
         in.reset();

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

@@ -182,11 +182,11 @@ public abstract class AbstractCvsTask extends Task {
         super();
     }
 
-    public void setExecuteStreamHandler(ExecuteStreamHandler handler){
+    public void setExecuteStreamHandler(ExecuteStreamHandler handler) {
         this.executeStreamHandler = handler;
     }
 
-    protected ExecuteStreamHandler getExecuteStreamHandler(){
+    protected ExecuteStreamHandler getExecuteStreamHandler() {
 
         if (this.executeStreamHandler == null) {
             setExecuteStreamHandler(new PumpStreamHandler(getOutputStream(), 
@@ -197,12 +197,12 @@ public abstract class AbstractCvsTask extends Task {
     }
 
 
-    protected void setOutputStream(OutputStream outputStream){
+    protected void setOutputStream(OutputStream outputStream) {
 
         this.outputStream = outputStream;
     }
 
-    protected OutputStream getOutputStream(){
+    protected OutputStream getOutputStream() {
 
         if (this.outputStream == null) {
 
@@ -224,12 +224,12 @@ public abstract class AbstractCvsTask extends Task {
         return this.outputStream;
     }
 
-    protected void setErrorStream(OutputStream errorStream){
+    protected void setErrorStream(OutputStream errorStream) {
 
         this.errorStream = errorStream;
     }
 
-    protected OutputStream getErrorStream(){
+    protected OutputStream getErrorStream() {
 
         if (this.errorStream == null) {
 

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

@@ -535,7 +535,9 @@ public class Ant extends Task {
     public static class Reference
         extends org.apache.tools.ant.types.Reference {
 
-        public Reference() {super();}
+        public Reference() {
+            super();
+        }
 
         private String targetid = null;
 

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

@@ -83,7 +83,6 @@ import java.io.IOException;
  *
  * @ant.task category="xml"
  */
-
 public class AntStructure extends Task {
 
     private final String lSep = System.getProperty("line.separator");
@@ -103,6 +102,11 @@ public class AntStructure extends Task {
         this.output = output;
     }
 
+    /**
+     * Build the antstructure DTD.
+     *
+     * @exception BuildException if the DTD cannot be written.
+     */
     public void execute() throws BuildException {
 
         if (output == null) {

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

@@ -106,6 +106,9 @@ public class CVSPass extends Task {
         243, 233, 253, 240, 194, 250, 191, 155, 142, 137, 245, 235, 163, 242, 178, 152 
     };
 
+    /**
+     * Create a CVS task using the default cvspass file location.
+     */
     public CVSPass(){
         passFile = new File(System.getProperty("user.home") + "/.cvspass");
     }

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

@@ -121,6 +121,9 @@ public class Copy extends Task {
     private FileUtils fileUtils;
     private String encoding = null;
 
+    /**
+     * Copy task constructor. 
+     */
     public Copy() {
         fileUtils = FileUtils.newFileUtils();
     }

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

@@ -76,6 +76,9 @@ public class Ear extends Jar {
     private File deploymentDescriptor;
     private boolean descriptorAdded;
 
+    /**
+     * Create an Ear task.
+     */
     public Ear() {
         super();
         archiveType = "ear";

src/main/org/apache/tools/ant/taskdefs/compilers/DefaultCompilerAdapter.java

@@ -114,6 +114,12 @@ public abstract class DefaultCompilerAdapter implements CompilerAdapter {
 
     private FileUtils fileUtils = FileUtils.newFileUtils();
 
+    /**
+     * Set the Javac instance which contains the configured compilation
+     * attributes.
+     *
+     * @param attributes a configured Javac task.
+     */
     public void setJavac(Javac attributes) {
         this.attributes = attributes;
         src = attributes.getSrcdir();
@@ -138,6 +144,11 @@ public abstract class DefaultCompilerAdapter implements CompilerAdapter {
         memoryMaximumSize = attributes.getMemoryMaximumSize();
     }
 
+    /**
+     * Get the Javac task instance associated with this compiler adapter
+     *
+     * @return the configured Javac task instance used by this adapter.
+     */
     public Javac getJavac() {
         return attributes;
     }

src/main/org/apache/tools/ant/taskdefs/compilers/Javac12.java

@@ -79,6 +79,11 @@ import java.lang.reflect.Method;
  */
 public class Javac12 extends DefaultCompilerAdapter {
 
+    /**
+     * Run the compilation.
+     *
+     * @exception BuildException if the compilation has problems.
+     */
     public boolean execute() throws BuildException {
         attributes.log("Using classic compiler", Project.MSG_VERBOSE);
         Commandline cmd = setupJavacCommand(true);

src/main/org/apache/tools/ant/taskdefs/compilers/Javac13.java

@@ -82,6 +82,11 @@ public class Javac13 extends DefaultCompilerAdapter {
      */
     private static final int MODERN_COMPILER_SUCCESS = 0;
 
+    /**
+     * Run the compilation.
+     *
+     * @exception BuildException if the compilation has problems.
+     */
     public boolean execute() throws BuildException {
         attributes.log("Using modern compiler", Project.MSG_VERBOSE);
         Commandline cmd = setupModernJavacCommand();

src/main/org/apache/tools/ant/taskdefs/compilers/Jvc.java

@@ -73,6 +73,11 @@ import org.apache.tools.ant.types.Commandline;
  */
 public class Jvc extends DefaultCompilerAdapter {
 
+    /**
+     * Run the compilation.
+     *
+     * @exception BuildException if the compilation has problems.
+     */
     public boolean execute() throws BuildException {
         attributes.log("Using jvc compiler", Project.MSG_VERBOSE);
 

src/main/org/apache/tools/ant/taskdefs/compilers/Kjc.java

@@ -74,6 +74,11 @@ import java.lang.reflect.Method;
  */
 public class Kjc extends DefaultCompilerAdapter {
 
+    /**
+     * Run the compilation.
+     *
+     * @exception BuildException if the compilation has problems.
+     */
     public boolean execute() throws BuildException {
         attributes.log("Using kjc compiler", Project.MSG_VERBOSE);
         Commandline cmd = setupKjcCommand();

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

@@ -65,7 +65,7 @@ import java.io.File;
 /**
  * Build EJB support classes using Weblogic's ejbc tool from a directory containing
  * a set of deployment descriptors.
- 
+ *
  *
  * @author Conor MacNeill, Cortex ebusiness Pty Limited
  */

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

@@ -100,6 +100,7 @@ public class Path extends DataType implements Cloneable {
 
     private Vector elements;
 
+    /** The system classspath as a Path object */
     public static Path systemClasspath = 
         new Path(null, System.getProperty("java.class.path"));
 

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

@@ -97,6 +97,7 @@ import org.apache.tools.ant.util.regexp.RegexpFactory;
  * @ant.datatype name="regexp"
  */
 public class RegularExpression extends DataType {
+    /** Name of this data type */
     public static final String DATA_TYPE_NAME = "regexp";
 
     // The regular expression factory

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

@@ -71,6 +71,7 @@ import org.apache.tools.ant.Project;
  * @author Matthew Inger <a href="mailto:mattinger@mindless.com">mattinger@mindless.com</a>
  */
 public class Substitution extends DataType {
+    /** The name of this data type */
     public static final String DATA_TYPE_NAME = "substitition";
 
     private String expression;

src/main/org/apache/tools/tar/TarOutputStream.java

@@ -71,8 +71,13 @@ import java.io.IOException;
  * @author Timothy Gerard Endres <a href="mailto:time@ice.com">time@ice.com</a>
  */
 public class TarOutputStream extends FilterOutputStream {
+    /** Fail if a long file name is required in the archive. */
     public static final int LONGFILE_ERROR = 0;
+    
+    /** Long paths will be truncated in the archive. */
     public static final int LONGFILE_TRUNCATE = 1;
+    
+    /** GNU tar extensions are used to store long file names in the archive. */
     public static final int LONGFILE_GNU = 2;
     
     protected boolean   debug;