You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ant.apache.org by gi...@apache.org on 2017/12/10 06:16:20 UTC
[5/8] ant git commit: Let’s use doclint
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/extension/Compatability.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/extension/Compatability.java b/src/main/org/apache/tools/ant/taskdefs/optional/extension/Compatability.java
index 1d748e4..262753c 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/extension/Compatability.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/extension/Compatability.java
@@ -23,7 +23,7 @@ package org.apache.tools.ant.taskdefs.optional.extension;
* of object.
*
* WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
- * This file is from excalibur.extension package. Dont edit this file
+ * This file is from excalibur.extension package. Do not edit this file
* directly as there is no unit tests to make sure it is operational
* in ant. Edit file in excalibur and run tests there before changing
* ants file.
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/extension/Compatibility.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/extension/Compatibility.java b/src/main/org/apache/tools/ant/taskdefs/optional/extension/Compatibility.java
index 5c3240d..8e1ef16 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/extension/Compatibility.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/extension/Compatibility.java
@@ -23,7 +23,7 @@ package org.apache.tools.ant.taskdefs.optional.extension;
* of object.
*
* WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
- * This file is from excalibur.extension package. Dont edit this file
+ * This file is from excalibur.extension package. Do not edit this file
* directly as there is no unit tests to make sure it is operational
* in ant. Edit file in excalibur and run tests there before changing
* ants file.
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionUtil.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionUtil.java b/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionUtil.java
index 7ed5fb9..4be001c 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionUtil.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionUtil.java
@@ -45,7 +45,7 @@ public final class ExtensionUtil {
/**
* Convert a list of extensionAdapter objects to extensions.
*
- * @param adapters the list of ExtensionAdapterss to add to convert
+ * @param adapters the list of ExtensionAdapters to add to convert
* @throws BuildException if an error occurs
*/
static ArrayList<Extension> toExtensions(final List<? extends ExtensionAdapter> adapters)
@@ -58,7 +58,7 @@ public final class ExtensionUtil {
* Generate a list of extensions from a specified fileset.
*
* @param libraries the list to add extensions to
- * @param fileset the filesets containing librarys
+ * @param fileset the filesets containing libraries
* @throws BuildException if an error occurs
*/
static void extractExtensions(final Project project,
@@ -180,7 +180,7 @@ public final class ExtensionUtil {
*
* @param file the file
* @return the manifest
- * @throws BuildException if errror occurs (file doesn't exist,
+ * @throws BuildException if error occurs (file doesn't exist,
* file not a jar, manifest doesn't exist in file)
*/
static Manifest getManifest(final File file)
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibAvailableTask.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibAvailableTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibAvailableTask.java
index 84ba74a..cde8834 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibAvailableTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibAvailableTask.java
@@ -38,7 +38,7 @@ public class JarLibAvailableTask extends Task {
private File libraryFile;
/**
- * Filesets specifying all the librarys
+ * Filesets specifying all the libraries
* to display information about.
*/
private final List<ExtensionSet> extensionFileSets = new Vector<>();
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibDisplayTask.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibDisplayTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibDisplayTask.java
index 0f31657..8282033 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibDisplayTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibDisplayTask.java
@@ -46,7 +46,7 @@ public class JarLibDisplayTask extends Task {
private File libraryFile;
/**
- * Filesets specifying all the librarys
+ * Filesets specifying all the libraries
* to display information about.
*/
private final List<FileSet> libraryFileSets = new Vector<>();
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibManifestTask.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibManifestTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibManifestTask.java
index 6e53294..7834309 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibManifestTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibManifestTask.java
@@ -247,8 +247,8 @@ public final class JarLibManifestTask extends Task {
* Also use specified extensionKey so that can generate list of
* optional dependencies as well.
*
- * @param size the number of librarys to list
- * @param listPrefix the prefix for all librarys
+ * @param size the number of libraries to list
+ * @param listPrefix the prefix for all libraries
* @param attributes the attributes to add key-value to
* @param extensionKey the key to use
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibResolveTask.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibResolveTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibResolveTask.java
index 5cdc32f..e1be055 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibResolveTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibResolveTask.java
@@ -54,7 +54,7 @@ public class JarLibResolveTask extends Task {
/**
* Flag to indicate that you should check that
- * the librarys resolved actually contain
+ * the libraries resolved actually contain
* extension and if they don't then raise
* an exception.
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/extension/LibFileSet.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/extension/LibFileSet.java b/src/main/org/apache/tools/ant/taskdefs/optional/extension/LibFileSet.java
index bade00f..3a877ac 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/extension/LibFileSet.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/extension/LibFileSet.java
@@ -41,7 +41,7 @@ public class LibFileSet extends FileSet {
private boolean includeImpl;
/**
- * String that is the base URL for the librarys
+ * String that is the base URL for the libraries
* when constructing the "Implementation-URL"
* attribute. For instance setting the base to
* "http://jakarta.apache.org/avalon/libs/" and then
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/extension/LibraryDisplayer.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/extension/LibraryDisplayer.java b/src/main/org/apache/tools/ant/taskdefs/optional/extension/LibraryDisplayer.java
index d3eb056..0d2af0d 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/extension/LibraryDisplayer.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/extension/LibraryDisplayer.java
@@ -27,7 +27,7 @@ import org.apache.tools.ant.BuildException;
/**
* Utility class to output the information in a jar relating
- * to "Optional Packages" (formely known as "Extensions")
+ * to "Optional Packages" (formerly known as "Extensions")
* and Package Specifications.
*
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/extension/Specification.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/extension/Specification.java b/src/main/org/apache/tools/ant/taskdefs/optional/extension/Specification.java
index ea8405c..f1d33e2 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/extension/Specification.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/extension/Specification.java
@@ -445,7 +445,7 @@ public final class Specification {
* Combine all specifications objects that are identical except
* for the sections.
*
- * <p>Note this is very inefficent and should probably be fixed
+ * <p>Note this is very inefficient and should probably be fixed
* in the future.</p>
*
* @param list the array of results to trim
@@ -475,8 +475,8 @@ public final class Specification {
/**
* Test if two specifications are equal except for their sections.
*
- * @param specification one specificaiton
- * @param other the ohter specification
+ * @param specification one specification
+ * @param other the other specification
* @return true if two specifications are equal except for their
* sections, else false
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/i18n/Translate.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/i18n/Translate.java b/src/main/org/apache/tools/ant/taskdefs/optional/i18n/Translate.java
index 3ec7d77..edcced8 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/i18n/Translate.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/i18n/Translate.java
@@ -356,7 +356,7 @@ public class Translate extends MatchingTask {
* basebundlename + "_" + language2 + "_" + country2
* basebundlename + "_" + language2
*
- * To the generated name, a ".properties" string is appeneded and
+ * To the generated name, a ".properties" string is appended and
* once this file is located, it is treated just like a properties file
* but with bundle encoding also considered while loading.
*/
@@ -411,7 +411,7 @@ public class Translate extends MatchingTask {
log(propsFile + " not found.", Project.MSG_DEBUG);
//if all resource files associated with this bundle
//have been scanned for and still not able to
- //find a single resrouce file, throw exception
+ //find a single resource file, throw exception
if (!loaded && checkLoaded) {
throw new BuildException(ioe.getMessage(), getLocation());
}
@@ -476,7 +476,7 @@ public class Translate extends MatchingTask {
* and endToken. The values for these keys are looked up from
* the hashtable and substituted. If the hashtable doesn't
* contain the key, they key itself is used as the value.
- * Detination files and directories are created as needed.
+ * Destination files and directories are created as needed.
* The destination file is overwritten only if
* the forceoverwritten attribute is set to true if
* the source file or any associated bundle resource file is
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/image/Image.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/image/Image.java b/src/main/org/apache/tools/ant/taskdefs/optional/image/Image.java
index 53b234b..ac4762e 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/image/Image.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/image/Image.java
@@ -211,6 +211,11 @@ public class Image extends MatchingTask {
/**
* Executes all the chained ImageOperations on the files inside
* the directory.
+ * @param srcDir File
+ * @param srcNames String[]
+ * @param dstDir File
+ * @param mapper FileNameMapper
+ * @return int
* @since Ant 1.8.0
*/
public int processDir(final File srcDir, final String[] srcNames,
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.java
index 21d8478..b5296bd 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.java
@@ -27,17 +27,17 @@ import org.apache.tools.ant.types.Path;
*
* Subclassing this class for a vendor specific tool involves the
* following.
- * <ol><li>Implement the <code>isActionValid()<code> method to insure the
- * action supplied as the "action" attribute of ServerDeploy is valid.
+ * <ol><li>Implement the <code>isActionValid()</code> method to insure the
+ * action supplied as the "action" attribute of ServerDeploy is valid.</li>
* <li>Implement the <code>validateAttributes()</code> method to insure
- * all required attributes are supplied, and are in the correct format.
+ * all required attributes are supplied, and are in the correct format.</li>
* <li>Add a <code>add<TOOL></code> method to the ServerDeploy
* class. This method will be called when Ant encounters a
* <code>add<TOOL></code> task nested in the
- * <code>serverdeploy</code> task.
+ * <code>serverdeploy</code> task.</li>
* <li>Define the <code>deploy</code> method. This method should perform
* whatever task it takes to hot-deploy the component. IE: spawn a JVM and
- * run class, exec a native executable, run Java code...
+ * run class, exec a native executable, run Java code...</li></ol>
*
* @see org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool
* @see org.apache.tools.ant.taskdefs.optional.j2ee.ServerDeploy
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/JonasHotDeploymentTool.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/JonasHotDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/JonasHotDeploymentTool.java
index 6e7f118..f5c908c 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/JonasHotDeploymentTool.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/JonasHotDeploymentTool.java
@@ -143,17 +143,17 @@ public class JonasHotDeploymentTool extends GenericHotDeploymentTool implements
}
/**
- * Validates the passed in attributes. <p>
+ * Validates the passed in attributes.
*
- * The rules are:
- * <ol>
+ * <p>The rules are:</p>
+ * <ol>
* <li> If action is "deploy" or "update" the "application"
- * and "source" attributes must be supplied.
+ * and "source" attributes must be supplied.</li>
* <li> If action is "delete" or "undeploy" the
- * "application" attribute must be supplied.
+ * "application" attribute must be supplied.</li>
+ * </ol>
*
- *@exception BuildException Description
- * of Exception
+ * @exception BuildException if something goes wrong
*/
@Override
public void validateAttributes() throws BuildException {
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/WebLogicHotDeploymentTool.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/WebLogicHotDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/WebLogicHotDeploymentTool.java
index e186dcb..2838c2d 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/WebLogicHotDeploymentTool.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/WebLogicHotDeploymentTool.java
@@ -28,7 +28,7 @@ import org.apache.tools.ant.taskdefs.Java;
* This task assumes the archive (EAR, JAR, or WAR) file has been
* assembled and is supplied as the "source" attribute.
* <p>In the end, this task assembles the commandline parameters
- * and runs the weblogic.deploy tool in a separate JVM.
+ * and runs the weblogic.deploy tool in a separate JVM.</p>
*
* @see org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool
* @see org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool
@@ -57,7 +57,7 @@ public class WebLogicHotDeploymentTool extends AbstractHotDeploymentTool
* 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.
+ * @exception BuildException if the attributes are invalid or incomplete.
*/
@Override
public void deploy() {
@@ -73,12 +73,13 @@ public class WebLogicHotDeploymentTool extends AbstractHotDeploymentTool
/**
* Validates the passed in attributes.
- * <p>The rules are:
+ * <p>The rules are:</p>
* <ol><li>If action is "deploy" or "update" the "application" and "source"
- * attributes must be supplied.
+ * attributes must be supplied.</li>
* <li>If action is "delete" or "undeploy" the "application" attribute must
- * be supplied.
- * @exception org.apache.tools.ant.BuildException if the attributes are invalid or incomplete
+ * be supplied.</li></ol>
+ *
+ * @exception BuildException if the attributes are invalid or incomplete
*/
@Override
public void validateAttributes() throws BuildException {
@@ -114,9 +115,9 @@ public class WebLogicHotDeploymentTool extends AbstractHotDeploymentTool
}
/**
- * Builds the arguments to pass to weblogic.deploy according to the
- * supplied action.
- * @return A String containing the arguments for the weblogic.deploy tool.
+ * Builds the arguments to pass to weblogic.deploy according to the
+ * supplied action.
+ * @return A String containing the arguments for the weblogic.deploy tool.
* @throws BuildException if there is an error.
*/
public String getArguments() throws BuildException {
@@ -135,9 +136,9 @@ public class WebLogicHotDeploymentTool extends AbstractHotDeploymentTool
}
/**
- * Determines if the action supplied is valid.
- * <p>Valid actions are contained in the static array VALID_ACTIONS
- * @return true if the action attribute is valid, false if not.
+ * Determines if the action supplied is valid.
+ * <p>Valid actions are contained in the static array VALID_ACTIONS</p>
+ * @return true if the action attribute is valid, false if not.
*/
@Override
protected boolean isActionValid() {
@@ -160,7 +161,7 @@ public class WebLogicHotDeploymentTool extends AbstractHotDeploymentTool
protected StringBuffer buildArgsPrefix() {
ServerDeploy task = getTask();
// constructs the "-url <url> -debug <action> <password>" portion
- // of the commmand line
+ // of the command line
return new StringBuffer(STRING_BUFFER_SIZE)
.append((getServer() != null)
? "-url " + getServer()
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.java b/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.java
index e3bca20..433ce22 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.java
@@ -338,10 +338,10 @@ public class JJTree extends Task {
* handled as if relative of this -OUTPUT_DIRECTORY. Thus when the
* -OUTPUT_FILE is absolute or contains a drive letter we have a problem.
*
- * @param destFile
- * @param outputDir
+ * @param destFile String
+ * @param outputDir String
* @return validation file, relative if possible; <tt>null</tt> if not set
- * @throws BuildException
+ * @throws BuildException if something goes wrong
*/
private String validateOutputFile(String destFile,
String outputDir)
@@ -395,7 +395,7 @@ public class JJTree extends Task {
/**
* Determine root directory for a given file.
*
- * @param file
+ * @param file File
* @return file's root directory
*/
private File getRoot(File file) {
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/jdepend/JDependTask.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/jdepend/JDependTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/jdepend/JDependTask.java
index 331c975..c1febfa 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/jdepend/JDependTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/jdepend/JDependTask.java
@@ -30,6 +30,7 @@ import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Optional;
+
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.Task;
@@ -162,7 +163,7 @@ public class JDependTask extends Task {
* If true, forks into a new JVM. Default: false.
*
* @param value <tt>true</tt> if a JVM should be forked,
- * otherwise <tt>false<tt>
+ * otherwise <tt>false</tt>
*/
public void setFork(boolean value) {
fork = value;
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/jlink/JlinkTask.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/jlink/JlinkTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/jlink/JlinkTask.java
index 4e4b0aa..db8b3a3 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/jlink/JlinkTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/jlink/JlinkTask.java
@@ -34,8 +34,7 @@ import org.apache.tools.ant.types.Path;
* org.apache.tools.ant.taskdefs.optional.jlink.ClassNameReader
* support this class.</p>
*
- * <p>For example:
- * <code>
+ * <p>For example:</p>
* <pre>
* <jlink compress="false" outfile="out.jar"/>
* <mergefiles>
@@ -48,7 +47,6 @@ import org.apache.tools.ant.types.Path;
* </addfiles>
* </jlink>
* </pre>
- * </code>
*
* @ant.task ignore="true"
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java
index 4af9f3d..c5caca1 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java
@@ -35,22 +35,22 @@ import org.apache.tools.ant.types.Reference;
/**
* Runs a JSP compiler.
*
- * <p> This task takes the given jsp files and compiles them into java
- * files. It is then up to the user to compile the java files into classes.
+ * <p>This task takes the given jsp files and compiles them into java
+ * files. It is then up to the user to compile the java files into classes.</p>
*
- * <p> The task requires the srcdir and destdir attributes to be
+ * <p>The task requires the srcdir and destdir attributes to be
* set. This Task is a MatchingTask, so the files to be compiled can be
* specified using includes/excludes attributes or nested include/exclude
* elements. Optional attributes are verbose (set the verbosity level passed
* to jasper), package (name of the destination package for generated java
* classes and classpath (the classpath to use when running the jsp
- * compiler).
- * <p> This task supports the nested elements classpath (A Path) and
- * classpathref (A Reference) which can be used in preference to the
+ * compiler).</p>
+ * <p>This task supports the nested elements classpath (a Path) and
+ * classpathref (a Reference) which can be used in preference to the
* attribute classpath, if the jsp compiler is not already in the ant
- * classpath.
+ * classpath.</p>
*
- * <p><h4>Usage</h4>
+ * <h2>Usage</h2>
* <pre>
* <jspc srcdir="${basedir}/src/war"
* destdir="${basedir}/gensrc"
@@ -60,7 +60,7 @@ import org.apache.tools.ant.types.Reference;
* </jspc>
* </pre>
*
- * <p> Large Amount of cutting and pasting from the Javac task...
+ * <p>Large amount of cutting and pasting from the Javac task...</p>
* @since 1.5
*/
public class JspC extends MatchingTask {
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/DefaultJspCompilerAdapter.java
----------------------------------------------------------------------
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 303ef6f..5814597 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
@@ -87,7 +87,7 @@ public abstract class DefaultJspCompilerAdapter
}
/**
- * add an argument oneple to the argument list, if the value aint null
+ * add a single argument to the argument list, if the value aint null
* @param cmd the command line
* @param argument The argument
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JspCompilerAdapter.java
----------------------------------------------------------------------
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 16b67f9..68e693c 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
@@ -22,7 +22,7 @@ import org.apache.tools.ant.taskdefs.optional.jsp.JspC;
import org.apache.tools.ant.taskdefs.optional.jsp.JspMangler;
/**
- * The interface that all jsp compiler adapters must adher to.
+ * The interface that all jsp compiler adapters must adhere to.
*
* <p>A compiler adapter is an adapter that interprets the jspc's
* parameters in preparation to be passed off to the compiler this
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/junit/BaseTest.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/BaseTest.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/BaseTest.java
index 0462969..6beb81c 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/BaseTest.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/BaseTest.java
@@ -132,6 +132,7 @@ public abstract class BaseTest {
/**
* The if expression
+ * @return Object
* @since Ant 1.8.0
*/
public Object getIfCondition() {
@@ -163,6 +164,7 @@ public abstract class BaseTest {
/**
* The unless expression
+ * @return Object
* @since Ant 1.8.0
*/
public Object getUnlessCondition() {
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/junit/BatchTest.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/BatchTest.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/BatchTest.java
index fb5d44b..11271bf 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/BatchTest.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/BatchTest.java
@@ -31,13 +31,13 @@ import org.apache.tools.ant.types.ResourceCollection;
import org.apache.tools.ant.types.resources.Resources;
/**
- * <p> Create then run <code>JUnitTest</code>'s based on the list of files
- * given by the fileset attribute.
+ * <p>Create then run <code>JUnitTest</code>'s based on the list of files
+ * given by the fileset attribute.</p>
*
- * <p> Every <code>.java</code> or <code>.class</code> file in the fileset is
+ * <p>Every <code>.java</code> or <code>.class</code> file in the fileset is
* assumed to be a testcase.
* A <code>JUnitTest</code> is created for each of these named classes with
- * basic setup inherited from the parent <code>BatchTest</code>.
+ * basic setup inherited from the parent <code>BatchTest</code>.</p>
*
* @see JUnitTest
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/junit/BriefJUnitResultFormatter.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/BriefJUnitResultFormatter.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/BriefJUnitResultFormatter.java
index 975de68..4f00180 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/BriefJUnitResultFormatter.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/BriefJUnitResultFormatter.java
@@ -97,8 +97,8 @@ public class BriefJUnitResultFormatter implements JUnitResultFormatter, IgnoredT
/**
* @see JUnitResultFormatter#setSystemOutput(String)
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
@Override
public void setSystemOutput(String out) {
systemOutput = out;
@@ -106,8 +106,8 @@ public class BriefJUnitResultFormatter implements JUnitResultFormatter, IgnoredT
/**
* @see JUnitResultFormatter#setSystemError(String)
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
@Override
public void setSystemError(String err) {
systemError = err;
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/junit/Enumerations.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/Enumerations.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/Enumerations.java
index 1ca4a0c..d965e4c 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/Enumerations.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/Enumerations.java
@@ -35,7 +35,8 @@ public final class Enumerations {
/**
* creates an enumeration from an array of objects.
- * @param array the array of object to enumerate.
+ * @param <T> object type
+ * @param array the array of object to enumerate.
* @return the enumeration over the array of objects.
*/
@SafeVarargs
@@ -44,11 +45,12 @@ public final class Enumerations {
}
/**
- * creates an enumeration from an array of enumeration. The created enumeration
- * will sequentially enumerate over all elements of each enumeration and skip
- * <tt>null</tt> enumeration elements in the array.
- * @param enums the array of enumerations.
- * @return the enumeration over the array of enumerations.
+ * creates an enumeration from an array of enumeration. The created enumeration
+ * will sequentially enumerate over all elements of each enumeration and skip
+ * <tt>null</tt> enumeration elements in the array.
+ * @param <T> object type
+ * @param enums the array of enumerations.
+ * @return the enumeration over the array of enumerations.
*/
@SafeVarargs
public static <T> Enumeration<T> fromCompound(Enumeration<? extends T>... enums) {
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/junit/FailureRecorder.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/FailureRecorder.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/FailureRecorder.java
index 26ef424..f2a570a 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/FailureRecorder.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/FailureRecorder.java
@@ -61,7 +61,7 @@ import org.apache.tools.ant.util.StringUtils;
* </pre>
*
* Because each running test case gets its own formatter, we collect
- * the failing test cases in a static list. Because we dont have a finalizer
+ * the failing test cases in a static list. Because we don't have a finalizer
* method in the formatters "lifecycle", we register this formatter as
* BuildListener and generate the new java source on taskFinished event.
*
@@ -171,8 +171,8 @@ public class FailureRecorder extends ProjectComponent implements JUnitResultForm
/**
* Add the failed test to the list.
- * @param test the test that errored.
- * @param throwable the reason it errored.
+ * @param test the test that erred.
+ * @param throwable the reason it erred.
* @see junit.framework.TestListener#addError(junit.framework.Test, java.lang.Throwable)
*/
@Override
@@ -437,7 +437,7 @@ public class FailureRecorder extends ProjectComponent implements JUnitResultForm
}
/**
- * The task outside of this JUnitResultFormatter is the <junit> task. So all tests passed
+ * The task outside of this JUnitResultFormatter is the <junit> task. So all tests passed
* and we could create the new java class.
* @param event not used
* @see org.apache.tools.ant.BuildListener#taskFinished(org.apache.tools.ant.BuildEvent)
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.java
index 81841a0..d76e06c 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.java
@@ -36,20 +36,21 @@ import org.apache.tools.ant.types.EnumeratedAttribute;
import org.apache.tools.ant.util.KeepAliveOutputStream;
/**
- * <p> A wrapper for the implementations of <code>JUnitResultFormatter</code>.
+ * <p>A wrapper for the implementations of <code>JUnitResultFormatter</code>.
* In particular, used as a nested <code><formatter></code> element in
- * a <code><junit></code> task.
- * <p> For example,
- * <code><pre>
+ * a <code><junit></code> task.</p>
+ *
+ * For example,
+ * <pre>
* <junit printsummary="no" haltonfailure="yes" fork="false">
* <formatter type="plain" usefile="false" />
* <test name="org.apache.ecs.InternationalCharTest" />
- * </junit></pre></code>
+ * </junit></pre>
* adds a <code>plain</code> type implementation
* (<code>PlainJUnitResultFormatter</code>) to display the results of the test.
*
- * <p> Either the <code>type</code> or the <code>classname</code> attribute
- * must be set.
+ * <p>Either the <code>type</code> or the <code>classname</code> attribute
+ * must be set.</p>
*
* @see JUnitTask
* @see XMLJUnitResultFormatter
@@ -87,18 +88,19 @@ public class FormatterElement {
private Project project;
/**
- * <p> Quick way to use a standard formatter.
+ * <p>Quick way to use a standard formatter.</p>
*
- * <p> At the moment, there are three supported standard formatters.
+ * <p>At the moment, there are three supported standard formatters.</p>
* <ul>
- * <li> The <code>xml</code> type uses a <code>XMLJUnitResultFormatter</code>.
- * <li> The <code>brief</code> type uses a <code>BriefJUnitResultFormatter</code>.
- * <li> The <code>plain</code> type (the default) uses a <code>PlainJUnitResultFormatter</code>.
- * <li> The <code>failure</code> type uses a <code>FailureRecorder</code>.
+ * <li>The <code>xml</code> type uses a <code>XMLJUnitResultFormatter</code>.</li>
+ * <li>The <code>brief</code> type uses a <code>BriefJUnitResultFormatter</code>.</li>
+ * <li>The <code>plain</code> type (the default) uses a <code>PlainJUnitResultFormatter</code>.</li>
+ * <li>The <code>failure</code> type uses a <code>FailureRecorder</code>.</li>
* </ul>
*
- * <p> Sets <code>classname</code> attribute - so you can't use that
- * attribute if you use this one.
+ * <p>Sets <code>classname</code> attribute - so you can't use that
+ * attribute if you use this one.</p>
+ *
* @param type the enumerated value to use.
*/
public void setType(TypeAttribute type) {
@@ -119,9 +121,9 @@ public class FormatterElement {
}
/**
- * <p> Set name of class to be used as the formatter.
+ * Set name of class to be used as the formatter.
+ * <p>This class must implement <code>JUnitResultFormatter</code></p>
*
- * <p> This class must implement <code>JUnitResultFormatter</code>
* @param classname the name of the formatter class.
*/
public void setClassname(String classname) {
@@ -166,18 +168,18 @@ public class FormatterElement {
}
/**
- * <p> Set the file which the formatte should log to.
+ * Set the file which the formatter should log to.
*
- * <p> Note that logging to file must be enabled .
+ * <p>Note that logging to file must be enabled.</p>
*/
void setOutfile(File out) {
this.outFile = out;
}
/**
- * <p> Set output stream for formatter to use.
+ * Set output stream for formatter to use.
*
- * <p> Defaults to standard out.
+ * <p>Defaults to standard out.</p>
* @param out the output stream to use.
*/
public void setOutput(OutputStream out) {
@@ -227,7 +229,7 @@ public class FormatterElement {
/**
* Set whether this formatter should NOT be used. It will be used
* if the expression evaluates to false or the name of a property
- * which has not been set, orthwise it will not be used.
+ * which has not been set, otherwise it will not be used.
* @param unlessCond name of property
* @since Ant 1.8.0
*/
@@ -238,7 +240,7 @@ public class FormatterElement {
/**
* Set whether this formatter should NOT be used. It will be used
* if the expression evaluates to false or the name of a property
- * which has not been set, orthwise it will not be used.
+ * which has not been set, otherwise it will not be used.
* @param unlessCond name of property
*/
public void setUnless(String unlessCond) {
@@ -322,7 +324,7 @@ public class FormatterElement {
Field field = r.getClass().getField("project");
Object value = field.get(r);
if (value instanceof Project) {
- // there is already a project reference so dont overwrite this
+ // there is already a project reference so don't overwrite this
needToSetProjectReference = false;
}
} catch (NoSuchFieldException e) {
@@ -349,9 +351,9 @@ public class FormatterElement {
}
/**
- * <p> Enumerated attribute with the values "plain", "xml", "brief" and "failure".
+ * Enumerated attribute with the values "plain", "xml", "brief" and "failure".
*
- * <p> Use to enumerate options for <code>type</code> attribute.
+ * <p>Use to enumerate options for <code>type</code> attribute.</p>
*/
public static class TypeAttribute extends EnumeratedAttribute {
/** {@inheritDoc}. */
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/junit/IgnoredTestListener.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/IgnoredTestListener.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/IgnoredTestListener.java
index 6741912..2c3103a 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/IgnoredTestListener.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/IgnoredTestListener.java
@@ -41,10 +41,10 @@ public interface IgnoredTestListener extends TestListener {
/**
* Receive a report that a test has failed an assumption. Within JUnit4
* this is normally treated as a test being skipped, although how any
- * listener handles this is up to that specific listener.<br />
- * <b>Note:</b> Tests that throw assumption failures will still report
+ * listener handles this is up to that specific listener.
+ * <p><b>Note:</b> Tests that throw assumption failures will still report
* the endTest method, which may differ from how the addError and addFailure
- * methods work, it's up for any implementing classes to handle this.
+ * methods work, it's up for any implementing classes to handle this.</p>
* @param test the details of the test and failure that have triggered this report.
* @param exception the AssumptionViolatedException thrown from the current assumption failure.
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.java
index d37337a..b1f4779 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.java
@@ -68,13 +68,13 @@ import org.apache.tools.ant.util.StringUtils;
/**
* Runs JUnit tests.
*
- * <p> JUnit is a framework to create unit tests. It has been initially
+ * <p>JUnit is a framework to create unit tests. It has been initially
* created by Erich Gamma and Kent Beck. JUnit can be found at <a
* href="http://www.junit.org">http://www.junit.org</a>.
*
- * <p> <code>JUnitTask</code> can run a single specific
+ * <p><code>JUnitTask</code> can run a single specific
* <code>JUnitTest</code> using the <code>test</code> element.</p>
- * For example, the following target <code><pre>
+ * For example, the following target <pre>
* <target name="test-int-chars" depends="jar-test">
* <echo message="testing international characters"/>
* <junit printsummary="no" haltonfailure="yes" fork="false">
@@ -83,19 +83,19 @@ import org.apache.tools.ant.util.StringUtils;
* <test name="org.apache.ecs.InternationalCharTest" />
* </junit>
* </target>
- * </pre></code>
+ * </pre>
* <p>runs a single junit test
* (<code>org.apache.ecs.InternationalCharTest</code>) in the current
* VM using the path with id <code>classpath</code> as classpath and
* presents the results formatted using the standard
* <code>plain</code> formatter on the command line.</p>
*
- * <p> This task can also run batches of tests. The
+ * <p>This task can also run batches of tests. The
* <code>batchtest</code> element creates a <code>BatchTest</code>
* based on a fileset. This allows, for example, all classes found in
* directory to be run as testcases.</p>
*
- * <p>For example,</p><code><pre>
+ * <p>For example,</p><pre>
* <target name="run-tests" depends="dump-info,compile-tests" if="junit.present">
* <junit printsummary="no" haltonfailure="yes" fork="${junit.fork}">
* <jvmarg value="-classic"/>
@@ -109,18 +109,18 @@ import org.apache.tools.ant.util.StringUtils;
* </batchtest>
* </junit>
* </target>
- * </pre></code>
+ * </pre>
* <p>this target finds any classes with a <code>test</code> directory
* anywhere in their path (under the top <code>${tests.dir}</code>, of
* course) and creates <code>JUnitTest</code>'s for each one.</p>
*
- * <p> Of course, <code><junit></code> and
+ * <p>Of course, <code><junit></code> and
* <code><batch></code> elements can be combined for more
* complex tests. For an example, see the ant <code>build.xml</code>
* target <code>run-tests</code> (the second example is an edited
* version).</p>
*
- * <p> To spawn a new Java VM to prevent interferences between
+ * <p>To spawn a new Java VM to prevent interferences between
* different testcases, you need to enable <code>fork</code>. A
* number of attributes and elements allow you to set up how this JVM
* runs.
@@ -220,7 +220,7 @@ public class JUnitTask extends Task {
* JUnitTest (test) however it can possibly be overridden by their
* own properties.</p>
* @param value <tt>false</tt> if it should not filter, otherwise
- * <tt>true<tt>
+ * <tt>true</tt>
*
* @since Ant 1.5
*/
@@ -335,6 +335,7 @@ public class JUnitTask extends Task {
* <p>This attribute will be ignored if tests run in the same VM
* as Ant.</p>
*
+ * @param threads int
* @since Ant 1.9.4
*/
public void setThreads(final int threads) {
@@ -348,11 +349,11 @@ public class JUnitTask extends Task {
* to also show standard output and error.
*
* Can take the values on, off, and withOutAndErr.
+ *
* @param value <tt>true</tt> to print a summary,
- * <tt>withOutAndErr</tt> to include the test's output as
+ * <tt>withOutAndErr</tt> to include the test's output as
* well, <tt>false</tt> otherwise.
* @see SummaryJUnitResultFormatter
- *
* @since Ant 1.2
*/
public void setPrintsummary(final SummaryAttribute value) {
@@ -366,7 +367,7 @@ public class JUnitTask extends Task {
public static class SummaryAttribute extends EnumeratedAttribute {
/**
* list the possible values
- * @return array of allowed values
+ * @return array of allowed values
*/
@Override
public String[] getValues() {
@@ -392,10 +393,10 @@ public class JUnitTask extends Task {
*
* <p>If the test is running for more than this value, the test
* will be canceled. (works only when in 'fork' mode).</p>
+ *
* @param value the maximum time (in milliseconds) allowed before
* declaring the test as 'timed-out'
* @see #setFork(boolean)
- *
* @since Ant 1.2
*/
public void setTimeout(final Integer value) {
@@ -404,9 +405,9 @@ public class JUnitTask extends Task {
/**
* Set the maximum memory to be used by all forked JVMs.
+ *
* @param max the value as defined by <tt>-mx</tt> or <tt>-Xmx</tt>
* in the java command line options.
- *
* @since Ant 1.2
*/
public void setMaxmemory(final String max) {
@@ -433,7 +434,6 @@ public class JUnitTask extends Task {
* @return create a new JVM argument so that any argument can be
* passed to the JVM.
* @see #setFork(boolean)
- *
* @since Ant 1.2
*/
public Commandline.Argument createJvmarg() {
@@ -442,9 +442,9 @@ public class JUnitTask extends Task {
/**
* The directory to invoke the VM in. Ignored if no JVM is forked.
+ *
* @param dir the directory to invoke the JVM from.
* @see #setFork(boolean)
- *
* @since Ant 1.2
*/
public void setDir(final File dir) {
@@ -457,7 +457,7 @@ public class JUnitTask extends Task {
* testcases when JVM forking is not enabled.
*
* @since Ant 1.3
- * @deprecated since ant 1.6
+ * @deprecated since Ant 1.6
* @param sysp environment variable to add
*/
@Deprecated
@@ -470,6 +470,7 @@ public class JUnitTask extends Task {
* Adds a system property that tests can access.
* This might be useful to transfer Ant properties to the
* testcases when JVM forking is not enabled.
+ *
* @param sysp new environment variable to add
* @since Ant 1.6
*/
@@ -485,8 +486,8 @@ public class JUnitTask extends Task {
* Adds a set of properties that will be used as system properties
* that tests can access.
*
- * This might be useful to transfer Ant properties to the
- * testcases when JVM forking is not enabled.
+ * <p>This might be useful to transfer Ant properties to the
+ * testcases when JVM forking is not enabled.</p>
*
* @param sysp set of properties to be added
* @since Ant 1.6
@@ -507,6 +508,7 @@ public class JUnitTask extends Task {
/**
* Adds a path to the bootclasspath.
+ *
* @return reference to the bootclasspath in the embedded java command line
* @since Ant 1.6
*/
@@ -538,6 +540,7 @@ public class JUnitTask extends Task {
* Adds an environment variable; used when forking.
*
* <p>Will be ignored if we are not forking a new VM.</p>
+ *
* @param var environment variable to be added
* @since Ant 1.5
*/
@@ -561,9 +564,11 @@ public class JUnitTask extends Task {
* Preset the attributes of the test
* before configuration in the build
* script.
- * This allows attributes in the <junit> task
+ * This allows attributes in the <junit> task
* be be defaults for the tests, but allows
* individual tests to override the defaults.
+ *
+ * @param test BaseTest
*/
private void preConfigure(final BaseTest test) {
test.setFiltertrace(filterTrace);
@@ -582,7 +587,6 @@ public class JUnitTask extends Task {
* Add a new single testcase.
* @param test a new single testcase
* @see JUnitTest
- *
* @since Ant 1.2
*/
public void addTest(final JUnitTest test) {
@@ -595,7 +599,6 @@ public class JUnitTask extends Task {
*
* @return a new instance of a batch test.
* @see BatchTest
- *
* @since Ant 1.2
*/
public BatchTest createBatchTest() {
@@ -657,6 +660,7 @@ public class JUnitTask extends Task {
* If true, write a single "FAILED" line for failed tests to Ant's
* log system.
*
+ * @param logFailedTests boolean
* @since Ant 1.8.0
*/
public void setLogFailedTests(final boolean logFailedTests) {
@@ -665,6 +669,7 @@ public class JUnitTask extends Task {
/**
* Assertions to enable in this program (if fork=true)
+ *
* @since Ant 1.6
* @param asserts assertion set
*/
@@ -677,8 +682,9 @@ public class JUnitTask extends Task {
/**
* Sets the permissions for the application run inside the same JVM.
+ *
* @since Ant 1.6
- * @return .
+ * @return Permissions
*/
public Permissions createPermissions() {
if (perm == null) {
@@ -693,6 +699,7 @@ public class JUnitTask extends Task {
* a bootclasspath.
*
* <p>Doesn't have any effect unless fork is true.</p>
+ *
* @param cloneVm a <code>boolean</code> value.
* @since Ant 1.7
*/
@@ -731,6 +738,7 @@ public class JUnitTask extends Task {
* <p>This value will be overridden by the magic property
* ant.junit.enabletestlistenerevents if it has been set.</p>
*
+ * @param b boolean
* @since Ant 1.8.2
*/
public void setEnableTestListenerEvents(final boolean b) {
@@ -739,6 +747,8 @@ public class JUnitTask extends Task {
/**
* Whether test listener events shall be generated.
+ *
+ * @return boolean
* @since Ant 1.8.2
*/
public boolean getEnableTestListenerEvents() {
@@ -1428,7 +1438,7 @@ public class JUnitTask extends Task {
* Will auto-delete on (graceful) exit.
* The file will be in the project basedir unless tmpDir declares
* something else.
- * @param prefix
+ * @param prefix String
* @return created file
*/
private File createTempPropertiesFile(final String prefix) {
@@ -2052,11 +2062,11 @@ public class JUnitTask extends Task {
/**
* constructor for forked test configuration
- * @param filterTrace
- * @param haltOnError
- * @param haltOnFailure
- * @param errorProperty
- * @param failureProperty
+ * @param filterTrace boolean
+ * @param haltOnError boolean
+ * @param haltOnFailure boolean
+ * @param errorProperty String
+ * @param failureProperty String
*/
ForkedTestConfiguration(final boolean filterTrace, final boolean haltOnError,
final boolean haltOnFailure, final String errorProperty,
@@ -2070,7 +2080,7 @@ public class JUnitTask extends Task {
/**
* configure from a test; sets member variables to attributes of the test
- * @param test
+ * @param test JUnitTest
*/
ForkedTestConfiguration(final JUnitTest test) {
this(test.getFiltertrace(),
@@ -2082,7 +2092,7 @@ public class JUnitTask extends Task {
/**
* equality test checks all the member variables
- * @param other
+ * @param other object to compare
* @return true if everything is equal
*/
@Override
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTest.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTest.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTest.java
index 2ec5653..d7889ba 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTest.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTest.java
@@ -27,10 +27,10 @@ import org.apache.tools.ant.Project;
import org.apache.tools.ant.PropertyHelper;
/**
- * <p> Run a single JUnit test.
+ * Run a single JUnit test.
*
- * <p> The JUnit test is actually run by {@link JUnitTestRunner}.
- * So read the doc comments for that class :)
+ * <p>The JUnit test is actually run by {@link JUnitTestRunner}.
+ * So read the doc comments for that class :)</p>
*
* @since Ant 1.2
*
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTestRunner.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTestRunner.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTestRunner.java
index 4009666..e9bd115 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTestRunner.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTestRunner.java
@@ -60,21 +60,21 @@ import org.apache.tools.ant.util.TeeOutputStream;
* <p>This TestRunner expects a name of a TestCase class as its
* argument. If this class provides a static suite() method it will be
* called and the resulting Test will be run. So, the signature should be
- * <pre><code>
+ * <pre>
* public static junit.framework.Test suite()
- * </code></pre>
+ * </pre>
*
- * <p> If no such method exists, all public methods starting with
- * "test" and taking no argument will be run.
+ * <p>If no such method exists, all public methods starting with
+ * "test" and taking no argument will be run.</p>
*
- * <p> Summary output is generated at the end.
+ * <p>Summary output is generated at the end.</p>
*
* @since Ant 1.2
*/
public class JUnitTestRunner implements TestListener, JUnitTaskMirror.JUnitTestRunnerMirror {
private static final String JUNIT_4_TEST_ADAPTER
- = "junit.framework.JUnit4TestAdapter";
+ = "junit.framework.JUnit4TestAdapter";
private static final String[] DEFAULT_TRACE_FILTERS = new String[] {
"junit.framework.TestCase",
@@ -287,6 +287,14 @@ public class JUnitTestRunner implements TestListener, JUnitTaskMirror.JUnitTestR
/**
* Constructor to use when the user has specified a classpath.
+ * @param test JUnitTest
+ * @param methods String[]
+ * @param haltOnError boolean
+ * @param filtertrace boolean
+ * @param haltOnFailure boolean
+ * @param showOutput boolean
+ * @param logTestListenerEvents boolean
+ * @param loader ClassLoader
* @since 1.8.2
*/
public JUnitTestRunner(final JUnitTest test, final String[] methods, final boolean haltOnError,
@@ -883,33 +891,38 @@ public class JUnitTestRunner implements TestListener, JUnitTaskMirror.JUnitTestR
/**
* Entry point for standalone (forked) mode.
- *
+ * <p>
* Parameters: testcaseclassname plus parameters in the format
* key=value, none of which is required.
- *
- * <table cols="4" border="1">
- * <tr><th>key</th><th>description</th><th>default value</th></tr>
- *
- * <tr><td>haltOnError</td><td>halt test on
- * errors?</td><td>false</td></tr>
- *
- * <tr><td>haltOnFailure</td><td>halt test on
- * failures?</td><td>false</td></tr>
- *
- * <tr><td>formatter</td><td>A JUnitResultFormatter given as
+ * </p>
+ * <table border="1">
+ * <caption>Test runner attributes</caption>
+ * <tr>
+ * <th>key</th><th>description</th><th>default value</th>
+ * </tr>
+ * <tr>
+ * <td>haltOnError</td><td>halt test on errors?</td><td>false</td>
+ * </tr>
+ * <tr>
+ * <td>haltOnFailure</td><td>halt test on failures?</td><td>false</td>
+ * </tr>
+ * <tr>
+ * <td>formatter</td><td>A JUnitResultFormatter given as
* classname,filename. If filename is omitted, System.out is
- * assumed.</td><td>none</td></tr>
- *
- * <tr><td>showoutput</td><td>send output to System.err/.out as
- * well as to the formatters?</td><td>false</td></tr>
- *
- * <tr><td>logtestlistenerevents</td><td>log TestListener events to
- * System.out.</td><td>false</td></tr>
- *
- * <tr><td>methods</td><td>Comma-separated list of names of individual
- * test methods to execute.
- * </td><td>null</td></tr>
- *
+ * assumed.</td><td>none</td>
+ * </tr>
+ * <tr>
+ * <td>showoutput</td><td>send output to System.err/.out as
+ * well as to the formatters?</td><td>false</td>
+ * </tr>
+ * <tr>
+ * <td>logtestlistenerevents</td><td>log TestListener events to
+ * System.out.</td><td>false</td>
+ * </tr>
+ * <tr>
+ * <td>methods</td><td>Comma-separated list of names of individual
+ * test methods to execute.</td><td>null</td>
+ * </tr>
* </table>
* @param args the command line arguments.
* @throws IOException on error.
@@ -1115,7 +1128,9 @@ public class JUnitTestRunner implements TestListener, JUnitTaskMirror.JUnitTestR
}
/**
- * Line format is: formatter=<classname>(,<pathname>)?
+ * Line format is: formatter=<classname>(,<pathname>)?
+ *
+ * @param line String
*/
private static void createAndStoreFormatter(final String line)
throws BuildException {
@@ -1328,4 +1343,4 @@ public class JUnitTestRunner implements TestListener, JUnitTaskMirror.JUnitTestR
return new int[] { failures, errors };
}
-} // JUnitTestRunner
+}
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/junit/PlainJUnitResultFormatter.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/PlainJUnitResultFormatter.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/PlainJUnitResultFormatter.java
index 85cfb0c..0d71cd2 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/PlainJUnitResultFormatter.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/PlainJUnitResultFormatter.java
@@ -327,4 +327,4 @@ public class PlainJUnitResultFormatter implements JUnitResultFormatter, IgnoredT
throw new BuildException("Unable to write output " + ex, ex);
}
}
-} // PlainJUnitResultFormatter
+}
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLConstants.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLConstants.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLConstants.java
index 03760cc..c29271d 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLConstants.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLConstants.java
@@ -18,16 +18,16 @@
package org.apache.tools.ant.taskdefs.optional.junit;
/**
- * <p> Interface groups XML constants.
+ * <p>Interface groups XML constants.
* Interface that groups all constants used throughout the <tt>XML</tt>
* documents that are generated by the <tt>XMLJUnitResultFormatter</tt>.
- * <p>
+ * </p>
* As of now the DTD is:
- * <code><pre>
+ * <pre>
* <!ELEMENT testsuites (testsuite*)>
*
* <!ELEMENT testsuite (properties, testcase*,
- * failure?, error?,
+ * failure?, error?,
* system-out?, system-err?)>
* <!ATTLIST testsuite name CDATA #REQUIRED>
* <!ATTLIST testsuite tests CDATA #REQUIRED>
@@ -61,7 +61,7 @@ package org.apache.tools.ant.taskdefs.optional.junit;
*
* <!ELEMENT system-out (#PCDATA)>
*
- * </pre></code>
+ * </pre>
* @see XMLJUnitResultFormatter
* @see XMLResultAggregator
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLJUnitResultFormatter.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLJUnitResultFormatter.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLJUnitResultFormatter.java
index d62a847..ed28220 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLJUnitResultFormatter.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLJUnitResultFormatter.java
@@ -54,7 +54,7 @@ public class XMLJUnitResultFormatter implements JUnitResultFormatter, XMLConstan
private static final double ONE_SECOND = 1000.0;
- /** constant for unnnamed testsuites/cases */
+ /** constant for unnamed testsuites/cases */
private static final String UNKNOWN = "unknown";
private static DocumentBuilder getDocumentBuilder() {
@@ -361,4 +361,4 @@ public class XMLJUnitResultFormatter implements JUnitResultFormatter, XMLConstan
skippedTests.put(createDescription(test), test);
}
-} // XMLJUnitResultFormatter
+}
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLResultAggregator.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLResultAggregator.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLResultAggregator.java
index b877c0b..71cd828 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLResultAggregator.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLResultAggregator.java
@@ -49,11 +49,11 @@ import org.xml.sax.SAXException;
* It is not particularly clean but
* should be helpful while I am thinking about another technique.
*
- * <p> The main problem is due to the fact that a JVM can be forked for a testcase
+ * <p>The main problem is due to the fact that a JVM can be forked for a testcase
* thus making it impossible to aggregate all testcases since the listener is
* (obviously) in the forked JVM. A solution could be to write a
* TestListener that will receive events from the TestRunner via sockets. This
- * is IMHO the simplest way to do it to avoid this file hacking thing.
+ * is IMHO the simplest way to do it to avoid this file hacking thing.</p>
*
* @ant.task name="junitreport" category="testing"
*/
@@ -108,7 +108,7 @@ public class XMLResultAggregator extends Task implements XMLConstants {
}
/**
- * Set the name of the aggregegated results file. It must be relative
+ * Set the name of the aggregated results file. It must be relative
* from the <tt>todir</tt> attribute. If not set it will use {@link #DEFAULT_FILENAME}
* @param value the name of the file.
* @see #setTodir(File)
@@ -215,7 +215,7 @@ public class XMLResultAggregator extends Task implements XMLConstants {
}
/**
- * <p> Create a DOM tree.
+ * Create a DOM tree.
* Has 'testsuites' as firstchild and aggregates all
* testsuite results that exists in the base directory.
* @return the root element of DOM tree that aggregates all testsuites.
@@ -271,11 +271,12 @@ public class XMLResultAggregator extends Task implements XMLConstants {
}
/**
- * <p> Add a new testsuite node to the document.
+ * <p>Add a new testsuite node to the document.
* The main difference is that it
- * split the previous fully qualified name into a package and a name.
- * <p> For example: <tt>org.apache.Whatever</tt> will be split into
- * <tt>org.apache</tt> and <tt>Whatever</tt>.
+ * split the previous fully qualified name into a package and a name.</p>
+ * <p>For example: <tt>org.apache.Whatever</tt> will be split into
+ * <tt>org.apache</tt> and <tt>Whatever</tt>.</p>
+ *
* @param root the root element to which the <tt>testsuite</tt> node should
* be appended.
* @param testsuite the element to append to the given root. It will slightly
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/native2ascii/DefaultNative2Ascii.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/native2ascii/DefaultNative2Ascii.java b/src/main/org/apache/tools/ant/taskdefs/optional/native2ascii/DefaultNative2Ascii.java
index 438bfe9..51ff3f9 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/native2ascii/DefaultNative2Ascii.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/native2ascii/DefaultNative2Ascii.java
@@ -25,7 +25,7 @@ import org.apache.tools.ant.taskdefs.optional.Native2Ascii;
import org.apache.tools.ant.types.Commandline;
/**
- * encapsulates the handling common to diffent Native2Asciiadapter
+ * encapsulates the handling common to different Native2AsciiAdapter
* implementations.
*
* @since Ant 1.6.3
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/net/FTP.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/net/FTP.java b/src/main/org/apache/tools/ant/taskdefs/optional/net/FTP.java
index 2a52390..72f45e0 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/net/FTP.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/net/FTP.java
@@ -60,13 +60,13 @@ import org.apache.tools.ant.util.VectorSet;
/**
* Basic FTP client. Performs the following actions:
* <ul>
- * <li> <strong>send</strong> - send files to a remote server. This is the
+ * <li><strong>send</strong> - send files to a remote server. This is the
* default action.</li>
- * <li> <strong>get</strong> - retrieve files from a remote server.</li>
- * <li> <strong>del</strong> - delete files from a remote server.</li>
- * <li> <strong>list</strong> - create a file listing.</li>
- * <li> <strong>chmod</strong> - change unix file permissions.</li>
- * <li> <strong>rmdir</strong> - remove directories, if empty, from a
+ * <li><strong>get</strong> - retrieve files from a remote server.</li>
+ * <li><strong>del</strong> - delete files from a remote server.</li>
+ * <li><strong>list</strong> - create a file listing.</li>
+ * <li><strong>chmod</strong> - change unix file permissions.</li>
+ * <li><strong>rmdir</strong> - remove directories, if empty, from a
* remote server.</li>
* </ul>
* <strong>Note:</strong> Some FTP servers - notably the Solaris server - seem
@@ -190,7 +190,7 @@ public class FTP extends Task implements FTPTaskConfig {
/**
* creates a proxy to a FTP file
- * @param file
+ * @param file FTPFile
*/
public FTPFileProxy(FTPFile file) {
super(file.getName());
@@ -585,7 +585,7 @@ public class FTP extends Task implements FTPTaskConfig {
* @param name path of the directory relative to the directory of
* the fileset
* @param file directory as file
- * @param fast
+ * @param fast boolean
*/
private void accountForIncludedDir(String name, AntFTPFile file, boolean fast) {
if (!dirsIncluded.contains(name)
@@ -861,7 +861,7 @@ public class FTP extends Task implements FTPTaskConfig {
}
/**
- * find a file in a directory in case unsensitive way
+ * find a file in a directory in case insensitive way
* @param parentPath where we are
* @param soughtPathElement what is being sought
* @return the first file found or null if not found
@@ -1689,6 +1689,7 @@ public class FTP extends Task implements FTPTaskConfig {
* Whether to verify that data and control connections are
* connected to the same remote host.
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setEnableRemoteVerification(boolean b) {
@@ -1744,7 +1745,7 @@ public class FTP extends Task implements FTPTaskConfig {
* Executable a retryable object.
* @param h the retry handler.
* @param r the object that should be retried until it succeeds
- * or the number of retrys is reached.
+ * or the number of retries is reached.
* @param descr a description of the command that is being run.
* @throws IOException if there is a problem.
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/net/FTPTask.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/net/FTPTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/net/FTPTask.java
index 2e5228d..c96d16a 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/net/FTPTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/net/FTPTask.java
@@ -717,6 +717,7 @@ public class FTPTask extends Task implements FTPTaskConfig {
* Whether to verify that data and control connections are
* connected to the same remote host.
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setEnableRemoteVerification(boolean b) {
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.java b/src/main/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.java
index f546b23..817345c 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.java
@@ -93,7 +93,7 @@ public class FTPTaskMirrorImpl implements FTPTaskMirror {
/**
* creates a proxy to a FTP file
- * @param file
+ * @param file FTPFile
*/
public FTPFileProxy(FTPFile file) {
super(file.getName());
@@ -478,7 +478,7 @@ public class FTPTaskMirrorImpl implements FTPTaskMirror {
* @param name path of the directory relative to the directory of
* the fileset
* @param file directory as file
- * @param fast
+ * @param fast boolean
*/
private void accountForIncludedDir(String name, AntFTPFile file, boolean fast) {
if (!dirsIncluded.contains(name)
@@ -761,7 +761,7 @@ public class FTPTaskMirrorImpl implements FTPTaskMirror {
this.ftpFile = getFile(theFiles, lastpathelement);
}
/**
- * find a file in a directory in case unsensitive way
+ * find a file in a directory in case insensitive way
* @param parentPath where we are
* @param soughtPathElement what is being sought
* @return the first file found or null if not found
@@ -1117,7 +1117,7 @@ public class FTPTaskMirrorImpl implements FTPTaskMirror {
* Executable a retryable object.
* @param h the retry handler.
* @param r the object that should be retried until it succeeds
- * or the number of retrys is reached.
+ * or the number of retries is reached.
* @param descr a description of the command that is being run.
* @throws IOException if there is a problem.
*/
@@ -1640,7 +1640,7 @@ public class FTPTaskMirrorImpl implements FTPTaskMirror {
* Retrieve a single file from the remote host. <code>filename</code> may
* contain a relative path specification. <p>
*
- * The file will then be retreived using the entire relative path spec -
+ * The file will then be retrieved using the entire relative path spec -
* no attempt is made to change directories. It is anticipated that this
* may eventually cause problems with some FTP servers, but it simplifies
* the coding.</p>
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java b/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java
index 9d844a1..1492ae5 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java
@@ -46,11 +46,11 @@ import org.apache.tools.ant.util.FileUtils;
* Extracts the latest edition of the source code from a PVCS repository.
* PVCS is a version control system
* developed by <a href="http://www.merant.com/products/pvcs">Merant</a>.
- * <br>
+ * <p>
* Before using this tag, the user running ant must have access to the commands
* of PVCS (get and pcli) and must have access to the repository. Note that the way to specify
* the repository is platform dependent so use property to specify location of repository.
- * <br>
+ * </p>
* This version has been tested against PVCS version 6.5 and 6.6 under Windows and Solaris.
*
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/script/ScriptDef.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/script/ScriptDef.java b/src/main/org/apache/tools/ant/taskdefs/optional/script/ScriptDef.java
index 35d873c..4aad07b 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/script/ScriptDef.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/script/ScriptDef.java
@@ -367,7 +367,7 @@ public class ScriptDef extends DefBase {
}
/**
- * Defines the compilation feature ; optional.
+ * Defines the compilation feature; optional.
*
* @param compiled enables the script compilation if available.
* @since Ant 1.10.2
@@ -377,7 +377,7 @@ public class ScriptDef extends DefBase {
}
/**
- * Loads the script from an external file ; optional.
+ * Loads the script from an external file; optional.
*
* @param file the file containing the script source.
*/
@@ -386,7 +386,7 @@ public class ScriptDef extends DefBase {
}
/**
- * Sets the encoding of the script from an external file ; optional.
+ * Sets the encoding of the script from an external file; optional.
*
* @param encoding the encoding of the file containing the script source.
* @since Ant 1.10.2
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOS.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOS.java b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOS.java
index 66e0eb2..c9b462d 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOS.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOS.java
@@ -403,9 +403,9 @@ public abstract class SOS extends Task implements SOSCmd {
/**
* Execute the created command line.
*
- * @param cmd The command line to run.
- * @return int the exit code.
- * @throws BuildException
+ * @param cmd The command line to run.
+ * @return int the exit code.
+ * @throws BuildException if something goes wrong
*/
protected int run(Commandline cmd) {
try {
@@ -440,7 +440,7 @@ public abstract class SOS extends Task implements SOSCmd {
commandLine.createArgument().setValue(FLAG_USERNAME);
commandLine.createArgument().setValue(getUsername());
// The SOS class knows that the SOS server needs the password flag,
- // even if there is no password ,so we send a " "
+ // even if there is no password, so we send a " "
commandLine.createArgument().setValue(FLAG_PASSWORD);
commandLine.createArgument().setValue(getPassword());
// VSS Info is required
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckin.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckin.java b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckin.java
index 3a82ea4..fe8bd0e 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckin.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckin.java
@@ -56,8 +56,8 @@ public class SOSCheckin extends SOS {
}
/**
- * Build the command line. <p>
- *
+ * Build the command line.
+ * <p>
* CheckInFile required parameters: -server -name -password -database -project
* -file<br>
* CheckInFile optional parameters: -workdir -log -verbose -nocache -nocompression
@@ -65,7 +65,8 @@ public class SOSCheckin extends SOS {
* CheckInProject required parameters: -server -name -password -database
* -project<br>
* CheckInProject optional parameters: workdir -recursive -log -verbose
- * -nocache -nocompression -soshome<br>
+ * -nocache -nocompression -soshome
+ * </p>
*
* @return Commandline the generated command to be executed
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckout.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckout.java b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckout.java
index a7b23c5..447be0e 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckout.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckout.java
@@ -47,14 +47,15 @@ public class SOSCheckout extends SOS {
}
/**
- * Build the command line <br>
- *
+ * Build the command line
+ * <p>
* CheckOutFile required parameters: -server -name -password -database -project -file<br>
* CheckOutFile optional parameters: -workdir -verbose -nocache -nocompression -soshome<br>
*
* CheckOutProject required parameters: -server -name -password -database -project<br>
* CheckOutProject optional parameters:-workdir -recursive -verbose -nocache
- * -nocompression -soshome<br>
+ * -nocompression -soshome
+ * </p>
*
* @return Commandline the generated command to be executed
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSGet.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSGet.java b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSGet.java
index b17e0c1..c55165e 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSGet.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSGet.java
@@ -67,14 +67,15 @@ public class SOSGet extends SOS {
}
/**
- * Build the command line <br>
- *
+ * Build the command line
+ * <p>
* GetFile required parameters: -server -name -password -database -project -file<br>
* GetFile optional parameters: -workdir -revision -verbose -nocache -nocompression -soshome<br>
*
* GetProject required parameters: -server -name -password -database -project<br>
* GetProject optional parameters: -label -workdir -recursive -verbose -nocache
- * -nocompression -soshome<br>
+ * -nocompression -soshome
+ * </p>
*
* @return Commandline the generated command to be executed
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSLabel.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSLabel.java b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSLabel.java
index 0b41105..79cb11d 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSLabel.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSLabel.java
@@ -57,9 +57,11 @@ public class SOSLabel extends SOS {
}
/**
- * Build the command line <br>
- * AddLabel required parameters: -server -name -password -database -project -label<br>
- * AddLabel optional parameters: -verbose -comment<br>
+ * Build the command line
+ * <p>
+ * AddLabel required parameters: -server -name -password -database -project -label<br>
+ * AddLabel optional parameters: -verbose -comment
+ * </p>
*
* @return Commandline the generated command to be executed
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/sos/package.html
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/sos/package.html b/src/main/org/apache/tools/ant/taskdefs/optional/sos/package.html
index a0538c2..401c7d7 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/sos/package.html
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/sos/package.html
@@ -20,10 +20,10 @@
Ant tasks for working with a SourceOffSite source control system.
</p>
<p>
- The <SOSGet> Retreives file(s) from a SOS database<br>
- The <SOSCheckin> Commits and unlocks file(s) in a SOS database<br>
- The <SOSCheckout> Retreives and lock file(s) in a SOS database<br>
- The <SOSLabel> Label a SOS database<br>
+ The <SOSGet> Retrieves file(s) from a SOS database<br/>
+ The <SOSCheckin> Commits and unlocks file(s) in a SOS database<br/>
+ The <SOSCheckout> Retrieves and lock file(s) in a SOS database<br/>
+ The <SOSLabel> Label a SOS database
</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.java b/src/main/org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.java
index 1a26fa4..d564eb4 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.java
@@ -66,7 +66,7 @@ public abstract class AbstractSshMessage {
/**
* Constructor for AbstractSshMessage
* @param verbose if true do verbose logging
- * @param compression if true use compression
+ * @param compressed if true use compression
* @param session the ssh session to use
* @since Ant 1.9.8
*/
@@ -211,7 +211,7 @@ public abstract class AbstractSshMessage {
}
/**
- * Track progress every 10% if 100kb < filesize < 1mb. For larger
+ * Track progress every 10% if 100kb < filesize < 1Mb. For larger
* files track progress for every percent transmitted.
* @param filesize the size of the file been transmitted
* @param totalLength the total transmission size
@@ -285,6 +285,7 @@ public abstract class AbstractSshMessage {
public void end() {
}
+ @SuppressWarnings("unused")
public long getTotalLength() {
return totalLength;
}