checkstyle - mostly javadoc

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

4 files changed, 23 insertions, 9 deletions

diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/DefaultJspCompilerAdapter.java b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/DefaultJspCompilerAdapter.java
index 5d19649ce..ab8c06a2b 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/DefaultJspCompilerAdapter.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/DefaultJspCompilerAdapter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright  2001-2004 The Apache Software Foundation
+ * Copyright  2001-2005 The Apache Software Foundation
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -38,6 +38,9 @@ public abstract class DefaultJspCompilerAdapter
     /**
      * Logs the compilation parameters, adds the files to compile and logs the
      * "niceSourceList"
+     * @param jspc the compiler task for logging
+     * @param compileList the list of files to compile
+     * @param cmd the command line used
      */
     protected void logAndAddFilesToCompile(JspC jspc,
                                            Vector compileList,
@@ -70,6 +73,7 @@ public abstract class DefaultJspCompilerAdapter
 
     /**
      * set the owner
+     * @param owner the owner JspC compiler
      */
     public void setJspc(JspC owner) {
         this.owner = owner;
@@ -85,7 +89,7 @@ public abstract class DefaultJspCompilerAdapter
 
     /**
      *  add an argument oneple to the argument list, if the value aint null
-     *
+     * @param cmd the command line
      * @param  argument  The argument
      */
     protected void addArg(CommandlineJava cmd, String argument) {
@@ -97,7 +101,7 @@ public abstract class DefaultJspCompilerAdapter
 
     /**
      *  add an argument tuple to the argument list, if the value aint null
-     *
+     * @param cmd the command line
      * @param  argument  The argument
      * @param  value     the parameter
      */
@@ -110,7 +114,7 @@ public abstract class DefaultJspCompilerAdapter
 
     /**
      *  add an argument tuple to the arg list, if the file parameter aint null
-     *
+     * @param cmd the command line
      * @param  argument  The argument
      * @param  file     the parameter
      */
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JasperC.java b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JasperC.java
index 50df8c281..d42b3e0c1 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JasperC.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JasperC.java
@@ -41,12 +41,18 @@ public class JasperC extends DefaultJspCompilerAdapter {
      */
     JspMangler mangler;
 
+    /**
+     * Constructor for JasperC.
+     * @param mangler a filename converter
+     */
     public JasperC(JspMangler mangler) {
         this.mangler = mangler;
     }
 
     /**
-     * our execute method
+     * Our execute method.
+     * @return true if successful
+     * @throws BuildException on error
      */
     public boolean execute()
         throws BuildException {
@@ -69,7 +75,7 @@ public class JasperC extends DefaultJspCompilerAdapter {
             java.setDir(getProject().getBaseDir());
             java.setClassname("org.apache.jasper.JspC");
             //this is really irritating; we need a way to set stuff
-            String args[] = cmd.getJavaCommand().getArguments();
+            String []args = cmd.getJavaCommand().getArguments();
             for (int i = 0; i < args.length; i++) {
                 java.createArg().setValue(args[i]);
             }
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JspCompilerAdapter.java b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JspCompilerAdapter.java
index 4c7ec50a2..340185ab2 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JspCompilerAdapter.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JspCompilerAdapter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright  2001-2004 The Apache Software Foundation
+ * Copyright  2001-2005 The Apache Software Foundation
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -36,6 +36,7 @@ public interface JspCompilerAdapter {
 
     /**
      * Sets the compiler attributes, which are stored in the Jspc task.
+     * @param attributes the jsp compiler attributes
      */
     void setJspc(JspC attributes);
 
@@ -43,6 +44,7 @@ public interface JspCompilerAdapter {
      * Executes the task.
      *
      * @return has the compilation been successful
+     * @throws BuildException on error
      */
     boolean execute() throws BuildException;
 
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JspCompilerAdapterFactory.java b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JspCompilerAdapterFactory.java
index 8454ef161..fb182af8c 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JspCompilerAdapterFactory.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JspCompilerAdapterFactory.java
@@ -1,5 +1,5 @@
 /*
- * Copyright  2001-2004 The Apache Software Foundation
+ * Copyright  2001-2005 The Apache Software Foundation
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -27,7 +27,7 @@ import org.apache.tools.ant.taskdefs.optional.jsp.Jasper41Mangler;
  * Creates the necessary compiler adapter, given basic criteria.
  *
  */
-public class JspCompilerAdapterFactory {
+public final class JspCompilerAdapterFactory {
 
     /** This is a singleton -- can't create instances!! */
     private JspCompilerAdapterFactory() {
@@ -46,6 +46,7 @@ public class JspCompilerAdapterFactory {
      * @param compilerType either the name of the desired compiler, or the
      * full classname of the compiler's adapter.
      * @param task a task to log through.
+     * @return the compiler
      * @throws BuildException if the compiler type could not be resolved into
      * a compiler adapter.
      */
@@ -69,6 +70,7 @@ public class JspCompilerAdapterFactory {
      * full classname of the compiler's adapter.
      * @param task a task to log through.
      * @param loader AntClassLoader with which the compiler should be loaded
+     * @return the compiler
      * @throws BuildException if the compiler type could not be resolved into
      * a compiler adapter.
      */