* If the argument is not supported, returns -1. Else, the position of the
* first argument not supported.
+ *
+ *
+ * @param args String[]
+ * @param pos int
+ * @return int
*/
int readArguments(String[] args, int pos);
@@ -45,12 +50,18 @@ public interface ArgumentProcessor {
* this method is called after all arguments were parsed. Returns
* true if Ant should stop there, ie the build file not parsed
* and the project should not be executed.
+ *
+ * @param args List<String>
+ * @return boolean
*/
boolean handleArg(List args);
/**
* If some arguments matched with {@link #readArguments(String[], int)},
* this method is called just before the project being configured
+ *
+ * @param project Project
+ * @param args List<String>
*/
void prepareConfigure(Project project, List args);
@@ -59,12 +70,17 @@ public interface ArgumentProcessor {
* after the project being configured. Returns true if Ant
* should stop there, ie the build file not parsed and the project should
* not be executed.
+ *
+ * @param project Project
+ * @param arg List<String>
+ * @return boolean
*/
boolean handleArg(Project project, List arg);
/**
* Print the usage of the supported arguments
*
+ * @param writer PrintStream
* @see org.apache.tools.ant.Main#printUsage()
*/
void printUsage(PrintStream writer);
diff --git a/src/main/org/apache/tools/ant/BuildException.java b/src/main/org/apache/tools/ant/BuildException.java
index 7e85ca9e6..442071fb7 100644
--- a/src/main/org/apache/tools/ant/BuildException.java
+++ b/src/main/org/apache/tools/ant/BuildException.java
@@ -49,7 +49,7 @@ public class BuildException extends RuntimeException {
*
* @param pattern A description of or information about the exception.
* Should not be {@code null}.
- * @param formatArguments
+ * @param formatArguments ditto
* @see String#format(String, Object...)
* @since Ant 1.10.2
*/
diff --git a/src/main/org/apache/tools/ant/ComponentHelper.java b/src/main/org/apache/tools/ant/ComponentHelper.java
index c772d1b94..74e7af0e6 100644
--- a/src/main/org/apache/tools/ant/ComponentHelper.java
+++ b/src/main/org/apache/tools/ant/ComponentHelper.java
@@ -53,7 +53,7 @@ import org.apache.tools.ant.util.FileUtils;
*
* A very simple hook mechanism is provided that allows users to plug
* in custom code. It is also possible to replace the default behavior
- * ( for example in an app embedding ant )
+ * (for example in an app embedding Ant)
*
* @since Ant1.6
*/
@@ -201,7 +201,7 @@ public class ComponentHelper {
}
/**
- * @return A deep copy of the restrictredDefinition
+ * @return A deep copy of the restrictedDefinition
*/
private Map> getRestrictedDefinition() {
final Map> result = new HashMap<>();
diff --git a/src/main/org/apache/tools/ant/Diagnostics.java b/src/main/org/apache/tools/ant/Diagnostics.java
index b1a07ca1f..9f1aa0cd7 100644
--- a/src/main/org/apache/tools/ant/Diagnostics.java
+++ b/src/main/org/apache/tools/ant/Diagnostics.java
@@ -272,7 +272,7 @@ public final class Diagnostics {
/**
* ignore exceptions. This is to allow future
* implementations to log at a verbose level
- * @param thrown
+ * @param thrown a Throwable to ignore
*/
private static void ignoreThrowable(Throwable thrown) {
}
@@ -368,7 +368,7 @@ public final class Diagnostics {
/**
* Get the value of a system property. If a security manager
* blocks access to a property it fills the result in with an error
- * @param key
+ * @param key a property key
* @return the system property's value or error text
* @see #ERROR_PROPERTY_ACCESS_BLOCKED
*/
@@ -514,7 +514,7 @@ public final class Diagnostics {
/**
* tell the user about the XML parser
- * @param out
+ * @param out a PrintStream
*/
private static void doReportParserInfo(PrintStream out) {
String parserName = getXMLParserName();
@@ -526,7 +526,7 @@ public final class Diagnostics {
/**
* tell the user about the XSLT processor
- * @param out
+ * @param out a PrintStream
*/
private static void doReportXSLTProcessorInfo(PrintStream out) {
String processorName = getXSLTProcessorName();
@@ -550,7 +550,7 @@ public final class Diagnostics {
* try and create a temp file in our temp dir; this
* checks that it has space and access.
* We also do some clock reporting.
- * @param out
+ * @param out a PrintStream
*/
private static void doReportTempDir(PrintStream out) {
String tempdir = System.getProperty("java.io.tmpdir");
diff --git a/src/main/org/apache/tools/ant/DirectoryScanner.java b/src/main/org/apache/tools/ant/DirectoryScanner.java
index f4c26f6c6..dc79d5323 100644
--- a/src/main/org/apache/tools/ant/DirectoryScanner.java
+++ b/src/main/org/apache/tools/ant/DirectoryScanner.java
@@ -55,6 +55,7 @@ import org.apache.tools.ant.util.VectorSet;
* With the selectors you can select which files you want to have included.
* Files which are not selected are excluded. With patterns you can include
* or exclude files based on their filename.
+ *
*
* The idea is simple. A given directory is recursively scanned for all files
* and directories. Each file/directory is matched against a set of selectors,
@@ -63,11 +64,13 @@ import org.apache.tools.ant.util.VectorSet;
* pattern of the include pattern list or other file selector, and don't match
* any pattern of the exclude pattern list or fail to match against a required
* selector will be placed in the list of files/directories found.
+ *
*
* When no list of include patterns is supplied, "**" will be used, which
* means that everything will be matched. When no list of exclude patterns is
* supplied, an empty list is used, such that nothing will be excluded. When
* no selectors are supplied, none are applied.
+ *
*
* The filename pattern matching is done as follows:
* The name to be matched is split up in path segments. A path segment is the
@@ -76,41 +79,54 @@ import org.apache.tools.ant.util.VectorSet;
* For example, "abc/def/ghi/xyz.java" is split up in the segments "abc",
* "def","ghi" and "xyz.java".
* The same is done for the pattern against which should be matched.
+ *
*
* The segments of the name and the pattern are then matched against each
* other. When '**' is used for a path segment in the pattern, it matches
* zero or more path segments of the name.
+ *
*
* There is a special case regarding the use of File.separators
- * at the beginning of the pattern and the string to match:
- * When a pattern starts with a File.separator, the string
- * to match must also start with a File.separator.
- * When a pattern does not start with a File.separator, the
- * string to match may not start with a File.separator.
- * When one of these rules is not obeyed, the string will not
- * match.
+ * at the beginning of the pattern and the string to match:
+ *
+ *
+ *
When a pattern starts with a File.separator, the string
+ * to match must also start with a File.separator.
+ *
When a pattern does not start with a File.separator, the
+ * string to match may not start with a File.separator.
+ *
When one of the above rules is not obeyed, the string will not
+ * match.
+ *
*
* When a name path segment is matched against a pattern path segment, the
* following special characters can be used:
* '*' matches zero or more characters
* '?' matches one character.
+ *
*
* Examples:
+ *
*
* "**\*.class" matches all .class files/dirs in a directory tree.
+ *
*
* "test\a??.java" matches all files/dirs which start with an 'a', then two
* more characters and then ".java", in a directory called test.
+ *
*
* "**" matches everything in a directory tree.
+ *
*
* "**\test\**\XYZ*" matches all files/dirs which start with "XYZ" and where
* there is a parent directory called test (e.g. "abc\test\def\ghi\XYZ123").
+ *
*
* Case sensitivity may be turned off if necessary. By default, it is
* turned on.
+ *
*
* Example of usage:
+ *
*
* String[] includes = {"**\\*.class"};
* String[] excludes = {"modules\\*\\**"};
@@ -702,6 +718,7 @@ public class DirectoryScanner
* The maximum number of times a symbolic link may be followed
* during a scan.
*
+ * @param max int
* @since Ant 1.8.0
*/
public void setMaxLevelsOfSymlinks(final int max) {
@@ -785,7 +802,7 @@ public class DirectoryScanner
* File.separatorChar, so the separator used need not
* match File.separatorChar.
*
- *
When a pattern ends with a '/' or '\', "**" is appended.
+ *
When a pattern ends with a '/' or '\', "**" is appended.
*
* @since Ant 1.6.3
*/
@@ -1371,7 +1388,7 @@ public class DirectoryScanner
* Test whether or not a name matches against at least one include
* pattern.
*
- * @param name The name to match. Must not be null.
+ * @param path The tokenized path to match. Must not be null.
* @return true when the name matches against at least one
* include pattern, or false otherwise.
*/
diff --git a/src/main/org/apache/tools/ant/IntrospectionHelper.java b/src/main/org/apache/tools/ant/IntrospectionHelper.java
index 59ddbb752..9b6b09e43 100644
--- a/src/main/org/apache/tools/ant/IntrospectionHelper.java
+++ b/src/main/org/apache/tools/ant/IntrospectionHelper.java
@@ -812,7 +812,7 @@ public final class IntrospectionHelper {
* Helper method to extract the inner fault from an {@link InvocationTargetException}, and turn
* it into a BuildException. If it is already a BuildException, it is type cast and returned; if
* not a new BuildException is created containing the child as nested text.
- * @param ite
+ * @param ite the exception
* @return the nested exception
*/
private static BuildException extractBuildException(final InvocationTargetException ite) {
@@ -1539,7 +1539,7 @@ public final class IntrospectionHelper {
* @param elementName name of the element
* @return a nested creator, or null if there is no component of the given name, or it
* has no matching add type methods
- * @throws BuildException
+ * @throws BuildException if something goes wrong
*/
private NestedCreator createAddTypeCreator(
final Project project, final Object parent, final String elementName) throws BuildException {
diff --git a/src/main/org/apache/tools/ant/MagicNames.java b/src/main/org/apache/tools/ant/MagicNames.java
index cfd4cc769..5457e6287 100644
--- a/src/main/org/apache/tools/ant/MagicNames.java
+++ b/src/main/org/apache/tools/ant/MagicNames.java
@@ -258,7 +258,7 @@ public final class MagicNames {
/**
* Name of the project reference holding an instance of {@link
* org.apache.tools.ant.taskdefs.launcher.CommandLauncher} to use
- * when executing commands with the help of an external skript.
+ * when executing commands with the help of an external script.
*
*
Alternatively this is the name of a system property holding
* the fully qualified class name of a {@link
@@ -272,7 +272,7 @@ public final class MagicNames {
/**
* Name of the project reference holding an instance of {@link
* org.apache.tools.ant.taskdefs.launcher.CommandLauncher} to use
- * when executing commands without the help of an external skript.
+ * when executing commands without the help of an external script.
*
*
Alternatively this is the name of a system property holding
* the fully qualified class name of a {@link
diff --git a/src/main/org/apache/tools/ant/Main.java b/src/main/org/apache/tools/ant/Main.java
index b745f2afd..7e0f09d99 100644
--- a/src/main/org/apache/tools/ant/Main.java
+++ b/src/main/org/apache/tools/ant/Main.java
@@ -1267,9 +1267,6 @@ public class Main implements AntMain {
* no descriptions are displayed.
* If non-null, this should have
* as many elements as names.
- * @param topDependencies The list of dependencies for each target.
- * The dependencies are listed as a non null
- * enumeration of String.
* @param heading The heading to display.
* Should not be null.
* @param maxlen The maximum length of the names of the targets.
diff --git a/src/main/org/apache/tools/ant/Project.java b/src/main/org/apache/tools/ant/Project.java
index 23799bc88..d2d9545fe 100644
--- a/src/main/org/apache/tools/ant/Project.java
+++ b/src/main/org/apache/tools/ant/Project.java
@@ -882,7 +882,7 @@ public class Project implements ResourceFactory {
/**
* Set "keep-going" mode. In this mode Ant will try to execute
* as many targets as possible. All targets that do not depend
- * on failed target(s) will be executed. If the keepGoing settor/getter
+ * on failed target(s) will be executed. If the keepGoing setter/getter
* methods are used in conjunction with the ant.executor.class
* property, they will have no effect.
* @param keepGoingMode "keep-going" mode
@@ -893,7 +893,7 @@ public class Project implements ResourceFactory {
}
/**
- * Return the keep-going mode. If the keepGoing settor/getter
+ * Return the keep-going mode. If the keepGoing setter/getter
* methods are used in conjunction with the ant.executor.class
* property, they will have no effect.
* @return "keep-going" mode
@@ -1797,13 +1797,13 @@ public class Project implements ResourceFactory {
/**
* Topologically sort a set of targets.
*
- * @param root String[] containing the names of the root targets.
- * The sort is created in such a way that the ordered sequence of
- * Targets is the minimum possible such sequence to the specified
- * root targets.
- * Must not be null.
+ * @param roots String[] containing the names of the root targets.
+ * The sort is created in such a way that the ordered sequence of
+ * Targets is the minimum possible such sequence to the specified
+ * root targets.
+ * Must not be null.
* @param targetTable A map of names to targets (String to Target).
- * Must not be null.
+ * Must not be null.
* @param returnAll boolean indicating whether to return all
* targets, or the execution sequence only.
* @return a Vector of Target objects in sorted order.
@@ -1811,7 +1811,7 @@ public class Project implements ResourceFactory {
* targets, or if a named target does not exist.
* @since Ant 1.6.3
*/
- public final Vector topoSort(final String[] root, final Hashtable targetTable,
+ public final Vector topoSort(final String[] roots, final Hashtable targetTable,
final boolean returnAll) throws BuildException {
final Vector ret = new VectorSet<>();
final Hashtable state = new Hashtable<>();
@@ -1825,19 +1825,19 @@ public class Project implements ResourceFactory {
// dependency tree, not just on the Targets that depend on the
// build Target.
- for (int i = 0; i < root.length; i++) {
- final String st = state.get(root[i]);
+ for (int i = 0; i < roots.length; i++) {
+ final String st = state.get(roots[i]);
if (st == null) {
- tsort(root[i], targetTable, state, visiting, ret);
+ tsort(roots[i], targetTable, state, visiting, ret);
} else if (st == VISITING) {
throw new BuildException("Unexpected node in visiting state: "
- + root[i]);
+ + roots[i]);
}
}
final StringBuilder buf = new StringBuilder("Build sequence for target(s)");
- for (int j = 0; j < root.length; j++) {
- buf.append((j == 0) ? " `" : ", `").append(root[j]).append('\'');
+ for (int j = 0; j < roots.length; j++) {
+ buf.append((j == 0) ? " `" : ", `").append(roots[j]).append('\'');
}
buf.append(" is ").append(ret);
log(buf.toString(), MSG_VERBOSE);
@@ -2013,6 +2013,8 @@ public class Project implements ResourceFactory {
/**
* Does the project know this reference?
*
+ * @param key String
+ * @return boolean
* @since Ant 1.8.0
*/
public boolean hasReference(final String key) {
@@ -2035,6 +2037,7 @@ public class Project implements ResourceFactory {
/**
* Look up a reference by its key (ID).
*
+ * @param desired type
* @param key The key for the desired reference.
* Must not be null.
*
diff --git a/src/main/org/apache/tools/ant/ProjectComponent.java b/src/main/org/apache/tools/ant/ProjectComponent.java
index 451dbed14..8c8feac0d 100644
--- a/src/main/org/apache/tools/ant/ProjectComponent.java
+++ b/src/main/org/apache/tools/ant/ProjectComponent.java
@@ -146,7 +146,7 @@ public abstract class ProjectComponent implements Cloneable {
getProject().log(msg, msgLevel);
} else {
// 'reasonable' default, if the component is used without
- // a Project ( for example as a standalone Bean ).
+ // a Project (for example as a standalone Bean).
// Most ant components can be used this way.
if (msgLevel <= Project.MSG_INFO) {
System.err.println(msg);
diff --git a/src/main/org/apache/tools/ant/ProjectHelper.java b/src/main/org/apache/tools/ant/ProjectHelper.java
index 0b5194604..93f5576c5 100644
--- a/src/main/org/apache/tools/ant/ProjectHelper.java
+++ b/src/main/org/apache/tools/ant/ProjectHelper.java
@@ -147,8 +147,8 @@ public class ProjectHelper {
}
// -------------------- Common properties --------------------
- // The following properties are required by import ( and other tasks
- // that read build files using ProjectHelper ).
+ // The following properties are required by import (and other tasks
+ // that read build files using ProjectHelper).
private Vector
*
+ * @return boolean
* @since Ant 1.8.0
*/
public static boolean isInIncludeMode() {
@@ -256,6 +260,7 @@ public class ProjectHelper {
* Sets whether the current file should be read in include as
* opposed to import mode.
*
+ * @param includeMode boolean
* @since Ant 1.8.0
*/
public static void setInIncludeMode(boolean includeMode) {
@@ -587,6 +592,8 @@ public class ProjectHelper {
*
*
This implementation returns false.
*
+ * @param r Resource
+ * @return boolean
* @since Ant 1.8.0
*/
public boolean canParseAntlibDescriptor(Resource r) {
@@ -597,6 +604,9 @@ public class ProjectHelper {
* Parse the given URL as an antlib descriptor and return the
* content as something that can be turned into an Antlib task.
*
+ * @param containingProject Project
+ * @param source Resource
+ * @return UnknownElement
* @since ant 1.8.0
*/
public UnknownElement parseAntlibDescriptor(Project containingProject,
diff --git a/src/main/org/apache/tools/ant/ProjectHelperRepository.java b/src/main/org/apache/tools/ant/ProjectHelperRepository.java
index a11c05a8b..cd2e7dbbb 100644
--- a/src/main/org/apache/tools/ant/ProjectHelperRepository.java
+++ b/src/main/org/apache/tools/ant/ProjectHelperRepository.java
@@ -80,7 +80,7 @@ public class ProjectHelperRepository {
Constructor extends ProjectHelper> projectHelper = getProjectHelperBySystemProperty();
registerProjectHelper(projectHelper);
- // A JDK1.3 'service' ( like in JAXP ). That will plug a helper
+ // A JDK1.3 'service' (like in JAXP). That will plug a helper
// automatically if in CLASSPATH, with the right META-INF/services.
try {
ClassLoader classLoader = LoaderUtils.getContextClassLoader();
@@ -249,6 +249,7 @@ public class ProjectHelperRepository {
* Get the helper that will be able to parse the specified build file. The helper
* will be chosen among the ones found in the classpath
*
+ * @param buildFile Resource
* @return the first ProjectHelper that fit the requirement (never null).
*/
public ProjectHelper getProjectHelperForBuildFile(Resource buildFile) throws BuildException {
@@ -272,6 +273,7 @@ public class ProjectHelperRepository {
* Get the helper that will be able to parse the specified antlib. The helper
* will be chosen among the ones found in the classpath
*
+ * @param antlib Resource
* @return the first ProjectHelper that fit the requirement (never null).
*/
public ProjectHelper getProjectHelperForAntlib(Resource antlib) throws BuildException {
diff --git a/src/main/org/apache/tools/ant/PropertyHelper.java b/src/main/org/apache/tools/ant/PropertyHelper.java
index 84121c918..4449fcbac 100644
--- a/src/main/org/apache/tools/ant/PropertyHelper.java
+++ b/src/main/org/apache/tools/ant/PropertyHelper.java
@@ -70,7 +70,7 @@ import org.apache.tools.ant.property.PropertyExpander;
* parseProperties} inside the ParseProperties class which in turn
* uses the {@link org.apache.tools.ant.property.PropertyExpander
* PropertyExpander delegates} to find properties inside the string
- * and this class to expand the propertiy names found into the
+ * and this class to expand the property names found into the
* corresponding values.
*
*
When {@link #getProperty looking up a property value} this class
@@ -1098,6 +1098,7 @@ public class PropertyHelper implements GetProperty {
/**
* Get the Collection of delegates of the specified type.
*
+ * @param desired type.
* @param type
* delegate type.
* @return Collection.
@@ -1136,6 +1137,8 @@ public class PropertyHelper implements GetProperty {
/**
* If the given object can be interpreted as a true/false value,
* turn it into a matching Boolean - otherwise return null.
+ * @param value Object
+ * @return Boolean
* @since Ant 1.8.0
*/
public static Boolean toBoolean(Object value) {
@@ -1159,6 +1162,8 @@ public class PropertyHelper implements GetProperty {
/**
* Returns true if the object is null or an empty string.
*
+ * @param value Object
+ * @return boolean
* @since Ant 1.8.0
*/
private static boolean nullOrEmpty(Object value) {
@@ -1170,6 +1175,8 @@ public class PropertyHelper implements GetProperty {
* Returns true if the value can be interpreted as a true value or
* cannot be interpreted as a false value and a property of the
* value's name exists.
+ * @param value Object
+ * @return boolean
* @since Ant 1.8.0
*/
private boolean evalAsBooleanOrPropertyName(Object value) {
@@ -1184,6 +1191,8 @@ public class PropertyHelper implements GetProperty {
* Returns true if the value is null or an empty string, can be
* interpreted as a true value or cannot be interpreted as a false
* value and a property of the value's name exists.
+ * @param value Object
+ * @return boolean
* @since Ant 1.8.0
*/
public boolean testIfCondition(Object value) {
@@ -1194,6 +1203,8 @@ public class PropertyHelper implements GetProperty {
* Returns true if the value is null or an empty string, can be
* interpreted as a false value or cannot be interpreted as a true
* value and a property of the value's name doesn't exist.
+ * @param value Object
+ * @return boolean
* @since Ant 1.8.0
*/
public boolean testUnlessCondition(Object value) {
diff --git a/src/main/org/apache/tools/ant/RuntimeConfigurable.java b/src/main/org/apache/tools/ant/RuntimeConfigurable.java
index 8e54d8c04..2fb91738e 100644
--- a/src/main/org/apache/tools/ant/RuntimeConfigurable.java
+++ b/src/main/org/apache/tools/ant/RuntimeConfigurable.java
@@ -69,7 +69,7 @@ public class RuntimeConfigurable implements Serializable {
private transient boolean namespacedAttribute = false;
/** Attribute names and values. While the XML spec doesn't require
- * preserving the order ( AFAIK ), some ant tests do rely on the
+ * preserving the order (AFAIK), some ant tests do rely on the
* exact order.
* The only exception to this order is the treatment of
* refid. A number of datatypes check if refid is set
@@ -171,7 +171,7 @@ public class RuntimeConfigurable implements Serializable {
* are any Ant attributes, and if so, the method calls the
* isEnabled() method on them.
* @param owner the UE that owns this RC.
- * @return true if enabled, false if any of the ant attribures return
+ * @return true if enabled, false if any of the ant attributes return
* false.
* @since 1.9.1
*/
@@ -266,10 +266,11 @@ public class RuntimeConfigurable implements Serializable {
/**
* Sets the attributes for the wrapped element.
*
- * @deprecated since 1.6.x.
* @param attributes List of attributes defined in the XML for this
* element. May be null.
+ * @deprecated since 1.6.x.
*/
+ @Deprecated
public synchronized void setAttributes(AttributeList attributes) {
this.attributes = new AttributeListImpl(attributes);
for (int i = 0; i < attributes.getLength(); i++) {
@@ -340,10 +341,11 @@ public class RuntimeConfigurable implements Serializable {
/**
* Returns the list of attributes for the wrapped element.
*
- * @deprecated Deprecated since Ant 1.6 in favor of {@link #getAttributeMap}.
* @return An AttributeList representing the attributes defined in the
* XML for this element. May be null.
+ * @deprecated Deprecated since Ant 1.6 in favor of {@link #getAttributeMap}.
*/
+ @Deprecated
public synchronized AttributeList getAttributes() {
return attributes;
}
@@ -414,7 +416,7 @@ public class RuntimeConfigurable implements Serializable {
/**
* Get the text content of this element. Various text chunks are
- * concatenated, there is no way ( currently ) of keeping track of
+ * concatenated, there is no way (currently) of keeping track of
* multiple fragments.
*
* @return the text content of this element.
@@ -448,9 +450,10 @@ public class RuntimeConfigurable implements Serializable {
* and then each child is configured and added. Each time the
* wrapper is configured, the attributes and text for it are
* reset.
- *
+ *
* If the element has an id attribute, a reference
* is added to the project as well.
+ *
*
* @param p The project containing the wrapped element.
* Must not be null.
@@ -467,18 +470,18 @@ public class RuntimeConfigurable implements Serializable {
* Configures the wrapped element. The attributes and text for
* the wrapped element are configured. Each time the wrapper is
* configured, the attributes and text for it are reset.
- *
+ *
* If the element has an id attribute, a reference
* is added to the project as well.
+ *
*
* @param p The project containing the wrapped element.
* Must not be null.
*
* @param configureChildren ignored.
-
*
* @exception BuildException if the configuration fails, for instance due
- * to invalid attributes , or text being added to
+ * to invalid attributes, or text being added to
* an element which doesn't accept it.
*/
public synchronized void maybeConfigure(Project p, boolean configureChildren)
@@ -539,7 +542,7 @@ public class RuntimeConfigurable implements Serializable {
} catch (BuildException be) {
if ("id".equals(name)) {
// Assume that this is an not supported attribute type
- // thrown for example by a dymanic attribute task
+ // thrown for example by a dynamic attribute task
// Do nothing
} else {
throw be;
diff --git a/src/main/org/apache/tools/ant/Target.java b/src/main/org/apache/tools/ant/Target.java
index d48d97194..a57d3b056 100644
--- a/src/main/org/apache/tools/ant/Target.java
+++ b/src/main/org/apache/tools/ant/Target.java
@@ -306,6 +306,7 @@ public class Target implements TaskContainer {
/**
* Same as {@link #setIf(String)} but requires a {@link Condition} instance
*
+ * @param condition Condition
* @since 1.9
*/
public void setIf(Condition condition) {
@@ -358,6 +359,7 @@ public class Target implements TaskContainer {
/**
* Same as {@link #setUnless(String)} but requires a {@link Condition} instance
*
+ * @param condition Condition
* @since 1.9
*/
public void setUnless(Condition condition) {
diff --git a/src/main/org/apache/tools/ant/TaskAdapter.java b/src/main/org/apache/tools/ant/TaskAdapter.java
index 8a22f3537..567bc81fd 100644
--- a/src/main/org/apache/tools/ant/TaskAdapter.java
+++ b/src/main/org/apache/tools/ant/TaskAdapter.java
@@ -44,7 +44,7 @@ public class TaskAdapter extends Task implements TypeAdapter {
* Constructor for given proxy.
* So you could write easier code
*
*
* @param proxy The object which Ant should use as task.
diff --git a/src/main/org/apache/tools/ant/TaskConfigurationChecker.java b/src/main/org/apache/tools/ant/TaskConfigurationChecker.java
index 70ccd8076..942b2dc72 100644
--- a/src/main/org/apache/tools/ant/TaskConfigurationChecker.java
+++ b/src/main/org/apache/tools/ant/TaskConfigurationChecker.java
@@ -94,7 +94,7 @@ public class TaskConfigurationChecker {
*/
public void checkErrors() throws BuildException {
if (!errors.isEmpty()) {
- StringBuilder sb = new StringBuilder("Configurationerror on <");
+ StringBuilder sb = new StringBuilder("Configuration error on <");
sb.append(task.getTaskName());
sb.append(">:");
sb.append(System.getProperty("line.separator"));
diff --git a/src/main/org/apache/tools/ant/dispatch/DispatchTask.java b/src/main/org/apache/tools/ant/dispatch/DispatchTask.java
index 66eb96f4e..4d19c3d59 100644
--- a/src/main/org/apache/tools/ant/dispatch/DispatchTask.java
+++ b/src/main/org/apache/tools/ant/dispatch/DispatchTask.java
@@ -23,8 +23,7 @@ import org.apache.tools.ant.Task;
* Tasks extending this class may contain multiple actions.
* The method that is invoked for execution depends upon the
* value of the action attribute of the task.
- *
- * Example:
+ *
Example:
* <mytask action="list"/> will invoke the method
* with the signature public void list() in mytask's class.
* If the action attribute is not defined in the task or is empty,
diff --git a/src/main/org/apache/tools/ant/filters/BaseParamFilterReader.java b/src/main/org/apache/tools/ant/filters/BaseParamFilterReader.java
index 54bc9ff92..f3a8e5e03 100644
--- a/src/main/org/apache/tools/ant/filters/BaseParamFilterReader.java
+++ b/src/main/org/apache/tools/ant/filters/BaseParamFilterReader.java
@@ -58,7 +58,7 @@ public abstract class BaseParamFilterReader
* @param parameters The parameters to be used by this filter.
* Should not be null.
*/
- public final void setParameters(final Parameter[] parameters) {
+ public final void setParameters(final Parameter... parameters) {
this.parameters = parameters;
setInitialized(false);
}
diff --git a/src/main/org/apache/tools/ant/filters/ClassConstants.java b/src/main/org/apache/tools/ant/filters/ClassConstants.java
index 354430123..b6894f96a 100644
--- a/src/main/org/apache/tools/ant/filters/ClassConstants.java
+++ b/src/main/org/apache/tools/ant/filters/ClassConstants.java
@@ -29,8 +29,7 @@ import org.apache.tools.ant.util.ResourceUtils;
* Assembles the constants declared in a Java class in
* key1=value1(line separator)key2=value2
* format.
- *
- * Notes:
+ *
Notes:
*
*
This filter uses the BCEL external toolkit.
*
This assembles only those constants that are not created
@@ -39,7 +38,7 @@ import org.apache.tools.ant.util.ResourceUtils;
* and String only.
*
The access modifiers of the declared constants do not matter.
*
- * Example:
+ *
Example:
*
<classconstants/>
* Or:
*
<filterreader
diff --git a/src/main/org/apache/tools/ant/filters/ExpandProperties.java b/src/main/org/apache/tools/ant/filters/ExpandProperties.java
index 524a799b1..48d9ffe19 100644
--- a/src/main/org/apache/tools/ant/filters/ExpandProperties.java
+++ b/src/main/org/apache/tools/ant/filters/ExpandProperties.java
@@ -30,8 +30,7 @@ import org.apache.tools.ant.types.PropertySet;
/**
* Expands Ant properties, if any, in the data.
- *
- * Example:
+ *
Example:
*
<expandproperties/>
* Or:
*
<filterreader
diff --git a/src/main/org/apache/tools/ant/filters/FixCrLfFilter.java b/src/main/org/apache/tools/ant/filters/FixCrLfFilter.java
index 8a37924c7..b5a0ad2c3 100644
--- a/src/main/org/apache/tools/ant/filters/FixCrLfFilter.java
+++ b/src/main/org/apache/tools/ant/filters/FixCrLfFilter.java
@@ -29,13 +29,14 @@ import org.apache.tools.ant.types.EnumeratedAttribute;
* damaged by misconfigured or misguided editors or file transfer programs.
*
* This filter can take the following arguments:
+ *
*
- *
eof
- *
eol
- *
fixlast
- *
javafiles
- *
tab
- *
tablength
+ *
eof
+ *
eol
+ *
fixlast
+ *
javafiles
+ *
tab
+ *
tablength
*
* None of which are required.
*
@@ -44,6 +45,7 @@ import org.apache.tools.ant.types.EnumeratedAttribute;
* handling has also been generalised to accommodate any tabwidth from 2 to 80,
* inclusive. Importantly, it can leave untouched any literal TAB characters
* embedded within Java string or character constants.
+ *
*
* Caution: run with care on carefully formatted files. This may
* sound obvious, but if you don't specify asis, presume that your files are
@@ -53,22 +55,19 @@ import org.apache.tools.ant.types.EnumeratedAttribute;
* cr="add" can result in CR characters being removed in one special case
* accommodated, i.e., CRCRLF is regarded as a single EOL to handle cases where
* other programs have converted CRLF into CRCRLF.
- *
- *
- *
*/
public final class FixCrLfFilter extends BaseParamFilterReader implements ChainableReader {
private static final int DEFAULT_TAB_LENGTH = 8;
@@ -946,8 +945,8 @@ public final class FixCrLfFilter extends BaseParamFilterReader implements Chaina
/**
* @see EnumeratedAttribute#getValues
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public String[] getValues() {
return new String[] {"asis", "cr", "lf", "crlf", "mac", "unix", "dos"};
}
diff --git a/src/main/org/apache/tools/ant/filters/LineContainsRegExp.java b/src/main/org/apache/tools/ant/filters/LineContainsRegExp.java
index 4b7f53e36..4e836ef68 100644
--- a/src/main/org/apache/tools/ant/filters/LineContainsRegExp.java
+++ b/src/main/org/apache/tools/ant/filters/LineContainsRegExp.java
@@ -204,7 +204,8 @@ public final class LineContainsRegExp
}
/**
- * Whether to match casesensitevly.
+ * Whether to match casesensitively.
+ * @param b boolean
* @since Ant 1.8.2
*/
public void setCaseSensitive(boolean b) {
@@ -221,6 +222,7 @@ public final class LineContainsRegExp
/**
* Set the regular expression as an attribute.
+ * @param pattern String
* @since Ant 1.10.2
*/
public void setRegexp(String pattern) {
diff --git a/src/main/org/apache/tools/ant/filters/ReplaceTokens.java b/src/main/org/apache/tools/ant/filters/ReplaceTokens.java
index bcbc312cd..f033b6f81 100644
--- a/src/main/org/apache/tools/ant/filters/ReplaceTokens.java
+++ b/src/main/org/apache/tools/ant/filters/ReplaceTokens.java
@@ -217,6 +217,7 @@ public final class ReplaceTokens
* A resource containing properties, each of which is interpreted
* as a token/value pair.
*
+ * @param r Resource
* @since Ant 1.8.0
*/
public void setPropertiesResource(Resource r) {
diff --git a/src/main/org/apache/tools/ant/filters/SortFilter.java b/src/main/org/apache/tools/ant/filters/SortFilter.java
index 44e8d72ed..056ad6a74 100644
--- a/src/main/org/apache/tools/ant/filters/SortFilter.java
+++ b/src/main/org/apache/tools/ant/filters/SortFilter.java
@@ -82,10 +82,10 @@ import org.apache.tools.ant.types.Parameter;
*
*
* Sort all files *.txt from src location using as
- * sorting criterium EvenFirstCmp class, that sorts the file
+ * sorting criterion EvenFirstCmp class, that sorts the file
* lines putting even lines first then odd lines for example. The modified files
* are copied into build location. The EvenFirstCmp,
- * has to an instanciable class via Class.newInstance(),
+ * has to an instantiable class via Class.newInstance(),
* therefore in case of inner class has to be static. It also has to
* implement java.util.Comparator interface, for example:
*
If parameter comparator is present, then
- * reverse parameter will not be taken into account.
+ *
If parameter comparator is present, then
+ * reverse parameter will not be taken into account.
*
* @since Ant 1.8.0
*/
@@ -285,7 +285,7 @@ public final class SortFilter extends BaseParamFilterReader
}
/**
- * Set the comparator to be used as sorting criterium.
+ * Set the comparator to be used as sorting criterion.
*
* @param comparator
* the comparator to set
diff --git a/src/main/org/apache/tools/ant/filters/util/ChainReaderHelper.java b/src/main/org/apache/tools/ant/filters/util/ChainReaderHelper.java
index 67694ac51..5294f3609 100644
--- a/src/main/org/apache/tools/ant/filters/util/ChainReaderHelper.java
+++ b/src/main/org/apache/tools/ant/filters/util/ChainReaderHelper.java
@@ -110,9 +110,9 @@ public final class ChainReaderHelper {
/**
* Convenience constructor.
- * @param project
- * @param primaryReader
- * @param filterChains
+ * @param project ditto
+ * @param primaryReader ditto
+ * @param filterChains ditto
*/
public ChainReaderHelper(Project project, Reader primaryReader,
Iterable filterChains) {
@@ -130,7 +130,7 @@ public final class ChainReaderHelper {
/**
* Fluent primary {@link Reader} mutator.
- * @param rdr
+ * @param rdr Reader
* @return {@code this}
*/
public ChainReaderHelper withPrimaryReader(Reader rdr) {
@@ -148,7 +148,7 @@ public final class ChainReaderHelper {
/**
* Fluent {@link Project} mutator.
- * @param project
+ * @param project ditto
* @return {@code this}
*/
public ChainReaderHelper withProject(Project project) {
@@ -176,7 +176,7 @@ public final class ChainReaderHelper {
/**
* Fluent buffer size mutator.
- * @param size
+ * @param size ditto
* @return {@code this}
*/
public ChainReaderHelper withBufferSize(int size) {
@@ -195,7 +195,7 @@ public final class ChainReaderHelper {
/**
* Fluent {@code filterChains} mutator.
- * @param filterChains
+ * @param filterChains ditto
* @return {@code this}
*/
public ChainReaderHelper withFilterChains(Iterable filterChains) {
@@ -212,7 +212,7 @@ public final class ChainReaderHelper {
/**
* Fluent mechanism to apply some {@link Consumer}.
- * @param consumer
+ * @param consumer ditto
* @return {@code this}
*/
public ChainReaderHelper with(Consumer consumer) {
diff --git a/src/main/org/apache/tools/ant/helper/AntXMLContext.java b/src/main/org/apache/tools/ant/helper/AntXMLContext.java
index 99e3d1a1e..a6b1ed19b 100644
--- a/src/main/org/apache/tools/ant/helper/AntXMLContext.java
+++ b/src/main/org/apache/tools/ant/helper/AntXMLContext.java
@@ -84,14 +84,14 @@ public class AntXMLContext {
*/
private Target implicitTarget = new Target();
- /** Current target ( no need for a stack as the processing model
- allows only one level of target ) */
+ /** Current target (no need for a stack as the processing model
+ allows only one level of target) */
private Target currentTarget = null;
/** The stack of RuntimeConfigurable2 wrapping the
objects.
*/
- private Vector wStack = new Vector();
+ private Vector wStack = new Vector<>();
/**
* Indicates whether the project tag attributes are to be ignored
@@ -138,7 +138,8 @@ public class AntXMLContext {
/**
* sets the build file to which the XML context belongs
- * @param buildFile ant build file
+ * @param buildFile Ant build file
+ * @throws MalformedURLException if parent URL cannot be constructed
* @since Ant 1.8.0
*/
public void setBuildFile(URL buildFile) throws MalformedURLException {
@@ -151,7 +152,7 @@ public class AntXMLContext {
/**
* find out the build file
- * @return the build file to which the xml context belongs
+ * @return the build file to which the XML context belongs
*/
public File getBuildFile() {
return buildFile;
@@ -167,7 +168,7 @@ public class AntXMLContext {
/**
* find out the build file
- * @return the build file to which the xml context belongs
+ * @return the build file to which the xml context belongs
* @since Ant 1.8.0
*/
public URL getBuildFileURL() {
diff --git a/src/main/org/apache/tools/ant/helper/ProjectHelper2.java b/src/main/org/apache/tools/ant/helper/ProjectHelper2.java
index 313763a6c..268869d3f 100644
--- a/src/main/org/apache/tools/ant/helper/ProjectHelper2.java
+++ b/src/main/org/apache/tools/ant/helper/ProjectHelper2.java
@@ -486,8 +486,8 @@ public class ProjectHelper2 extends ProjectHelper {
/**
* Handler for ant processing. Uses a stack of AntHandlers to
- * implement each element ( the original parser used a recursive behavior,
- * with the implicit execution stack )
+ * implement each element (the original parser used a recursive behavior,
+ * with the implicit execution stack)
*/
public static class RootHandler extends DefaultHandler {
private Stack antHandlers = new Stack();
@@ -718,11 +718,11 @@ public class ProjectHelper2 extends ProjectHelper {
* too 'involved' in the processing. A better solution (IMO)
* would be to create UE for Project and Target too, and
* then process the tree and have Project/Target deal with
- * its attributes ( similar with Description ).
+ * its attributes (similar with Description).
*
- * If we eventually switch to ( or add support for ) DOM,
+ * If we eventually switch to (or add support for) DOM,
* things will work smoothly - UE can be avoided almost completely
- * ( it could still be created on demand, for backward compatibility )
+ * (it could still be created on demand, for backward compatibility)
*/
for (int i = 0; i < attrs.getLength(); i++) {
@@ -772,7 +772,7 @@ public class ProjectHelper2 extends ProjectHelper {
}
}
- // TODO Move to Project ( so it is shared by all helpers )
+ // TODO Move to Project (so it is shared by all helpers)
String antFileProp =
MagicNames.ANT_FILE + "." + context.getCurrentProjectName();
String dup = project.getProperty(antFileProp);
@@ -1097,7 +1097,7 @@ public class ProjectHelper2 extends ProjectHelper {
}
/**
- * Handler for all project elements ( tasks, data types )
+ * Handler for all project elements (tasks, data types)
*/
public static class ElementHandler extends AntHandler {
@@ -1153,7 +1153,7 @@ public class ProjectHelper2 extends ProjectHelper {
// Nested element
((UnknownElement) parent).addChild(task);
} else {
- // Task included in a target ( including the default one ).
+ // Task included in a target (including the default one).
context.getCurrentTarget().addTask(task);
}
diff --git a/src/main/org/apache/tools/ant/helper/ProjectHelperImpl.java b/src/main/org/apache/tools/ant/helper/ProjectHelperImpl.java
index dcd2b1826..bb7a8bbc2 100644
--- a/src/main/org/apache/tools/ant/helper/ProjectHelperImpl.java
+++ b/src/main/org/apache/tools/ant/helper/ProjectHelperImpl.java
@@ -188,8 +188,8 @@ public class ProjectHelperImpl extends ProjectHelper {
protected DocumentHandler parentHandler;
/** Helper impl. With non-static internal classes, the compiler will generate
- this automatically - but this will fail with some compilers ( reporting
- "Expecting to find object/array on stack" ). If we pass it
+ this automatically - but this will fail with some compilers (reporting
+ "Expecting to find object/array on stack"). If we pass it
explicitly it'll work with more compilers.
*/
ProjectHelperImpl helperImpl;
diff --git a/src/main/org/apache/tools/ant/helper/SingleCheckExecutor.java b/src/main/org/apache/tools/ant/helper/SingleCheckExecutor.java
index 1960ed033..6577c941a 100644
--- a/src/main/org/apache/tools/ant/helper/SingleCheckExecutor.java
+++ b/src/main/org/apache/tools/ant/helper/SingleCheckExecutor.java
@@ -18,12 +18,10 @@
package org.apache.tools.ant.helper;
-
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Executor;
import org.apache.tools.ant.Project;
-
/**
* "Single-check" Target executor implementation.
* Differs from {@link DefaultExecutor} in that the dependencies for all
diff --git a/src/main/org/apache/tools/ant/launch/Launcher.java b/src/main/org/apache/tools/ant/launch/Launcher.java
index e41628b66..8033f4ee8 100644
--- a/src/main/org/apache/tools/ant/launch/Launcher.java
+++ b/src/main/org/apache/tools/ant/launch/Launcher.java
@@ -58,10 +58,9 @@ public class Launcher {
/**
* The location of a per-user library directory.
- *
- * It's value is the concatenation of {@link #ANT_PRIVATEDIR}
+ *
It's value is the concatenation of {@link #ANT_PRIVATEDIR}
* with {@link #ANT_PRIVATELIB}, with an appropriate file separator
- * in between. For example, on Unix, it's .ant/lib.
+ * in between. For example, on Unix, it's .ant/lib.
*/
public static final String USER_LIBDIR =
ANT_PRIVATEDIR + File.separatorChar + ANT_PRIVATELIB;
diff --git a/src/main/org/apache/tools/ant/launch/Locator.java b/src/main/org/apache/tools/ant/launch/Locator.java
index 436d5f01d..5f0e289cc 100644
--- a/src/main/org/apache/tools/ant/launch/Locator.java
+++ b/src/main/org/apache/tools/ant/launch/Locator.java
@@ -378,14 +378,14 @@ public final class Locator {
* File.toURL() does not encode characters like #.
* File.toURI() has been introduced in java 1.4, so
* Ant cannot use it (except by reflection)
- * FileUtils.toURI() cannot be used by Locator.java
+ * File.toURI() cannot be used by Locator.java
* Implemented this way.
* File.toURL() adds file: and changes '\' to '/' for dos OSes
* encodeURI converts characters like ' ' and '#' to %DD
* @param file the file to convert
* @return URL the converted File
* @throws MalformedURLException on error
- * @deprecated since 1.9, use {@link FileUtils#getFileURL(File)}
+ * @deprecated since 1.9, use FileUtils.getFileURL(File)
*/
@Deprecated
public static URL fileToURL(File file)
diff --git a/src/main/org/apache/tools/ant/listener/AnsiColorLogger.java b/src/main/org/apache/tools/ant/listener/AnsiColorLogger.java
index 9370f8706..f99ca3b36 100644
--- a/src/main/org/apache/tools/ant/listener/AnsiColorLogger.java
+++ b/src/main/org/apache/tools/ant/listener/AnsiColorLogger.java
@@ -201,8 +201,8 @@ public class AnsiColorLogger extends DefaultLogger {
/**
* @see DefaultLogger#printMessage
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
@Override
protected void printMessage(final String message,
final PrintStream stream,
diff --git a/src/main/org/apache/tools/ant/listener/BigProjectLogger.java b/src/main/org/apache/tools/ant/listener/BigProjectLogger.java
index 865127d29..7d618bcf2 100644
--- a/src/main/org/apache/tools/ant/listener/BigProjectLogger.java
+++ b/src/main/org/apache/tools/ant/listener/BigProjectLogger.java
@@ -75,7 +75,7 @@ public class BigProjectLogger extends SimpleBigProjectLogger
/**
* {@inheritDoc}
*
- * @param event
+ * @param event BuildEvent
*/
public void targetStarted(BuildEvent event) {
maybeRaiseSubBuildStarted(event);
@@ -85,7 +85,7 @@ public class BigProjectLogger extends SimpleBigProjectLogger
/**
* {@inheritDoc}
*
- * @param event
+ * @param event BuildEvent
*/
public void taskStarted(BuildEvent event) {
maybeRaiseSubBuildStarted(event);
@@ -95,7 +95,7 @@ public class BigProjectLogger extends SimpleBigProjectLogger
/**
* {@inheritDoc}
*
- * @param event
+ * @param event BuildEvent
*/
public void buildFinished(BuildEvent event) {
maybeRaiseSubBuildStarted(event);
@@ -106,7 +106,7 @@ public class BigProjectLogger extends SimpleBigProjectLogger
/**
* {@inheritDoc}
*
- * @param event
+ * @param event BuildEvent
*/
public void messageLogged(BuildEvent event) {
maybeRaiseSubBuildStarted(event);
diff --git a/src/main/org/apache/tools/ant/listener/CommonsLoggingListener.java b/src/main/org/apache/tools/ant/listener/CommonsLoggingListener.java
index 2890b8213..bd0702553 100644
--- a/src/main/org/apache/tools/ant/listener/CommonsLoggingListener.java
+++ b/src/main/org/apache/tools/ant/listener/CommonsLoggingListener.java
@@ -130,8 +130,8 @@ public class CommonsLoggingListener implements BuildListener, BuildLogger {
/**
* @see BuildListener#targetStarted
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
@Override
public void targetStarted(final BuildEvent event) {
if (initialized) {
@@ -146,8 +146,8 @@ public class CommonsLoggingListener implements BuildListener, BuildLogger {
/**
* @see BuildListener#targetFinished
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
@Override
public void targetFinished(final BuildEvent event) {
if (initialized) {
@@ -166,8 +166,8 @@ public class CommonsLoggingListener implements BuildListener, BuildLogger {
/**
* @see BuildListener#taskStarted
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
@Override
public void taskStarted(final BuildEvent event) {
if (initialized) {
@@ -189,8 +189,8 @@ public class CommonsLoggingListener implements BuildListener, BuildLogger {
/**
* @see BuildListener#taskFinished
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
@Override
public void taskFinished(final BuildEvent event) {
if (initialized) {
@@ -219,8 +219,8 @@ public class CommonsLoggingListener implements BuildListener, BuildLogger {
/**
* @see BuildListener#messageLogged
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
@Override
public void messageLogged(final BuildEvent event) {
if (initialized) {
diff --git a/src/main/org/apache/tools/ant/listener/Log4jListener.java b/src/main/org/apache/tools/ant/listener/Log4jListener.java
index 82102283f..b25ad1cf0 100644
--- a/src/main/org/apache/tools/ant/listener/Log4jListener.java
+++ b/src/main/org/apache/tools/ant/listener/Log4jListener.java
@@ -55,8 +55,8 @@ public class Log4jListener implements BuildListener {
/**
* @see BuildListener#buildStarted
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
@Override
public void buildStarted(final BuildEvent event) {
if (initialized) {
@@ -67,8 +67,8 @@ public class Log4jListener implements BuildListener {
/**
* @see BuildListener#buildFinished
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
@Override
public void buildFinished(final BuildEvent event) {
if (initialized) {
@@ -83,8 +83,8 @@ public class Log4jListener implements BuildListener {
/**
* @see BuildListener#targetStarted
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
@Override
public void targetStarted(final BuildEvent event) {
if (initialized) {
@@ -95,8 +95,8 @@ public class Log4jListener implements BuildListener {
/**
* @see BuildListener#targetFinished
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
@Override
public void targetFinished(final BuildEvent event) {
if (initialized) {
@@ -113,8 +113,8 @@ public class Log4jListener implements BuildListener {
/**
* @see BuildListener#taskStarted
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
@Override
public void taskStarted(final BuildEvent event) {
if (initialized) {
@@ -126,8 +126,8 @@ public class Log4jListener implements BuildListener {
/**
* @see BuildListener#taskFinished
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
@Override
public void taskFinished(final BuildEvent event) {
if (initialized) {
@@ -144,8 +144,8 @@ public class Log4jListener implements BuildListener {
/**
* @see BuildListener#messageLogged
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
@Override
public void messageLogged(final BuildEvent event) {
if (initialized) {
diff --git a/src/main/org/apache/tools/ant/listener/MailLogger.java b/src/main/org/apache/tools/ant/listener/MailLogger.java
index cff2073cf..9462e25ea 100644
--- a/src/main/org/apache/tools/ant/listener/MailLogger.java
+++ b/src/main/org/apache/tools/ant/listener/MailLogger.java
@@ -328,8 +328,6 @@ public class MailLogger extends DefaultLogger {
* @param defaultValue value returned if not present in the properties.
* Set to null to make required.
* @return The value of the property, or default value.
- * @exception Exception thrown if no default value is specified and the
- * property is not present in properties.
*/
private String getValue(Map properties, String name,
String defaultValue) {
diff --git a/src/main/org/apache/tools/ant/taskdefs/AbstractCvsTask.java b/src/main/org/apache/tools/ant/taskdefs/AbstractCvsTask.java
index e5fa4dd5f..c55c3930b 100644
--- a/src/main/org/apache/tools/ant/taskdefs/AbstractCvsTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/AbstractCvsTask.java
@@ -38,17 +38,18 @@ import org.apache.tools.ant.util.StringUtils;
/**
* original Cvs.java 1.20
- *
- * NOTE: This implementation has been moved here from Cvs.java with
- * the addition of some accessors for extensibility. Another task
- * can extend this with some customized output processing.
+ *
+ * NOTE: This implementation has been moved here from Cvs.java with
+ * the addition of some accessors for extensibility. Another task
+ * can extend this with some customized output processing.
+ *
*
* @since Ant 1.5
*/
public abstract class AbstractCvsTask extends Task {
/**
* Default compression level to use, if compression is enabled via
- * setCompression( true ).
+ * setCompression(true).
*/
public static final int DEFAULT_COMPRESSION_LEVEL = 3;
private static final int MAXIMUM_COMRESSION_LEVEL = 9;
@@ -74,14 +75,17 @@ public abstract class AbstractCvsTask extends Task {
* the package/module to check out.
*/
private String cvsPackage;
+
/**
* the tag
*/
private String tag;
+
/**
* the default command.
*/
private static final String DEFAULT_COMMAND = "checkout";
+
/**
* the CVS command to execute.
*/
@@ -122,7 +126,9 @@ public abstract class AbstractCvsTask extends Task {
*/
private File dest;
- /** whether or not to append stdout/stderr to existing files */
+ /**
+ * whether or not to append stdout/stderr to existing files
+ */
private boolean append = false;
/**
@@ -830,6 +836,7 @@ public abstract class AbstractCvsTask extends Task {
/**
* add a named module/package.
*
+ * @param m Module
* @since Ant 1.8.0
*/
public void addModule(Module m) {
diff --git a/src/main/org/apache/tools/ant/taskdefs/AbstractJarSignerTask.java b/src/main/org/apache/tools/ant/taskdefs/AbstractJarSignerTask.java
index 6fda2838b..2fadd12bf 100644
--- a/src/main/org/apache/tools/ant/taskdefs/AbstractJarSignerTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/AbstractJarSignerTask.java
@@ -181,7 +181,7 @@ public abstract class AbstractJarSignerTask extends Task {
}
/**
- * Enable verbose output when signing ; optional: default false
+ * Enable verbose output when signing; optional: default false
*
* @param verbose if true enable verbose output
*/
@@ -192,7 +192,7 @@ public abstract class AbstractJarSignerTask extends Task {
/**
* do strict checking
* @since Ant 1.9.1
- * @param strict
+ * @param strict boolean
*/
public void setStrict(boolean strict) {
this.strict = strict;
diff --git a/src/main/org/apache/tools/ant/taskdefs/Ant.java b/src/main/org/apache/tools/ant/taskdefs/Ant.java
index 3b4ed036e..bb5175d84 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Ant.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Ant.java
@@ -139,6 +139,7 @@ public class Ant extends Task {
* as it would be when running the build file directly -
* independent of dir and/or inheritAll settings.
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setUseNativeBasedir(boolean b) {
@@ -470,7 +471,7 @@ public class Ant extends Task {
/**
* Get the default build file name to use when launching the task.
*
- * This function may be overrided by providers of custom ProjectHelper so they can implement easily their sub
+ * This function may be overriden by providers of custom ProjectHelper so they can implement easily their sub
* launcher.
*
* @return the name of the default file
@@ -613,7 +614,7 @@ public class Ant extends Task {
* well as properties named basedir or ant.file.
* @param props properties Hashtable to copy to the
* new project.
- * @param the type of property to set (a plain Ant property, a
+ * @param type the type of property to set (a plain Ant property, a
* user property or an inherited property).
* @since Ant 1.8.0
*/
@@ -822,6 +823,6 @@ public class Ant extends Task {
}
private enum PropertyType {
- PLAIN, INHERITED, USER;
+ PLAIN, INHERITED, USER
}
}
diff --git a/src/main/org/apache/tools/ant/taskdefs/AttributeNamespaceDef.java b/src/main/org/apache/tools/ant/taskdefs/AttributeNamespaceDef.java
index 150b7288b..c374d6f36 100644
--- a/src/main/org/apache/tools/ant/taskdefs/AttributeNamespaceDef.java
+++ b/src/main/org/apache/tools/ant/taskdefs/AttributeNamespaceDef.java
@@ -33,7 +33,7 @@ public final class AttributeNamespaceDef extends AntlibDefinition {
/**
* Run the definition.
- * This registers the XML namespace (URI) as a namepace for
+ * This registers the XML namespace (URI) as a namespace for
* attributes.
*/
public void execute() {
diff --git a/src/main/org/apache/tools/ant/taskdefs/Available.java b/src/main/org/apache/tools/ant/taskdefs/Available.java
index 6b371163c..99690e9eb 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Available.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Available.java
@@ -498,8 +498,8 @@ public class Available extends Task implements Condition {
/**
* @see EnumeratedAttribute#getValues
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
@Override
public String[] getValues() {
return VALUES;
diff --git a/src/main/org/apache/tools/ant/taskdefs/BuildNumber.java b/src/main/org/apache/tools/ant/taskdefs/BuildNumber.java
index 226ba7a31..77999300f 100644
--- a/src/main/org/apache/tools/ant/taskdefs/BuildNumber.java
+++ b/src/main/org/apache/tools/ant/taskdefs/BuildNumber.java
@@ -121,7 +121,7 @@ public class BuildNumber extends Task {
* Utility method to load properties from file.
*
* @return the loaded properties
- * @throws BuildException
+ * @throws BuildException if something goes wrong
*/
private Properties loadProperties() throws BuildException {
try (InputStream input = Files.newInputStream(myFile.toPath())) {
diff --git a/src/main/org/apache/tools/ant/taskdefs/Concat.java b/src/main/org/apache/tools/ant/taskdefs/Concat.java
index 27b313272..e632ac28b 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Concat.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Concat.java
@@ -363,7 +363,7 @@ public class Concat extends Task implements ResourceCollection {
/**
* return true if the lastchars buffer does
- * not contain the lineseparator
+ * not contain the line separator
*/
private boolean isMissingEndOfLine() {
for (int i = 0; i < lastChars.length; ++i) {
@@ -621,6 +621,7 @@ public class Concat extends Task implements ResourceCollection {
*
*
Defaults to false
*
+ * @param f boolean
* @since Ant 1.8.2
*/
public void setForceReadOnly(boolean f) {
diff --git a/src/main/org/apache/tools/ant/taskdefs/Copy.java b/src/main/org/apache/tools/ant/taskdefs/Copy.java
index 3c082799c..09d81f686 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Copy.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Copy.java
@@ -241,6 +241,7 @@ public class Copy extends Task {
*
*
Defaults to false
*
+ * @param f boolean
* @since Ant 1.8.2
*/
public void setForce(final boolean f) {
@@ -250,6 +251,7 @@ public class Copy extends Task {
/**
* Whether read-only destinations will be overwritten.
*
+ * @return boolean
* @since Ant 1.8.2
*/
public boolean getForce() {
@@ -466,7 +468,7 @@ public class Copy extends Task {
(1) Move is optimized to move directories if a fileset
has been included completely, therefore FileSets need a
special treatment. This is also required to support
- the failOnError semantice (skip filesets with broken
+ the failOnError semantic (skip filesets with broken
basedir but handle the remaining collections).
(2) We carry around a few protected methods that work
@@ -1036,7 +1038,7 @@ public class Copy extends Task {
}
/**
- * Either returns its argument or a plaeholder if the argument is null.
+ * Either returns its argument or a placeholder if the argument is null.
*/
private static File getKeyFile(final File f) {
return f == null ? NULL_FILE_PLACEHOLDER : f;
diff --git a/src/main/org/apache/tools/ant/taskdefs/Delete.java b/src/main/org/apache/tools/ant/taskdefs/Delete.java
index 7bc3c181e..6474bbf8a 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Delete.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Delete.java
@@ -213,6 +213,7 @@ public class Delete extends MatchingTask {
* default) but also on other operating systems, for example when
* deleting directories from an NFS share.
*
+ * @param b boolean
* @since Ant 1.8.3
*/
public void setPerformGcOnFailedDelete(boolean b) {
@@ -254,7 +255,7 @@ public class Delete extends MatchingTask {
/**
* add a name entry on the include files list
- * @return an NameEntry object to be configured
+ * @return a NameEntry object to be configured
*/
@Override
public PatternSet.NameEntry createIncludesFile() {
@@ -264,7 +265,7 @@ public class Delete extends MatchingTask {
/**
* add a name entry on the exclude list
- * @return an NameEntry object to be configured
+ * @return a NameEntry object to be configured
*/
@Override
public PatternSet.NameEntry createExclude() {
@@ -274,7 +275,7 @@ public class Delete extends MatchingTask {
/**
* add a name entry on the include files list
- * @return an NameEntry object to be configured
+ * @return a NameEntry object to be configured
*/
@Override
public PatternSet.NameEntry createExcludesFile() {
@@ -380,6 +381,7 @@ public class Delete extends MatchingTask {
* Sets whether the symbolic links that have not been followed
* shall be removed (the links, not the locations they point at).
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setRemoveNotFollowedSymlinks(boolean b) {
@@ -388,6 +390,7 @@ public class Delete extends MatchingTask {
/**
* add a "Select" selector entry on the selector list
+ *
* @param selector the selector to be added
*/
@Override
@@ -398,6 +401,7 @@ public class Delete extends MatchingTask {
/**
* add an "And" selector entry on the selector list
+ *
* @param selector the selector to be added
*/
@Override
@@ -408,6 +412,7 @@ public class Delete extends MatchingTask {
/**
* add an "Or" selector entry on the selector list
+ *
* @param selector the selector to be added
*/
@Override
@@ -418,6 +423,7 @@ public class Delete extends MatchingTask {
/**
* add a "Not" selector entry on the selector list
+ *
* @param selector the selector to be added
*/
@Override
@@ -428,6 +434,7 @@ public class Delete extends MatchingTask {
/**
* add a "None" selector entry on the selector list
+ *
* @param selector the selector to be added
*/
@Override
@@ -438,6 +445,7 @@ public class Delete extends MatchingTask {
/**
* add a majority selector entry on the selector list
+ *
* @param selector the selector to be added
*/
@Override
@@ -448,6 +456,7 @@ public class Delete extends MatchingTask {
/**
* add a selector date entry on the selector list
+ *
* @param selector the selector to be added
*/
@Override
@@ -458,6 +467,7 @@ public class Delete extends MatchingTask {
/**
* add a selector size entry on the selector list
+ *
* @param selector the selector to be added
*/
@Override
@@ -468,6 +478,7 @@ public class Delete extends MatchingTask {
/**
* add a selector filename entry on the selector list
+ *
* @param selector the selector to be added
*/
@Override
@@ -478,6 +489,7 @@ public class Delete extends MatchingTask {
/**
* add an extended selector entry on the selector list
+ *
* @param selector the selector to be added
*/
@Override
@@ -488,6 +500,7 @@ public class Delete extends MatchingTask {
/**
* add a contains selector entry on the selector list
+ *
* @param selector the selector to be added
*/
@Override
@@ -498,6 +511,7 @@ public class Delete extends MatchingTask {
/**
* add a present selector entry on the selector list
+ *
* @param selector the selector to be added
*/
@Override
@@ -508,6 +522,7 @@ public class Delete extends MatchingTask {
/**
* add a depth selector entry on the selector list
+ *
* @param selector the selector to be added
*/
@Override
@@ -518,6 +533,7 @@ public class Delete extends MatchingTask {
/**
* add a depends selector entry on the selector list
+ *
* @param selector the selector to be added
*/
@Override
@@ -528,6 +544,7 @@ public class Delete extends MatchingTask {
/**
* add a regular expression selector entry on the selector list
+ *
* @param selector the selector to be added
*/
@Override
@@ -538,6 +555,7 @@ public class Delete extends MatchingTask {
/**
* add the modified selector
+ *
* @param selector the selector to add
* @since ant 1.6
*/
@@ -549,6 +567,7 @@ public class Delete extends MatchingTask {
/**
* add an arbitrary selector
+ *
* @param selector the selector to be added
* @since Ant 1.6
*/
@@ -560,6 +579,7 @@ public class Delete extends MatchingTask {
/**
* Delete the file(s).
+ *
* @exception BuildException if an error occurs
*/
@Override
diff --git a/src/main/org/apache/tools/ant/taskdefs/DependSet.java b/src/main/org/apache/tools/ant/taskdefs/DependSet.java
index ecc8ac3e6..0fbdf56d5 100644
--- a/src/main/org/apache/tools/ant/taskdefs/DependSet.java
+++ b/src/main/org/apache/tools/ant/taskdefs/DependSet.java
@@ -183,6 +183,7 @@ public class DependSet extends MatchingTask {
*
*
All deleted files will be logged as well.
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setVerbose(boolean b) {
diff --git a/src/main/org/apache/tools/ant/taskdefs/Echo.java b/src/main/org/apache/tools/ant/taskdefs/Echo.java
index ac31ee329..f1e13c87c 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Echo.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Echo.java
@@ -156,6 +156,7 @@ public class Echo extends Task {
*
*
Defaults to false
*
+ * @param f boolean
* @since Ant 1.8.2
*/
public void setForce(boolean f) {
diff --git a/src/main/org/apache/tools/ant/taskdefs/EchoXML.java b/src/main/org/apache/tools/ant/taskdefs/EchoXML.java
index fa0e45737..671d68d87 100644
--- a/src/main/org/apache/tools/ant/taskdefs/EchoXML.java
+++ b/src/main/org/apache/tools/ant/taskdefs/EchoXML.java
@@ -58,8 +58,7 @@ public class EchoXML extends XMLFragment {
/**
* Set the namespace policy for the xml file
* @param n namespace policy: "ignore," "elementsOnly," or "all"
- * @see
- * org.apache.tools.ant.util.DOMElementWriter.XmlNamespacePolicy
+ * @see org.apache.tools.ant.util.DOMElementWriter.XmlNamespacePolicy
*/
public void setNamespacePolicy(NamespacePolicy n) {
namespacePolicy = n;
diff --git a/src/main/org/apache/tools/ant/taskdefs/ExecTask.java b/src/main/org/apache/tools/ant/taskdefs/ExecTask.java
index 6ed6d90ed..1a8956f66 100644
--- a/src/main/org/apache/tools/ant/taskdefs/ExecTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/ExecTask.java
@@ -155,6 +155,7 @@ public class ExecTask extends Task {
/**
* List of operating systems on which the command may be executed.
+ * @return String
* @since Ant 1.8.0
*/
public final String getOs() {
@@ -404,6 +405,7 @@ public class ExecTask extends Task {
/**
* Restrict this execution to a single OS Family
+ * @return the family to restrict to.
* @since Ant 1.8.0
*/
public final String getOsFamily() {
diff --git a/src/main/org/apache/tools/ant/taskdefs/Execute.java b/src/main/org/apache/tools/ant/taskdefs/Execute.java
index 7bf9d0458..0c2364c00 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Execute.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Execute.java
@@ -627,14 +627,14 @@ public class Execute {
for (String osEnvItem : osEnv.keySet()) {
// Nb: using default locale as key is a env name
if (osEnvItem.equalsIgnoreCase(key)) {
- // Use the original casiness of the key
+ // Use the original case of the key
key = osEnvItem;
break;
}
}
}
- // Add the key to the enviromnent copy
+ // Add the key to the environment copy
osEnv.put(key, keyValue.substring(key.length() + 1));
}
diff --git a/src/main/org/apache/tools/ant/taskdefs/Expand.java b/src/main/org/apache/tools/ant/taskdefs/Expand.java
index d6834aa2e..6ae42e881 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Expand.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Expand.java
@@ -91,6 +91,7 @@ public class Expand extends Task {
/**
* Creates an Expand instance and sets the given encoding.
*
+ * @param encoding String
* @since Ant 1.9.5
*/
protected Expand(String encoding) {
@@ -100,6 +101,7 @@ public class Expand extends Task {
/**
* Whether try ing to expand an empty archive would be an error.
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setFailOnEmptyArchive(boolean b) {
@@ -109,6 +111,7 @@ public class Expand extends Task {
/**
* Whether try ing to expand an empty archive would be an error.
*
+ * @return boolean
* @since Ant 1.8.0
*/
public boolean getFailOnEmptyArchive() {
@@ -463,6 +466,7 @@ public class Expand extends Task {
* where the child-class doesn't (i.e. Unzip in the compress
* Antlib).
*
+ * @param encoding String
* @since Ant 1.8.0
*/
protected void internalSetEncoding(String encoding) {
@@ -473,6 +477,7 @@ public class Expand extends Task {
}
/**
+ * @return String
* @since Ant 1.8.0
*/
public String getEncoding() {
@@ -482,6 +487,7 @@ public class Expand extends Task {
/**
* Whether leading path separators should be stripped.
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setStripAbsolutePathSpec(boolean b) {
@@ -491,6 +497,7 @@ public class Expand extends Task {
/**
* Whether unicode extra fields will be used if present.
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setScanForUnicodeExtraFields(boolean b) {
@@ -502,6 +509,7 @@ public class Expand extends Task {
* where the child-class doesn't (i.e. Unzip in the compress
* Antlib).
*
+ * @param b boolean
* @since Ant 1.8.0
*/
protected void internalSetScanForUnicodeExtraFields(boolean b) {
@@ -509,6 +517,7 @@ public class Expand extends Task {
}
/**
+ * @return boolean
* @since Ant 1.8.0
*/
public boolean getScanForUnicodeExtraFields() {
diff --git a/src/main/org/apache/tools/ant/taskdefs/FixCRLF.java b/src/main/org/apache/tools/ant/taskdefs/FixCRLF.java
index 806c81451..fc5adb078 100644
--- a/src/main/org/apache/tools/ant/taskdefs/FixCRLF.java
+++ b/src/main/org/apache/tools/ant/taskdefs/FixCRLF.java
@@ -690,8 +690,8 @@ public class FixCRLF extends MatchingTask implements ChainableReader {
public static class CrLf extends EnumeratedAttribute {
/**
* @see EnumeratedAttribute#getValues
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
@Override
public String[] getValues() {
return new String[] { "asis", "cr", "lf", "crlf", "mac", "unix",
diff --git a/src/main/org/apache/tools/ant/taskdefs/Get.java b/src/main/org/apache/tools/ant/taskdefs/Get.java
index 7e7912829..848882e3b 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Get.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Get.java
@@ -327,6 +327,7 @@ public class Get extends Task {
/**
* Adds URLs to get.
+ * @param rc ResourceCollection
* @since Ant 1.8.0
*/
public void add(final ResourceCollection rc) {
@@ -414,6 +415,7 @@ public class Get extends Task {
* The time in seconds the download is allowed to take before
* being terminated.
*
+ * @param maxTime long
* @since Ant 1.8.0
*/
public void setMaxTime(final long maxTime) {
@@ -428,7 +430,6 @@ public class Get extends Task {
* reach the URI at all.
*
* @param r number of attempts to make
- *
* @since Ant 1.8.0
*/
public void setRetries(final int r) {
@@ -444,7 +445,6 @@ public class Get extends Task {
* Skip files that already exist locally.
*
* @param s "true" to skip existing destination files
- *
* @since Ant 1.8.0
*/
public void setSkipExisting(final boolean s) {
@@ -457,6 +457,7 @@ public class Get extends Task {
* the value is considered unset and the behaviour falls
* back to the default of the http API.
*
+ * @param userAgent String
* @since Ant 1.9.3
*/
public void setUserAgent(final String userAgent) {
@@ -471,6 +472,7 @@ public class Get extends Task {
*
Defaults to true (allow caching, which is also the
* HttpUrlConnection default value.
*
+ * @param httpUseCache boolean
* @since Ant 1.8.0
*/
public void setHttpUseCaches(final boolean httpUseCache) {
@@ -484,6 +486,7 @@ public class Get extends Task {
*
Setting this to true also means Ant will uncompress
* .tar.gz and similar files automatically.
*
+ * @param b boolean
* @since Ant 1.9.5
*/
public void setTryGzipEncoding(boolean b) {
@@ -894,7 +897,7 @@ public class Get extends Task {
/**
* Has the download completed successfully?
*
- *
Re-throws any exception caught during executaion.
+ *
Re-throws any exception caught during execution.
*/
boolean wasSuccessful() throws IOException, BuildException {
if (ioexception != null) {
diff --git a/src/main/org/apache/tools/ant/taskdefs/ImportTask.java b/src/main/org/apache/tools/ant/taskdefs/ImportTask.java
index 98bf4b3c0..9fd4fc775 100644
--- a/src/main/org/apache/tools/ant/taskdefs/ImportTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/ImportTask.java
@@ -99,6 +99,7 @@ public class ImportTask extends Task {
/**
* The prefix to use when prefixing the imported target names.
*
+ * @param prefix String
* @since Ant 1.8.0
*/
public void setAs(String prefix) {
@@ -109,6 +110,7 @@ public class ImportTask extends Task {
* The separator to use between prefix and target name, default is
* ".".
*
+ * @param s String
* @since Ant 1.8.0
*/
public void setPrefixSeparator(String s) {
@@ -118,6 +120,7 @@ public class ImportTask extends Task {
/**
* The resource to import.
*
+ * @param r ResourceCollection
* @since Ant 1.8.0
*/
public void add(ResourceCollection r) {
@@ -314,6 +317,7 @@ public class ImportTask extends Task {
* overwritten in the importing build file. The depends list of
* the imported targets is not modified at all.
*
+ * @return boolean
* @since Ant 1.8.0
*/
protected final boolean isInIncludeMode() {
@@ -323,6 +327,9 @@ public class ImportTask extends Task {
/**
* Sets a bunch of Thread-local ProjectHelper properties.
*
+ * @param prefix String
+ * @param prefixSep String
+ * @param inIncludeMode boolean
* @since Ant 1.8.0
*/
private static void setProjectHelperProps(String prefix,
diff --git a/src/main/org/apache/tools/ant/taskdefs/JDBCTask.java b/src/main/org/apache/tools/ant/taskdefs/JDBCTask.java
index 3674586f2..3b8dd464c 100644
--- a/src/main/org/apache/tools/ant/taskdefs/JDBCTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/JDBCTask.java
@@ -245,6 +245,7 @@ public abstract class JDBCTask extends Task {
/**
* whether the task should cause the build to fail if it cannot
* connect to the database.
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setFailOnConnectionError(boolean b) {
@@ -313,6 +314,7 @@ public abstract class JDBCTask extends Task {
/**
* Additional properties to put into the JDBC connection string.
*
+ * @param var Property
* @since Ant 1.8.0
*/
public void addConnectionProperty(Property var) {
@@ -382,7 +384,7 @@ public abstract class JDBCTask extends Task {
* Gets an instance of the required driver.
* Uses the ant class loader and the optionally the provided classpath.
* @return Driver
- * @throws BuildException
+ * @throws BuildException if something goes wrong
*/
private Driver getDriver() throws BuildException {
if (driver == null) {
diff --git a/src/main/org/apache/tools/ant/taskdefs/Jar.java b/src/main/org/apache/tools/ant/taskdefs/Jar.java
index 26f844c46..5edcb0fbf 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Jar.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Jar.java
@@ -153,7 +153,7 @@ public class Jar extends Zip {
// CheckStyle:LineLength OFF - Link is too long.
/**
* Strict mode for checking rules of the JAR-Specification.
- * @see http://java.sun.com/j2se/1.3/docs/guide/versioning/spec/VersioningSpecification.html#PackageVersioning
+ * @see
*/
private StrictMode strict = new StrictMode("ignore");
@@ -441,6 +441,7 @@ public class Jar extends Zip {
/**
* Whether to merge Class-Path attributes.
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setMergeClassPathAttributes(boolean b) {
@@ -451,6 +452,7 @@ public class Jar extends Zip {
* Whether to flatten multi-valued attributes (i.e. Class-Path)
* into a single one.
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setFlattenAttributes(boolean b) {
@@ -978,7 +980,6 @@ public class Jar extends Zip {
* @param dirs a list of directories
* @param files a list of files
* @param writer the writer to write to
- * @throws IOException on error
* @since Ant 1.6.2
*/
protected final void writeIndexLikeList(List dirs, List files,
diff --git a/src/main/org/apache/tools/ant/taskdefs/Javac.java b/src/main/org/apache/tools/ant/taskdefs/Javac.java
index fb8e2ed6f..0d7cd5054 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Javac.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Javac.java
@@ -1079,6 +1079,7 @@ public class Javac extends MatchingTask {
* The classpath to use when loading the compiler implementation
* if it is not a built-in one.
*
+ * @return Path
* @since Ant 1.8.0
*/
public Path createCompilerClasspath() {
@@ -1087,6 +1088,8 @@ public class Javac extends MatchingTask {
/**
* Set the compiler adapter explicitly.
+ *
+ * @param adapter CompilerAdapter
* @since Ant 1.8.0
*/
public void add(final CompilerAdapter adapter) {
@@ -1102,6 +1105,7 @@ public class Javac extends MatchingTask {
* matching package-info.java files that have been compiled but
* didn't create class files themselves.
*
+ * @param b boolean
* @since Ant 1.8.3
*/
public void setCreateMissingPackageInfoClass(final boolean b) {
diff --git a/src/main/org/apache/tools/ant/taskdefs/Javadoc.java b/src/main/org/apache/tools/ant/taskdefs/Javadoc.java
index a92e8da6f..655be6090 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Javadoc.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Javadoc.java
@@ -66,9 +66,9 @@ import org.apache.tools.ant.util.StringUtils;
* Generates Javadoc documentation for a collection
* of source code.
*
- *
Current known limitations are:
+ *
Current known limitations are:
*
- *
+ *
*
patterns must be of the form "xxx.*", every other pattern doesn't
* work.
*
there is no control on arguments sanity since they are left
@@ -76,10 +76,10 @@ import org.apache.tools.ant.util.StringUtils;
*
*
*
If no doclet is set, then the version and
- * author are by default "yes".
+ * author are by default "yes".
*
*
Note: This task is run on another VM because the Javadoc code calls
- * System.exit() which would break Ant functionality.
+ * System.exit() which would break Ant functionality.
*
* @since Ant 1.1
*
@@ -1666,6 +1666,7 @@ public class Javadoc extends Task {
/**
* Enables deep-copying of doc-files directories.
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setDocFilesSubDirs(final boolean b) {
@@ -1676,6 +1677,7 @@ public class Javadoc extends Task {
* Colon-separated list of doc-files subdirectories
* to skip if {@link #setDocFilesSubDirs docFilesSubDirs is true}.
*
+ * @param s String
* @since Ant 1.8.0
*/
public void setExcludeDocFilesSubDir(final String s) {
@@ -1684,6 +1686,8 @@ public class Javadoc extends Task {
/**
* Whether to post-process the generated javadocs in order to mitigate CVE-2013-1571.
+ *
+ * @param b boolean
* @since Ant 1.9.2
*/
public void setPostProcessGeneratedJavadocs(final boolean b) {
diff --git a/src/main/org/apache/tools/ant/taskdefs/LoadProperties.java b/src/main/org/apache/tools/ant/taskdefs/LoadProperties.java
index 9ff4e6e89..bc71660c0 100644
--- a/src/main/org/apache/tools/ant/taskdefs/LoadProperties.java
+++ b/src/main/org/apache/tools/ant/taskdefs/LoadProperties.java
@@ -147,6 +147,7 @@ public class LoadProperties extends Task {
* Whether to apply the prefix when expanding properties on the
* right hand side of a properties file as well.
*
+ * @param b boolean
* @since Ant 1.8.2
*/
public void setPrefixValues(boolean b) {
diff --git a/src/main/org/apache/tools/ant/taskdefs/LogOutputStream.java b/src/main/org/apache/tools/ant/taskdefs/LogOutputStream.java
index 23bb6bd15..370bcdd7a 100644
--- a/src/main/org/apache/tools/ant/taskdefs/LogOutputStream.java
+++ b/src/main/org/apache/tools/ant/taskdefs/LogOutputStream.java
@@ -28,7 +28,7 @@ import org.apache.tools.ant.util.LineOrientedOutputStream;
/**
* Logs each line written to this stream to the log system of ant.
*
- * Tries to be smart about line separators.
+ *
Tries to be smart about line separators.
*
* @since Ant 1.2
*/
diff --git a/src/main/org/apache/tools/ant/taskdefs/MakeUrl.java b/src/main/org/apache/tools/ant/taskdefs/MakeUrl.java
index 09e252b2f..961a3c830 100644
--- a/src/main/org/apache/tools/ant/taskdefs/MakeUrl.java
+++ b/src/main/org/apache/tools/ant/taskdefs/MakeUrl.java
@@ -274,7 +274,7 @@ public class MakeUrl extends Task {
/**
* convert a file to a URL;
*
- * @param fileToConvert
+ * @param fileToConvert File
* @return the file converted to a URL
*/
private String toURL(File fileToConvert) {
diff --git a/src/main/org/apache/tools/ant/taskdefs/Manifest.java b/src/main/org/apache/tools/ant/taskdefs/Manifest.java
index f47f461c5..483d8c689 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Manifest.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Manifest.java
@@ -44,8 +44,8 @@ import org.apache.tools.ant.util.FileUtils;
* Holds the data of a jar manifest.
*
* Manifests are processed according to the
- * {@link Jar
- * file specification.}.
+ * Jar
+ * file specification.
* Specifically, a manifest element consists of
* a set of attributes and sections. These sections in turn may contain
* attributes. Note in particular that this may result in manifest lines
diff --git a/src/main/org/apache/tools/ant/taskdefs/ManifestTask.java b/src/main/org/apache/tools/ant/taskdefs/ManifestTask.java
index 85dfd8a35..2e85cee14 100644
--- a/src/main/org/apache/tools/ant/taskdefs/ManifestTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/ManifestTask.java
@@ -198,6 +198,7 @@ public class ManifestTask extends Task {
/**
* Whether to merge Class-Path attributes.
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setMergeClassPathAttributes(boolean b) {
@@ -208,6 +209,7 @@ public class ManifestTask extends Task {
* Whether to flatten multi-valued attributes (i.e. Class-Path)
* into a single one.
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setFlattenAttributes(boolean b) {
diff --git a/src/main/org/apache/tools/ant/taskdefs/MatchingTask.java b/src/main/org/apache/tools/ant/taskdefs/MatchingTask.java
index 414a89a14..a7654db7d 100644
--- a/src/main/org/apache/tools/ant/taskdefs/MatchingTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/MatchingTask.java
@@ -155,7 +155,7 @@ public abstract class MatchingTask extends Task implements SelectorContainer {
/**
* List of filenames and directory names to not include. They should be
- * either , or " " (space) separated. The ignored files will be logged.
+ * either comma or space separated. The ignored files will be logged.
*
* @param ignoreString the string containing the files to ignore.
*/
diff --git a/src/main/org/apache/tools/ant/taskdefs/Move.java b/src/main/org/apache/tools/ant/taskdefs/Move.java
index d43befd3e..3984c7fcc 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Move.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Move.java
@@ -71,6 +71,7 @@ public class Move extends Copy {
* default) but also on other operating systems, for example when
* deleting directories from an NFS share.
*
+ * @param b boolean
* @since Ant 1.8.3
*/
public void setPerformGcOnFailedDelete(boolean b) {
@@ -229,10 +230,10 @@ public class Move extends Copy {
/**
* Copy fromFile to toFile.
- * @param fromFile
- * @param toFile
- * @param filtering
- * @param overwrite
+ * @param fromFile File
+ * @param toFile File
+ * @param filtering boolean
+ * @param overwrite boolean
*/
private void copyFile(File fromFile, File toFile, boolean filtering, boolean overwrite) {
try {
diff --git a/src/main/org/apache/tools/ant/taskdefs/Pack.java b/src/main/org/apache/tools/ant/taskdefs/Pack.java
index 67a2dd8ba..f617e618d 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Pack.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Pack.java
@@ -150,7 +150,7 @@ public abstract class Pack extends Task {
* zip a stream to an output stream
* @param in the stream to zip
* @param zOut the output stream
- * @throws IOException
+ * @throws IOException if something goes wrong
*/
private void zipFile(InputStream in, OutputStream zOut)
throws IOException {
diff --git a/src/main/org/apache/tools/ant/taskdefs/Property.java b/src/main/org/apache/tools/ant/taskdefs/Property.java
index ebe73deb6..6982064e7 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Property.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Property.java
@@ -293,6 +293,7 @@ public class Property extends Task {
* Whether to apply the prefix when expanding properties on the
* right hand side of a properties file as well.
*
+ * @param b boolean
* @since Ant 1.8.2
*/
public void setPrefixValues(boolean b) {
@@ -303,6 +304,7 @@ public class Property extends Task {
* Whether to apply the prefix when expanding properties on the
* right hand side of a properties file as well.
*
+ * @return boolean
* @since Ant 1.8.2
*/
public boolean getPrefixValues() {
@@ -360,10 +362,12 @@ public class Property extends Task {
* allow access of environment variables through "myenv.PATH" and
* "myenv.TERM". This functionality is currently only implemented
* on select platforms. Feel free to send patches to increase the number of platforms
- * this functionality is supported on ;).
+ * this functionality is supported on ;).
+ *
* Note also that properties are case sensitive, even if the
* environment variables on your operating system are not, e.g. it
* will be ${env.Path} not ${env.PATH} on Windows 2000.
+ *
* @param env prefix
*
* @ant.attribute group="noname"
diff --git a/src/main/org/apache/tools/ant/taskdefs/PumpStreamHandler.java b/src/main/org/apache/tools/ant/taskdefs/PumpStreamHandler.java
index 0f64544ac..9a2394721 100644
--- a/src/main/org/apache/tools/ant/taskdefs/PumpStreamHandler.java
+++ b/src/main/org/apache/tools/ant/taskdefs/PumpStreamHandler.java
@@ -164,6 +164,7 @@ public class PumpStreamHandler implements ExecuteStreamHandler {
* ThreadWithPumper ThreadWithPumper} instance) or interrupting
* the thread.
*
+ * @param t Thread
* @since Ant 1.8.0
*/
protected final void finish(Thread t) {
diff --git a/src/main/org/apache/tools/ant/taskdefs/Recorder.java b/src/main/org/apache/tools/ant/taskdefs/Recorder.java
index cc3b432ae..a6f6a883c 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Recorder.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Recorder.java
@@ -180,8 +180,8 @@ public class Recorder extends Task implements SubBuildListener {
/**
* @see EnumeratedAttribute#getValues()
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public String[] getValues() {
return VALUES;
}
@@ -321,4 +321,3 @@ public class Recorder extends Task implements SubBuildListener {
getProject().removeBuildListener(this);
}
}
-
diff --git a/src/main/org/apache/tools/ant/taskdefs/RecorderEntry.java b/src/main/org/apache/tools/ant/taskdefs/RecorderEntry.java
index 0155afce1..de9ac0f28 100644
--- a/src/main/org/apache/tools/ant/taskdefs/RecorderEntry.java
+++ b/src/main/org/apache/tools/ant/taskdefs/RecorderEntry.java
@@ -91,16 +91,16 @@ public class RecorderEntry implements BuildLogger, SubBuildListener {
/**
* @see org.apache.tools.ant.BuildListener#buildStarted(BuildEvent)
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void buildStarted(BuildEvent event) {
log("> BUILD STARTED", Project.MSG_DEBUG);
}
/**
* @see org.apache.tools.ant.BuildListener#buildFinished(BuildEvent)
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void buildFinished(BuildEvent event) {
log("< BUILD FINISHED", Project.MSG_DEBUG);
@@ -145,8 +145,8 @@ public class RecorderEntry implements BuildLogger, SubBuildListener {
/**
* @see org.apache.tools.ant.BuildListener#targetStarted(BuildEvent)
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void targetStarted(BuildEvent event) {
log(">> TARGET STARTED -- " + event.getTarget(), Project.MSG_DEBUG);
log(StringUtils.LINE_SEP + event.getTarget().getName() + ":",
@@ -156,8 +156,8 @@ public class RecorderEntry implements BuildLogger, SubBuildListener {
/**
* @see org.apache.tools.ant.BuildListener#targetFinished(BuildEvent)
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void targetFinished(BuildEvent event) {
log("<< TARGET FINISHED -- " + event.getTarget(), Project.MSG_DEBUG);
@@ -169,16 +169,16 @@ public class RecorderEntry implements BuildLogger, SubBuildListener {
/**
* @see org.apache.tools.ant.BuildListener#taskStarted(BuildEvent)
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void taskStarted(BuildEvent event) {
log(">>> TASK STARTED -- " + event.getTask(), Project.MSG_DEBUG);
}
/**
* @see org.apache.tools.ant.BuildListener#taskFinished(BuildEvent)
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void taskFinished(BuildEvent event) {
log("<<< TASK FINISHED -- " + event.getTask(), Project.MSG_DEBUG);
flush();
@@ -186,8 +186,8 @@ public class RecorderEntry implements BuildLogger, SubBuildListener {
/**
* @see org.apache.tools.ant.BuildListener#messageLogged(BuildEvent)
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void messageLogged(BuildEvent event) {
log("--- MESSAGE LOGGED", Project.MSG_DEBUG);
@@ -232,8 +232,8 @@ public class RecorderEntry implements BuildLogger, SubBuildListener {
/**
* @see BuildLogger#setMessageOutputLevel(int)
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void setMessageOutputLevel(int level) {
if (level >= Project.MSG_ERR && level <= Project.MSG_DEBUG) {
loglevel = level;
@@ -242,8 +242,8 @@ public class RecorderEntry implements BuildLogger, SubBuildListener {
/**
* @see BuildLogger#setOutputPrintStream(PrintStream)
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void setOutputPrintStream(PrintStream output) {
closeFile();
out = output;
@@ -252,8 +252,8 @@ public class RecorderEntry implements BuildLogger, SubBuildListener {
/**
* @see BuildLogger#setEmacsMode(boolean)
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void setEmacsMode(boolean emacsMode) {
this.emacsMode = emacsMode;
}
@@ -261,8 +261,8 @@ public class RecorderEntry implements BuildLogger, SubBuildListener {
/**
* @see BuildLogger#setErrorPrintStream(PrintStream)
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void setErrorPrintStream(PrintStream err) {
setOutputPrintStream(err);
}
@@ -303,6 +303,7 @@ public class RecorderEntry implements BuildLogger, SubBuildListener {
/**
* Get the project associated with this recorder entry.
*
+ * @return Project
* @since 1.8.0
*/
public Project getProject() {
@@ -325,7 +326,7 @@ public class RecorderEntry implements BuildLogger, SubBuildListener {
* Used by Recorder.
* @param append Indicates if output must be appended to the logfile or that
* the logfile should be overwritten.
- * @throws BuildException
+ * @throws BuildException if something goes wrong
* @since 1.6.3
*/
void openFile(boolean append) throws BuildException {
@@ -347,7 +348,7 @@ public class RecorderEntry implements BuildLogger, SubBuildListener {
/**
* Re-opens the file associated with this recorder.
* Used by Recorder.
- * @throws BuildException
+ * @throws BuildException if something goes wrong
* @since 1.6.3
*/
void reopenFile() throws BuildException {
diff --git a/src/main/org/apache/tools/ant/taskdefs/Redirector.java b/src/main/org/apache/tools/ant/taskdefs/Redirector.java
index 5b99d34d3..9871d168b 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Redirector.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Redirector.java
@@ -534,6 +534,8 @@ public class Redirector {
*
Binary output will not be split into lines which may make
* error and normal output look mixed up when they get written to
* the same stream.
+ *
+ * @param b boolean
* @since 1.9.4
*/
public void setBinaryOutput(final boolean b) {
diff --git a/src/main/org/apache/tools/ant/taskdefs/Replace.java b/src/main/org/apache/tools/ant/taskdefs/Replace.java
index 42fe2919d..9455baa89 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Replace.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Replace.java
@@ -102,6 +102,7 @@ public class Replace extends MatchingTask {
* expanded already so you do not want to set this to
* true.
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setExpandProperties(boolean b) {
@@ -286,7 +287,7 @@ public class Replace extends MatchingTask {
* The filter expects from the component providing the input that data
* is only added by that component to the end of this StringBuffer.
* This StringBuffer will be modified by this filter, and expects that
- * another component will only apped to this StringBuffer.
+ * another component will only added to this StringBuffer.
* @param input The input for this filter.
*/
void setInputBuffer(StringBuffer input) {
@@ -873,6 +874,7 @@ public class Replace extends MatchingTask {
/**
* Support arbitrary file system based resource collections.
*
+ * @param rc ResourceCollection
* @since Ant 1.8.0
*/
public void addConfigured(ResourceCollection rc) {
@@ -889,6 +891,7 @@ public class Replace extends MatchingTask {
* Whether the file timestamp shall be preserved even if the file
* is modified.
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setPreserveLastModified(boolean b) {
@@ -898,6 +901,7 @@ public class Replace extends MatchingTask {
/**
* Whether the build should fail if nothing has been replaced.
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setFailOnNoReplacements(boolean b) {
@@ -917,6 +921,10 @@ public class Replace extends MatchingTask {
/**
* Replace occurrences of str1 in StringBuffer str with str2.
+ *
+ * @param str StringBuilder
+ * @param str1 String
+ * @param str2 String
*/
private void stringReplace(StringBuilder str, String str1, String str2) {
int found = str.indexOf(str1);
@@ -931,6 +939,8 @@ public class Replace extends MatchingTask {
/**
* Sort keys by size so that tokens that are substrings of other
* strings are tried later.
+ *
+ * @param props Properties
*/
private Iterator
* If type is unspecified, it defaults to string.
- *
+ *
* Parameter values:
- *
- *
operation:
+ *
+ *
operation:
+ *
*
*
"=" (set -- default)
*
"-" (dec)
*
"+" (inc)
*
- *
type:
+ *
+ *
type:
+ *
*
*
"int"
*
"date"
*
"string"
*
- *
value:
+ *
+ *
value:
+ *
*
*
holds the default value, if the property
* was not found in property file
@@ -115,7 +122,8 @@ import org.apache.tools.ant.util.LayoutPreservingProperties;
* date/time and used even if a valid date was
* found in the property file.
*
- *
+ *
+ *
*
*
String property types can only use the "=" operation.
* Int property types can only use the "=", "-" or "+" operations.
@@ -231,6 +239,7 @@ public class PropertyFile extends Task {
/**
* optional flag to use original Java properties (as opposed to
* layout preserving properties)
+ * @param val boolean
*/
public void setJDKProperties(boolean val) {
useJDKProperties = val;
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.java b/src/main/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.java
index afc9a54ab..e4271ff49 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.java
@@ -147,6 +147,7 @@ public class ReplaceRegExp extends Task {
/**
* file for which the regular expression should be replaced;
* required unless a nested fileset is supplied.
+ *
* @param file The file for which the reg exp should be replaced.
*/
public void setFile(File file) {
@@ -156,6 +157,7 @@ public class ReplaceRegExp extends Task {
/**
* the regular expression pattern to match in the file(s);
* required if no nested <regexp> is used
+ *
* @param match the match attribute.
*/
public void setMatch(String match) {
@@ -171,6 +173,7 @@ public class ReplaceRegExp extends Task {
* The substitution pattern to place in the file(s) in place
* of the regular expression.
* Required if no nested <substitution> is used
+ *
* @param replace the replace attribute
*/
@@ -188,15 +191,16 @@ public class ReplaceRegExp extends Task {
* The flags to use when matching the regular expression. For more
* information, consult the Perl5 syntax.
*
- *
g : Global replacement. Replace all occurrences found
- *
i : Case Insensitive. Do not consider case in the match
+ *
g : Global replacement. Replace all occurrences found
+ *
i : Case Insensitive. Do not consider case in the match
*
m : Multiline. Treat the string as multiple lines of input,
* using "^" and "$" as the start or end of any line, respectively,
- * rather than start or end of string.
- *
s : Singleline. Treat the string as a single line of input, using
+ * rather than start or end of string.
+ *
s : Singleline. Treat the string as a single line of input, using
* "." to match any character, including a newline, which normally,
- * it would not match.
- *
+ * it would not match.
+ *
+ *
* @param flags the flags attribute
*/
public void setFlags(String flags) {
@@ -235,8 +239,8 @@ public class ReplaceRegExp extends Task {
/**
* Specifies the encoding Ant expects the files to be in -
* defaults to the platforms default encoding.
- * @param encoding the encoding attribute
*
+ * @param encoding the encoding attribute
* @since Ant 1.6
*/
public void setEncoding(String encoding) {
@@ -245,6 +249,7 @@ public class ReplaceRegExp extends Task {
/**
* list files to apply the replacement to
+ *
* @param set the fileset element
*/
public void addFileset(FileSet set) {
@@ -254,6 +259,7 @@ public class ReplaceRegExp extends Task {
/**
* Support arbitrary file system based resource collections.
*
+ * @param rc ResourceCollection
* @since Ant 1.8.0
*/
public void addConfigured(ResourceCollection rc) {
@@ -285,6 +291,7 @@ public class ReplaceRegExp extends Task {
/**
* A substitution pattern. You can use this element to refer to a previously
* defined substitution pattern datatype instance.
+ *
* @return the substitution pattern object to be configured as an element
*/
public Substitution createSubstitution() {
@@ -301,6 +308,7 @@ public class ReplaceRegExp extends Task {
* Whether the file timestamp shall be preserved even if the file
* is modified.
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setPreserveLastModified(boolean b) {
@@ -334,7 +342,7 @@ public class ReplaceRegExp extends Task {
}
/**
- * Perform the replacement on a file
+ * Perform the replacement on a file
*
* @param f the file to perform the replacement on
* @param options the regular expressions options
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/Rpm.java b/src/main/org/apache/tools/ant/taskdefs/optional/Rpm.java
index 7ecf35d7f..752e599b9 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/Rpm.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/Rpm.java
@@ -204,7 +204,7 @@ public class Rpm extends Task {
/**
* The directory which will have the expected
- * subdirectories, SPECS, SOURCES, BUILD, SRPMS ; optional.
+ * subdirectories, SPECS, SOURCES, BUILD, SRPMS; optional.
* If this isn't specified,
* the baseDir value is used
*
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/SchemaValidate.java b/src/main/org/apache/tools/ant/taskdefs/optional/SchemaValidate.java
index a5db9912e..4e1837c31 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/SchemaValidate.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/SchemaValidate.java
@@ -225,7 +225,7 @@ public class SchemaValidate extends XMLValidateTask {
//enable schema
setFeature(XmlConstants.FEATURE_NAMESPACES, true);
if (!enableXercesSchemaValidation() && !enableJAXP12SchemaValidation()) {
- //couldnt use the xerces or jaxp calls
+ //could not use xerces or jaxp calls
throw new BuildException(ERROR_NO_XSD_SUPPORT);
}
@@ -295,7 +295,7 @@ public class SchemaValidate extends XMLValidateTask {
try {
getXmlReader().setFeature(feature, value);
} catch (SAXNotRecognizedException e) {
- log("Not recognizied: " + feature, Project.MSG_VERBOSE);
+ log("Not recognized: " + feature, Project.MSG_VERBOSE);
} catch (SAXNotSupportedException e) {
log("Not supported: " + feature, Project.MSG_VERBOSE);
}
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/Script.java b/src/main/org/apache/tools/ant/taskdefs/optional/Script.java
index de6bf5a36..72b8f87b2 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/Script.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/Script.java
@@ -72,7 +72,7 @@ public class Script extends Task {
}
/**
- * Load the script from an external file ; optional.
+ * Load the script from an external file; optional.
*
* @param fileName the name of the file containing the script source.
*/
@@ -132,7 +132,7 @@ public class Script extends Task {
}
/**
- * Set the encoding of the script from an external file ; optional.
+ * Set 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
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/TraXLiaison.java b/src/main/org/apache/tools/ant/taskdefs/optional/TraXLiaison.java
index f5a6717fd..71c3f0029 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/TraXLiaison.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/TraXLiaison.java
@@ -310,7 +310,6 @@ public class TraXLiaison implements XSLTLiaison4, ErrorListener, XSLTLoggerAware
/**
* Create a new transformer based on the liaison settings
- * @throws Exception thrown if there is an error during creation.
* @see #setStylesheet(java.io.File)
* @see #addParam(java.lang.String, java.lang.String)
* @see #setOutputProperty(java.lang.String, java.lang.String)
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java
index 8a25341a1..a2d1153b8 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java
@@ -145,10 +145,10 @@ public class XMLValidateTask extends Task {
* Specify the class name of the SAX parser to be used. (optional)
* @param className should be an implementation of SAX2
* org.xml.sax.XMLReader or SAX2 org.xml.sax.Parser.
- *
if className is an implementation of
+ *
If className is an implementation of
* org.xml.sax.Parser, {@link #setLenient(boolean)},
- * will be ignored.
- *
if not set, the default will be used.
+ * will be ignored.
+ *
If not set, the default will be used.
* @see org.xml.sax.XMLReader
* @see org.xml.sax.Parser
*/
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCreateTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCreateTask.java
index a3d2d468d..09b39ab2e 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCreateTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCreateTask.java
@@ -134,22 +134,22 @@ public class CCMCreateTask extends Continuus implements ExecuteStreamHandler {
if (getPlatform() != null) {
cmd.createArgument().setValue(FLAG_PLATFORM);
cmd.createArgument().setValue(getPlatform());
- } // end of if ()
+ }
if (getResolver() != null) {
cmd.createArgument().setValue(FLAG_RESOLVER);
cmd.createArgument().setValue(getResolver());
- } // end of if ()
+ }
if (getSubSystem() != null) {
cmd.createArgument().setValue(FLAG_SUBSYSTEM);
cmd.createArgument().setValue("\"" + getSubSystem() + "\"");
- } // end of if ()
+ }
if (getRelease() != null) {
cmd.createArgument().setValue(FLAG_RELEASE);
cmd.createArgument().setValue(getRelease());
- } // end of if ()
+ }
}
/**
@@ -292,7 +292,7 @@ public class CCMCreateTask extends Continuus implements ExecuteStreamHandler {
String s = reader.readLine();
if (s != null) {
log("err " + s, Project.MSG_DEBUG);
- } // end of if ()
+ }
}
}
@@ -312,15 +312,15 @@ public class CCMCreateTask extends Continuus implements ExecuteStreamHandler {
taskstring = taskstring.substring(0, taskstring.lastIndexOf(' ')).trim();
setTask(taskstring);
log("task is " + getTask(), Project.MSG_DEBUG);
- } // end of if ()
+ }
} catch (NullPointerException npe) {
- log("error procession stream , null pointer exception", Project.MSG_ERR);
+ log("error procession stream, null pointer exception", Project.MSG_ERR);
log(StringUtils.getStackTrace(npe), Project.MSG_ERR);
throw new BuildException(npe);
} catch (Exception e) {
log("error procession stream " + e.getMessage(), Project.MSG_ERR);
throw new BuildException(e.getMessage());
- } // end of try-catch
+ }
}
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMReconfigure.java b/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMReconfigure.java
index a45f8bff6..15ce99b1d 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMReconfigure.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMReconfigure.java
@@ -87,11 +87,11 @@ public class CCMReconfigure extends Continuus {
if (isRecurse()) {
cmd.createArgument().setValue(FLAG_RECURSE);
- } // end of if ()
+ }
if (isVerbose()) {
cmd.createArgument().setValue(FLAG_VERBOSE);
- } // end of if ()
+ }
if (getCcmProject() != null) {
cmd.createArgument().setValue(FLAG_PROJECT);
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckin.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckin.java
index 3e6584814..8d2c66cd5 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckin.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckin.java
@@ -29,6 +29,7 @@ import org.apache.tools.ant.types.Commandline;
*
@@ -41,7 +42,7 @@ import org.apache.tools.ant.types.Commandline;
* eltype element type
* hltype hyperlink type
* lbtype label type
- * trtype trigger type
+ * trtype trigger type
*
*
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/depend/Depend.java b/src/main/org/apache/tools/ant/taskdefs/optional/depend/Depend.java
index cb3da261f..3b6d34102 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/depend/Depend.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/depend/Depend.java
@@ -510,7 +510,7 @@ public class Depend extends MatchingTask {
* warn when a class is out of date, but not deleted as its source is unknown.
* MSG_WARN is the normal level, but we downgrade to MSG_VERBOSE for RMI files
* if {@link #warnOnRmiStubs is false}
- * @param affectedClassInfo info about the affectd class
+ * @param affectedClassInfo info about the affected class
* @param affectedClass the name of the affected .class file
* @param className the file that is triggering the out of dateness
*/
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/depend/DirectoryIterator.java b/src/main/org/apache/tools/ant/taskdefs/optional/depend/DirectoryIterator.java
index 71379188f..98c91a9f7 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/depend/DirectoryIterator.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/depend/DirectoryIterator.java
@@ -19,14 +19,14 @@ package org.apache.tools.ant.taskdefs.optional.depend;
import java.io.File;
import java.io.IOException;
+import java.io.InputStream;
+import java.nio.file.Files;
import java.util.ArrayDeque;
import java.util.Arrays;
import java.util.Collections;
import java.util.Deque;
import java.util.Iterator;
import java.util.List;
-import java.io.InputStream;
-import java.nio.file.Files;
/**
* An iterator which iterates through the contents of a java directory. The
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/depend/constantpool/InterfaceMethodRefCPInfo.java b/src/main/org/apache/tools/ant/taskdefs/optional/depend/constantpool/InterfaceMethodRefCPInfo.java
index 4f7246cb0..5a3ba0f82 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/depend/constantpool/InterfaceMethodRefCPInfo.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/depend/constantpool/InterfaceMethodRefCPInfo.java
@@ -99,7 +99,7 @@ public class InterfaceMethodRefCPInfo extends ConstantPoolEntry {
return "InterfaceMethod : Class = " + interfaceMethodClassName
+ ", name = " + interfaceMethodName + ", type = "
+ interfaceMethodType;
- }
+ }
return "InterfaceMethod : Class index = " + classIndex
+ ", name and type index = " + nameAndTypeIndex;
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/depend/constantpool/MethodHandleCPInfo.java b/src/main/org/apache/tools/ant/taskdefs/optional/depend/constantpool/MethodHandleCPInfo.java
index e304d4170..f8fbbdb04 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/depend/constantpool/MethodHandleCPInfo.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/depend/constantpool/MethodHandleCPInfo.java
@@ -29,7 +29,7 @@ public class MethodHandleCPInfo extends ConstantPoolEntry {
/** reference kind **/
private ReferenceKind referenceKind;
- /** Must be a valid index into the constant pool tabel. */
+ /** Must be a valid index into the constant pool table. */
private int referenceIndex;
/**
* the index into the constant pool which defined the name and type
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.java
index 948da53be..672a0945a 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.java
@@ -198,7 +198,7 @@ public class EjbJar extends MatchingTask {
* Stores a handle to the directory to put the Jar files in. This is
* only used by the generic deployment descriptor tool which is created
* if no other deployment descriptor tools are provided. Normally each
- * deployment tool will specify the desitination dir itself.
+ * deployment tool will specify the destination dir itself.
*/
private File destDir;
@@ -482,11 +482,11 @@ public class EjbJar extends MatchingTask {
/**
* Sets the CMP version.
+ * Must be either 1.0 or 2.0.
+ * Default is 1.0.
+ * Initially, only the JBoss implementation does something specific for CMP 2.0.
*
* @param version CMP version.
- * Must be either 1.0 or 2.0.
- * Default is 1.0.
- * Initially, only the JBoss implementation does something specific for CMP 2.0.
* @since ant 1.6
*/
public void setCmpversion(CMPVersion version) {
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.java
index d25e3c35d..bff47e980 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.java
@@ -385,7 +385,7 @@ public class GenericDeploymentTool implements EJBDeploymentTool {
try {
handler = getDescriptorHandler(config.srcDir);
- // Retrive the files to be added to JAR from EJB descriptor
+ // Retreive the files to be added to JAR from EJB descriptor
Hashtable ejbFiles = parseEjbFiles(descriptorFileName, saxParser);
// Add any support classes specified in the build file
@@ -616,7 +616,7 @@ public class GenericDeploymentTool implements EJBDeploymentTool {
/**
* Add any vendor specific files which should be included in the
* EJB Jar.
- * @param ejbFiles a hashtable entryname -> file.
+ * @param ejbFiles a hashtable entryname -> file.
* @param ddPrefix a prefix to use.
*/
protected void addVendorFiles(Hashtable ejbFiles, String ddPrefix) {
@@ -626,7 +626,9 @@ public class GenericDeploymentTool implements EJBDeploymentTool {
/**
* Get the vendor specific name of the Jar that will be output. The modification date
* of this jar will be checked against the dependent bean classes.
+ *
* @param baseName the basename to use.
+ * @return File
*/
File getVendorOutputJarFile(String baseName) {
return new File(destDir, baseName + genericJarSuffix);
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.java
index 181720f78..fd7517f05 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.java
@@ -35,9 +35,8 @@ import org.xml.sax.SAXException;
* ejbjar task. If only stubs and skeletons need to be generated
* (in other words, if no JAR file needs to be created), refer to the
* iplanet-ejbc task and the IPlanetEjbcTask class.
- *
- * The following attributes may be specified by the user:
- *
+ *
The following attributes may be specified by the user:
+ *
*
destdir -- The base directory into which the generated JAR
* files will be written. Each JAR file is written
* in directories which correspond to their location
@@ -72,15 +71,14 @@ import org.xml.sax.SAXException;
*
suffix -- String value appended to the JAR filename when
* creating each JAR. This attribute is not required
* (if omitted, it defaults to ".jar").
- *
- *
- * For each EJB descriptor found in the "ejbjar" parent task, this deployment
+ *
+ *
For each EJB descriptor found in the "ejbjar" parent task, this deployment
* tool will locate the three classes that comprise the EJB. If these class
* files cannot be located in the specified srcdir directory, the
* task will fail. The task will also attempt to locate the EJB stubs and
* skeletons in this directory. If found, the timestamps on the stubs and
* skeletons will be checked to ensure they are up to date. Only if these files
- * cannot be found or if they are out of date will ejbc be called.
+ * cannot be found or if they are out of date will ejbc be called.
*
* @see IPlanetEjbc
*/
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.java
index c15a07a54..3e1f21e09 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.java
@@ -57,16 +57,14 @@ import org.apache.tools.ant.util.StringUtils;
* and skeletons in the specified destination directory. Only if the stubs and
* skeletons cannot be found or if they're out of date will the iPlanet
* Application Server ejbc utility be run.
- *
- * Because this class (and it's assorted inner classes) may be bundled into the
+ *
Because this class (and it's assorted inner classes) may be bundled into the
* iPlanet Application Server distribution at some point (and removed from the
* Ant distribution), the class has been written to be independent of all
* Ant-specific classes. It is also for this reason (and to avoid cluttering
* the Apache Ant source files) that this utility has been packaged into a
- * single source file.
- *
- * For more information on Ant Tasks for iPlanet Application Server, see the
- * IPlanetDeploymentTool and IPlanetEjbcTask classes.
+ * single source file.
+ *
For more information on Ant Tasks for iPlanet Application Server, see the
+ * IPlanetDeploymentTool and IPlanetEjbcTask classes.
*
* @see IPlanetDeploymentTool
* @see IPlanetEjbcTask
@@ -318,15 +316,12 @@ public class IPlanetEjbc {
} catch (IOException e) {
System.out.println("An IOException has occurred while reading the "
+ "XML descriptors (" + e.getMessage() + ").");
- return;
} catch (SAXException e) {
System.out.println("A SAXException has occurred while reading the "
+ "XML descriptors (" + e.getMessage() + ").");
- return;
} catch (IPlanetEjbc.EjbcException e) {
System.out.println("An error has occurred while executing the ejbc "
+ "utility (" + e.getMessage() + ").");
- return;
}
}
@@ -398,7 +393,7 @@ public class IPlanetEjbc {
private void callEjbc(String[] arguments) {
- /* If an iAS home directory is specified, prepend it to the commmand */
+ /* If an iAS home directory is specified, prepend it to the command */
String command;
if (iasHomeDir == null) {
command = "";
@@ -1060,7 +1055,8 @@ public class IPlanetEjbc {
if (hasession && (!beantype.equals(STATEFUL_SESSION))) {
System.out.println(
- "Highly available stubs and skeletons may only be generated for a Stateful Session Bean -- the \"hasession\" attribute will be ignored for the "
+ "Highly available stubs and skeletons may only be generated for a Stateful Session Bean"
+ + "-- the \"hasession\" attribute will be ignored for the "
+ name + " EJB.");
}
@@ -1106,12 +1102,9 @@ public class IPlanetEjbc {
* implementation) and returns the modification timestamp for the
* "oldest" class.
*
- * @param classpath The classpath to be used to find the source EJB
- * classes. If null, the system classpath
- * is used.
+ * @param buildDir The directory to be used to find the source EJB
+ * classes.
* @return The modification timestamp for the "oldest" EJB source class.
- * @throws BuildException If one of the EJB source classes cannot be
- * found on the classpath.
*/
private long sourceClassesModified(File buildDir) {
long latestModified; // The timestamp of the "newest" class
@@ -1198,16 +1191,14 @@ public class IPlanetEjbc {
/**
* Examines each of the EJB stubs and skeletons in the destination
* directory and returns the modification timestamp for the "oldest"
- * class. If one of the stubs or skeletons cannot be found, -1
- * is returned.
+ * class. If one of the stubs or skeletons cannot be found,
+ * -1 is returned.
*
- * @param dest The directory in which the EJB stubs and skeletons are
+ * @param destDir The directory in which the EJB stubs and skeletons are
* stored.
* @return The modification timestamp for the "oldest" EJB stub or
- * skeleton. If one of the classes cannot be found, -1
- * is returned.
- * @throws BuildException If the canonical path of the destination
- * directory cannot be found.
+ * skeleton. If one of the classes cannot be found,
+ * -1 is returned.
*/
private long destClassesModified(File destDir) {
String[] classnames = classesToGenerate(); // List of all stubs & skels
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/JbossDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/JbossDeploymentTool.java
index c3a48ecae..895129293 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/JbossDeploymentTool.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/JbossDeploymentTool.java
@@ -75,7 +75,6 @@ public class JbossDeploymentTool extends GenericDeploymentTool {
} else {
log("Unable to locate jboss cmp descriptor. It was expected to be in "
+ jbossCMPD.getPath(), Project.MSG_VERBOSE);
- return;
}
}
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/OrionDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/OrionDeploymentTool.java
index 38e2ae3cc..03db7c591 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/OrionDeploymentTool.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/OrionDeploymentTool.java
@@ -35,13 +35,15 @@ public class OrionDeploymentTool extends GenericDeploymentTool {
protected static final String ORION_DD = "orion-ejb-jar.xml";
-
/** Instance variable that stores the suffix for the jboss jarfile. */
private String jarSuffix = ".jar";
/**
* Add any vendor specific files which should be included in the
* EJB Jar.
+ *
+ * @param ejbFiles Hashtable<String, File>
+ * @param baseName String
*/
protected void addVendorFiles(Hashtable ejbFiles, String baseName) {
String ddPrefix = (usingBaseJarName() ? "" : baseName );
@@ -51,7 +53,6 @@ public class OrionDeploymentTool extends GenericDeploymentTool {
ejbFiles.put(META_DIR + ORION_DD, orionDD);
} else {
log("Unable to locate Orion deployment descriptor. It was expected to be in " + orionDD.getPath(), Project.MSG_WARN);
- return;
}
}
@@ -59,6 +60,8 @@ public class OrionDeploymentTool extends GenericDeploymentTool {
/**
* Get the vendor specific name of the Jar that will be output. The modification date
* of this jar will be checked against the dependent bean classes.
+ *
+ * @param baseName String
*/
File getVendorOutputJarFile(String baseName) {
return new File(getDestDir(), baseName + jarSuffix);
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WebsphereDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WebsphereDeploymentTool.java
index 6acdc4781..2ea7279d5 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WebsphereDeploymentTool.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WebsphereDeploymentTool.java
@@ -156,7 +156,7 @@ public class WebsphereDeploymentTool extends GenericDeploymentTool {
this.wasClasspath = wasClasspath;
}
- /** Sets the DB Vendor for the Entity Bean mapping ; optional.
+ /** Sets the DB Vendor for the Entity Bean mapping; optional.
*
* Valid options can be obtained by running the following command:
*
@@ -258,7 +258,7 @@ public class WebsphereDeploymentTool extends GenericDeploymentTool {
}
/**
- * Flag to use the WebSphere 3.5 compatible mapping rules ; optional, default false.
+ * Flag to use the WebSphere 3.5 compatible mapping rules; optional, default false.
*
* @param attr a boolean value.
*/
@@ -381,7 +381,7 @@ public class WebsphereDeploymentTool extends GenericDeploymentTool {
/**
* Add any vendor specific files which should be included in the EJB Jar.
- * @param ejbFiles a hashtable entryname -> file.
+ * @param ejbFiles a hashtable entryname -> file.
* @param baseName a prefix to use.
*/
@Override
@@ -441,7 +441,7 @@ public class WebsphereDeploymentTool extends GenericDeploymentTool {
log("Unable to locate the websphere Schema: "
+ websphereSchema.getPath(), Project.MSG_VERBOSE);
}
- // Theres nothing else to see here...keep moving sonny
+ // There is nothing else to see here...keep moving sonny
} catch (Exception e) {
throw new BuildException(
"Exception while adding Vendor specific files: "
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 1d748e451..262753cc7 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.
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 5c3240dcb..8e1ef163b 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.
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 7ed5fb991..4be001cf2 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 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)
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 84ba74add..cde8834d2 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 extensionFileSets = new Vector<>();
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 0f316573f..82820335f 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 libraryFileSets = new Vector<>();
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 6e5329448..78343092b 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
*/
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 5cdc32fc6..e1be0553a 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.
*/
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 bade00f32..3a877ac82 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
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 d3eb0566b..0d2af0d08 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.
*
*/
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 ea8405ce3..f1d33e29f 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.
*
- *
Note this is very inefficent and should probably be fixed
+ *
Note this is very inefficient and should probably be fixed
* in the future.
*
* @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
*/
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 3ec7d77a0..edcced8a1 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
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 53b234b05..ac4762eeb 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,
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 21d847829..b5296bdfb 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.
- *
Implement the isActionValid() method to insure the
- * action supplied as the "action" attribute of ServerDeploy is valid.
+ *
Implement the isActionValid() method to insure the
+ * action supplied as the "action" attribute of ServerDeploy is valid.
*
Implement the validateAttributes() 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.
*
Add a add<TOOL> method to the ServerDeploy
* class. This method will be called when Ant encounters a
* add<TOOL> task nested in the
- * serverdeploy task.
+ * serverdeploy task.
*
Define the deploy 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...
*
* @see org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool
* @see org.apache.tools.ant.taskdefs.optional.j2ee.ServerDeploy
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 6e7f11882..f5c908c4d 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.
+ * Validates the passed in attributes.
*
- * The rules are:
- *
+ *
The rules are:
+ *
*
If action is "deploy" or "update" the "application"
- * and "source" attributes must be supplied.
+ * and "source" attributes must be supplied.
*
If action is "delete" or "undeploy" the
- * "application" attribute must be supplied.
+ * "application" attribute must be supplied.
+ *
*
- *@exception BuildException Description
- * of Exception
+ * @exception BuildException if something goes wrong
*/
@Override
public void validateAttributes() throws BuildException {
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 e186dcb46..2838c2d94 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.
*
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.
*
* @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.
- *
The rules are:
+ *
The rules are:
*
If action is "deploy" or "update" the "application" and "source"
- * attributes must be supplied.
+ * attributes must be supplied.
*
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.
+ *
+ * @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.
- *
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.
+ *
Valid actions are contained in the static array VALID_ACTIONS
+ * @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 -debug " portion
- // of the commmand line
+ // of the command line
return new StringBuffer(STRING_BUFFER_SIZE)
.append((getServer() != null)
? "-url " + getServer()
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 e3bca20cc..433ce22f1 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; null 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) {
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 331c97558..c1febfa7f 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 true if a JVM should be forked,
- * otherwise false
+ * otherwise false
*/
public void setFork(boolean value) {
fork = value;
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 4e4b0aaaf..db8b3a333 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.
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.
+ *
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.
*
- *
The task requires the srcdir and destdir attributes to be
+ *
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).
- *
This task supports the nested elements classpath (A Path) and
- * classpathref (A Reference) which can be used in preference to the
+ * compiler).
+ *
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.
Large Amount of cutting and pasting from the Javac task...
+ *
Large amount of cutting and pasting from the Javac task...
* @since 1.5
*/
public class JspC extends MatchingTask {
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 303ef6f37..5814597a9 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
*/
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 16b67f9d6..68e693c2d 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.
*
*
A compiler adapter is an adapter that interprets the jspc's
* parameters in preparation to be passed off to the compiler this
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 046296980..6beb81c2a 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() {
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 fb5d44b5e..11271bf2e 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;
/**
- *
Create then run JUnitTest's based on the list of files
- * given by the fileset attribute.
+ *
Create then run JUnitTest's based on the list of files
+ * given by the fileset attribute.
*
- *
Every .java or .class file in the fileset is
+ *
Every .java or .class file in the fileset is
* assumed to be a testcase.
* A JUnitTest is created for each of these named classes with
- * basic setup inherited from the parent BatchTest.
+ * basic setup inherited from the parent BatchTest.
*
* @see JUnitTest
*/
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 975de6894..4f00180e7 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;
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 1ca4a0c0b..d965e4c11 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 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
- * null 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
+ * null enumeration elements in the array.
+ * @param object type
+ * @param enums the array of enumerations.
+ * @return the enumeration over the array of enumerations.
*/
@SafeVarargs
public static Enumeration fromCompound(Enumeration extends T>... enums) {
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 26ef42463..f2a570a12 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;
*
*
* 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 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)
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 81841a01b..d76e06c1a 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;
/**
- *
A wrapper for the implementations of JUnitResultFormatter.
+ *
A wrapper for the implementations of JUnitResultFormatter.
* In particular, used as a nested <formatter> element in
- * a <junit> task.
- *
At the moment, there are three supported standard formatters.
+ *
At the moment, there are three supported standard formatters.
*
- *
The xml type uses a XMLJUnitResultFormatter.
- *
The brief type uses a BriefJUnitResultFormatter.
- *
The plain type (the default) uses a PlainJUnitResultFormatter.
- *
The failure type uses a FailureRecorder.
+ *
The xml type uses a XMLJUnitResultFormatter.
+ *
The brief type uses a BriefJUnitResultFormatter.
+ *
The plain type (the default) uses a PlainJUnitResultFormatter.
+ *
The failure type uses a FailureRecorder.
*
*
- *
Sets classname attribute - so you can't use that
- * attribute if you use this one.
+ *
Sets classname attribute - so you can't use that
+ * attribute if you use this one.
+ *
* @param type the enumerated value to use.
*/
public void setType(TypeAttribute type) {
@@ -119,9 +121,9 @@ public class FormatterElement {
}
/**
- *
Set name of class to be used as the formatter.
+ * Set name of class to be used as the formatter.
+ *
This class must implement JUnitResultFormatter
*
- *
This class must implement JUnitResultFormatter
* @param classname the name of the formatter class.
*/
public void setClassname(String classname) {
@@ -166,18 +168,18 @@ public class FormatterElement {
}
/**
- *
Set the file which the formatte should log to.
+ * Set the file which the formatter should log to.
*
- *
Set output stream for formatter to use.
+ * Set output stream for formatter to use.
*
- *
Defaults to standard out.
+ *
Defaults to standard out.
* @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 {
}
/**
- *
Enumerated attribute with the values "plain", "xml", "brief" and "failure".
+ * Enumerated attribute with the values "plain", "xml", "brief" and "failure".
*
- *
Use to enumerate options for type attribute.
+ *
Use to enumerate options for type attribute.
*/
public static class TypeAttribute extends EnumeratedAttribute {
/** {@inheritDoc}. */
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 6741912e9..2c3103a71 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.
- * Note: Tests that throw assumption failures will still report
+ * listener handles this is up to that specific listener.
+ *
Note: 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.
* @param test the details of the test and failure that have triggered this report.
* @param exception the AssumptionViolatedException thrown from the current assumption failure.
*/
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 d37337ab0..b1f477949 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.
*
- *
JUnit is a framework to create unit tests. It has been initially
+ *
JUnit is a framework to create unit tests. It has been initially
* created by Erich Gamma and Kent Beck. JUnit can be found at http://www.junit.org.
*
- *
JUnitTask can run a single specific
+ *
JUnitTask can run a single specific
* JUnitTest using the test element.
runs a single junit test
* (org.apache.ecs.InternationalCharTest) in the current
* VM using the path with id classpath as classpath and
* presents the results formatted using the standard
* plain formatter on the command line.
*
- *
This task can also run batches of tests. The
+ *
This task can also run batches of tests. The
* batchtest element creates a BatchTest
* based on a fileset. This allows, for example, all classes found in
* directory to be run as testcases.
this target finds any classes with a test directory
* anywhere in their path (under the top ${tests.dir}, of
* course) and creates JUnitTest's for each one.
*
- *
Of course, <junit> and
+ *
Of course, <junit> and
* <batch> elements can be combined for more
* complex tests. For an example, see the ant build.xml
* target run-tests (the second example is an edited
* version).
*
- *
To spawn a new Java VM to prevent interferences between
+ *
To spawn a new Java VM to prevent interferences between
* different testcases, you need to enable fork. 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.
* @param value false if it should not filter, otherwise
- * true
+ * true
*
* @since Ant 1.5
*/
@@ -335,6 +335,7 @@ public class JUnitTask extends Task {
*
This attribute will be ignored if tests run in the same VM
* as Ant.
*
+ * @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 true to print a summary,
- * withOutAndErr to include the test's output as
+ * withOutAndErr to include the test's output as
* well, false 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 {
*
*
If the test is running for more than this value, the test
* will be canceled. (works only when in 'fork' mode).
+ *
* @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 -mx or -Xmx
* 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.
+ *
This might be useful to transfer Ant properties to the
+ * testcases when JVM forking is not enabled.
*
* @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.
*
*
Will be ignored if we are not forking a new VM.
+ *
* @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 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.
*
*
Doesn't have any effect unless fork is true.
+ *
* @param cloneVm a boolean value.
* @since Ant 1.7
*/
@@ -731,6 +738,7 @@ public class JUnitTask extends Task {
*
This value will be overridden by the magic property
* ant.junit.enabletestlistenerevents if it has been set.
*
+ * @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
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 2ec56535a..d7889ba70 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;
/**
- *
Run a single JUnit test.
+ * Run a single JUnit test.
*
- *
The JUnit test is actually run by {@link JUnitTestRunner}.
- * So read the doc comments for that class :)
+ *
The JUnit test is actually run by {@link JUnitTestRunner}.
+ * So read the doc comments for that class :)
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
- *
+ *
* public static junit.framework.Test suite()
- *
+ *
*
- *
If no such method exists, all public methods starting with
- * "test" and taking no argument will be run.
+ *
If no such method exists, all public methods starting with
+ * "test" and taking no argument will be run.
*
- *
Summary output is generated at the end.
+ *
Summary output is generated at the end.
*
* @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.
- *
+ *
* Parameters: testcaseclassname plus parameters in the format
* key=value, none of which is required.
- *
- *
- *
key
description
default value
- *
- *
haltOnError
halt test on
- * errors?
false
- *
- *
haltOnFailure
halt test on
- * failures?
false
- *
- *
formatter
A JUnitResultFormatter given as
+ *
+ *
+ *
Test runner attributes
+ *
+ *
key
description
default value
+ *
+ *
+ *
haltOnError
halt test on errors?
false
+ *
+ *
+ *
haltOnFailure
halt test on failures?
false
+ *
+ *
+ *
formatter
A JUnitResultFormatter given as
* classname,filename. If filename is omitted, System.out is
- * assumed.
none
- *
- *
showoutput
send output to System.err/.out as
- * well as to the formatters?
false
- *
- *
logtestlistenerevents
log TestListener events to
- * System.out.
false
- *
- *
methods
Comma-separated list of names of individual
- * test methods to execute.
- *
null
- *
+ * assumed.
none
+ *
+ *
+ *
showoutput
send output to System.err/.out as
+ * well as to the formatters?
false
+ *
+ *
+ *
logtestlistenerevents
log TestListener events to
+ * System.out.
false
+ *
+ *
+ *
methods
Comma-separated list of names of individual
+ * test methods to execute.
null
+ *
*
* @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=(,)?
+ * 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
+}
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 85cfb0c79..0d71cd2b5 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
+}
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 03760cc92..c29271d9e 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;
/**
- *
Interface groups XML constants.
+ *
Interface groups XML constants.
* Interface that groups all constants used throughout the XML
* documents that are generated by the XMLJUnitResultFormatter.
- *
+ *
* @see XMLJUnitResultFormatter
* @see XMLResultAggregator
*/
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 d62a847d4..ed282207a 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
+}
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 b877c0bb8..71cd82870 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.
*
- *
The main problem is due to the fact that a JVM can be forked for a testcase
+ *
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.
*
* @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 todir 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 {
}
/**
- *
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 {
}
/**
- *
Add a new testsuite node to the document.
+ *
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.
- *
For example: org.apache.Whatever will be split into
- * org.apache and Whatever.
+ * split the previous fully qualified name into a package and a name.
+ *
For example: org.apache.Whatever will be split into
+ * org.apache and Whatever.
+ *
* @param root the root element to which the testsuite node should
* be appended.
* @param testsuite the element to append to the given root. It will slightly
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 438bfe9e7..51ff3f952 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
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 2a5239022..72f45e0a9 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:
*
- *
send - send files to a remote server. This is the
+ *
send - send files to a remote server. This is the
* default action.
- *
get - retrieve files from a remote server.
- *
del - delete files from a remote server.
- *
list - create a file listing.
- *
chmod - change unix file permissions.
- *
rmdir - remove directories, if empty, from a
+ *
get - retrieve files from a remote server.
+ *
del - delete files from a remote server.
+ *
list - create a file listing.
+ *
chmod - change unix file permissions.
+ *
rmdir - remove directories, if empty, from a
* remote server.
*
* Note: 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.
*/
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 2e5228d9b..c96d16aaf 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) {
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 f546b230b..817345c43 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. filename may
* contain a relative path specification.
*
- * 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.
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 9d844a157..1492ae5fa 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 Merant.
- *
+ *
* 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.
- *
+ *
* This version has been tested against PVCS version 6.5 and 6.6 under Windows and Solaris.
*
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 35d873cc8..4aad07b20 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
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 66e0eb2a5..c9b462d5a 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
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 3a82ea4f9..fe8bd0ec5 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.
*
* @return Commandline the generated command to be executed
*/
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 a7b23c5bb..447be0e53 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
- *
+ * Build the command line
+ *
*
* @return Commandline the generated command to be executed
*/
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 b17e0c16f..c55165eec 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
- *
+ * Build the command line
+ *
*
* @return Commandline the generated command to be executed
*/
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 a0538c21c..401c7d736 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.
- The <SOSGet> Retreives file(s) from a SOS database
- The <SOSCheckin> Commits and unlocks file(s) in a SOS database
- The <SOSCheckout> Retreives and lock file(s) in a SOS database
- The <SOSLabel> Label a SOS database
+ The <SOSGet> Retrieves file(s) from a SOS database
+ The <SOSCheckin> Commits and unlocks file(s) in a SOS database
+ The <SOSCheckout> Retrieves and lock file(s) in a SOS database
+ The <SOSLabel> Label a SOS database