checkstyle

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

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

@@ -283,7 +283,7 @@ public class AntTypeDefinition {
      * Inner implementation of the {@link #createAndSet(Project, Class)} logic, with no
      * exception catching
      * @param newclass class to create
-     * @param project
+     * @param project the project to use
      * @return a newly constructed and bound instance.
      * @throws NoSuchMethodException  no good construtor.
      * @throws InstantiationException cannot initialize the object.

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

@@ -502,7 +502,7 @@ public class ComponentHelper  {
         if (c == null || !(Task.class.isAssignableFrom(c))) {
             return null;
         }
-        Object obj= createComponent(taskType);
+        Object obj = createComponent(taskType);
         if (obj == null) {
             return null;
         }

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

@@ -864,7 +864,7 @@ public class DirectoryScanner
                 }
             }
             while (it.hasNext()) {
-                Map.Entry entry = (Map.Entry)it.next();
+                Map.Entry entry = (Map.Entry) it.next();
                 String currentelement = (String) entry.getKey();
                 if (basedir == null && !FileUtils.isAbsolutePath(currentelement)) {
                     continue;

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

@@ -2282,6 +2282,7 @@ public class Project implements ResourceFactory {
      * Resolve the file relative to the project's basedir and return it as a
      * FileResource.
      * @param name the name of the file to resolve.
+     * @return the file resource.
      * @since Ant 1.7
      */
     public Resource getResource(String name) {

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

@@ -37,7 +37,7 @@ public abstract class ProjectComponent implements Cloneable {
 
     /**
      * Location within the build file of this task definition.
-     * @deprecated since 1.6.x. 
+     * @deprecated since 1.6.x.
      *             You should not be accessing this variable directly.
      *             Please use the {@link #getLocation()} method.
      */
@@ -126,6 +126,8 @@ public abstract class ProjectComponent implements Cloneable {
     /**
      * @since Ant 1.7
      * @return a shallow copy of this projectcomponent.
+     * @throws CloneNotSupportedException does not happen,
+     *                                    but is declared to allow subclasses to do so.
      */
     public Object clone() throws CloneNotSupportedException {
         ProjectComponent pc = (ProjectComponent) super.clone();

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

@@ -212,7 +212,15 @@ public class UnknownElement extends Task {
     }
 
     /**
+     * Delegate to realThing if present and if it as task.
      * @see Task#handleInput(byte[], int, int)
+     * @param buffer the buffer into which data is to be read.
+     * @param offset the offset into the buffer at which data is stored.
+     * @param length the amount of data to read.
+     *
+     * @return the number of bytes read.
+     *
+     * @exception IOException if the data cannot be read.
      * @since Ant 1.6
      */
     protected int handleInput(byte[] buffer, int offset, int length)

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

@@ -133,7 +133,7 @@ public final class FixCrLfFilter extends BaseParamFilterReader implements Chaina
      * @return a new filter based on this configuration, but filtering the
      *         specified reader.
      */
-    public final Reader chain(final Reader rdr) {
+    public Reader chain(final Reader rdr) {
         try {
             FixCrLfFilter newFilter = new FixCrLfFilter(rdr);
 
@@ -289,7 +289,7 @@ public final class FixCrLfFilter extends BaseParamFilterReader implements Chaina
      *                if the underlying stream throws an IOException during
      *                reading.
      */
-    public synchronized final int read() throws IOException {
+    public synchronized int read() throws IOException {
         if (!initialized) {
             initInternalFilters();
         }

src/main/org/apache/tools/ant/filters/util/JavaClassHelper.java

@@ -40,7 +40,7 @@ public final class JavaClassHelper {
      * @return a StringBuffer contains the name=value pairs
      * @exception IOException if an error occurs
      */
-    public static final StringBuffer getConstants(byte[] bytes)
+    public static StringBuffer getConstants(byte[] bytes)
         throws IOException {
         final StringBuffer sb = new StringBuffer();
         final ByteArrayInputStream bis = new ByteArrayInputStream(bytes);

src/main/org/apache/tools/ant/helper/DefaultExecutor.java

@@ -32,7 +32,7 @@ public class DefaultExecutor implements Executor {
 
     private static final SingleCheckExecutor SUB_EXECUTOR = new SingleCheckExecutor();
 
-    //inherit doc
+    /** {@inheritDoc}. */
     public void executeTargets(Project project, String[] targetNames)
         throws BuildException {
         BuildException thrownException = null;
@@ -52,7 +52,7 @@ public class DefaultExecutor implements Executor {
         }
     }
 
-    //inherit doc
+    /** {@inheritDoc}. */
     public Executor getSubProjectExecutor() {
         return SUB_EXECUTOR;
     }

src/main/org/apache/tools/ant/helper/SingleCheckExecutor.java

@@ -32,14 +32,14 @@ import org.apache.tools.ant.BuildException;
  */
 public class SingleCheckExecutor implements Executor {
 
-    //inherit doc
+    /** {@inheritDoc}. */
     public void executeTargets(Project project, String[] targetNames)
         throws BuildException {
             project.executeSortedTargets(
                 project.topoSort(targetNames, project.getTargets(), false));
     }
 
-    //inherit doc
+    /** {@inheritDoc}. */
     public Executor getSubProjectExecutor() {
         return this;
     }

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

@@ -201,6 +201,7 @@ public final class AnsiColorLogger extends DefaultLogger {
     /**
      * @see DefaultLogger#printMessage
      */
+    /** {@inheritDoc}. */
     protected void printMessage(final String message,
                                       final PrintStream stream,
                                       final int priority) {

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

@@ -101,9 +101,7 @@ public class CommonsLoggingListener implements BuildListener, BuildLogger {
         return log;
     }
 
-    /**
-     * @see BuildListener#buildStarted
-     */
+    /** {@inheritDoc}. */
     public void buildStarted(BuildEvent event) {
         String categoryString = PROJECT_LOG;
         Log log = getLog(categoryString, null);
@@ -113,9 +111,7 @@ public class CommonsLoggingListener implements BuildListener, BuildLogger {
         }
     }
 
-    /**
-     * @see BuildListener#buildFinished
-     */
+    /** {@inheritDoc}. */
     public void buildFinished(BuildEvent event) {
         if (initialized) {
             String categoryString = PROJECT_LOG;
@@ -133,6 +129,7 @@ public class CommonsLoggingListener implements BuildListener, BuildLogger {
     /**
      * @see BuildListener#targetStarted
      */
+    /** {@inheritDoc}. */
     public void targetStarted(BuildEvent event) {
         if (initialized) {
             Log log = getLog(TARGET_LOG,
@@ -147,6 +144,7 @@ public class CommonsLoggingListener implements BuildListener, BuildLogger {
     /**
      * @see BuildListener#targetFinished
      */
+    /** {@inheritDoc}. */
     public void targetFinished(BuildEvent event) {
         if (initialized) {
             String targetName = event.getTarget().getName();
@@ -165,6 +163,7 @@ public class CommonsLoggingListener implements BuildListener, BuildLogger {
     /**
      * @see BuildListener#taskStarted
      */
+    /** {@inheritDoc}. */
     public void taskStarted(BuildEvent event) {
         if (initialized) {
             Task task = event.getTask();
@@ -186,6 +185,7 @@ public class CommonsLoggingListener implements BuildListener, BuildLogger {
     /**
      * @see BuildListener#taskFinished
      */
+    /** {@inheritDoc}. */
     public void taskFinished(BuildEvent event) {
         if (initialized) {
             Task task = event.getTask();
@@ -214,6 +214,7 @@ public class CommonsLoggingListener implements BuildListener, BuildLogger {
     /**
      * @see BuildListener#messageLogged
      */
+    /** {@inheritDoc}. */
     public void messageLogged(BuildEvent event) {
         if (initialized) {
             Object categoryObject = event.getTask();

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

@@ -58,6 +58,7 @@ public class Log4jListener implements BuildListener {
     /**
      * @see BuildListener#buildStarted
      */
+    /** {@inheritDoc}. */
     public void buildStarted(BuildEvent event) {
         if (initialized) {
             Logger log = Logger.getLogger(Project.class.getName());
@@ -68,6 +69,7 @@ public class Log4jListener implements BuildListener {
     /**
      * @see BuildListener#buildFinished
      */
+    /** {@inheritDoc}. */
     public void buildFinished(BuildEvent event) {
         if (initialized) {
             Logger log = Logger.getLogger(Project.class.getName());
@@ -82,6 +84,7 @@ public class Log4jListener implements BuildListener {
     /**
      * @see BuildListener#targetStarted
      */
+    /** {@inheritDoc}. */
     public void targetStarted(BuildEvent event) {
         if (initialized) {
             Logger log = Logger.getLogger(Target.class.getName());
@@ -92,6 +95,7 @@ public class Log4jListener implements BuildListener {
     /**
      * @see BuildListener#targetFinished
      */
+    /** {@inheritDoc}. */
     public void targetFinished(BuildEvent event) {
         if (initialized) {
             String targetName = event.getTarget().getName();
@@ -108,6 +112,7 @@ public class Log4jListener implements BuildListener {
     /**
      * @see BuildListener#taskStarted
      */
+    /** {@inheritDoc}. */
     public void taskStarted(BuildEvent event) {
         if (initialized) {
             Task task = event.getTask();
@@ -119,6 +124,7 @@ public class Log4jListener implements BuildListener {
     /**
      * @see BuildListener#taskFinished
      */
+    /** {@inheritDoc}. */
     public void taskFinished(BuildEvent event) {
         if (initialized) {
             Task task = event.getTask();
@@ -135,6 +141,7 @@ public class Log4jListener implements BuildListener {
     /**
      * @see BuildListener#messageLogged
      */
+    /** {@inheritDoc}. */
     public void messageLogged(BuildEvent event) {
         if (initialized) {
             Object categoryObject = event.getTask();

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

@@ -54,6 +54,10 @@ public class TimestampedLogger extends DefaultLogger {
         return super.getBuildSuccessfulMessage() + SPACER + getTimestamp();
     }
 
+    /**
+     * Get the current time.
+     * @return the current time as a formatted string.
+     */
     protected String getTimestamp() {
         Date date = new Date(System.currentTimeMillis());
         DateFormat formatter = DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.SHORT);

src/main/org/apache/tools/ant/loader/AntClassLoader2.java

@@ -25,5 +25,7 @@ import org.apache.tools.ant.AntClassLoader;
  *             Just use {@link AntClassLoader} itself.
  */
 public class AntClassLoader2 extends AntClassLoader {
-    public AntClassLoader2() {}
+    /** No args constructor. */
+    public AntClassLoader2() {
+    }
 }