true if the introspected class is dynamic;
- * false otherwise.
+ * @return true if the introspected class is dynamic;
+ * false otherwise.
* @since Ant 1.6.3
*
* @see DynamicElement
@@ -664,8 +664,8 @@ public final class IntrospectionHelper {
* Indicates whether the introspected class is a task container,
* supporting arbitrary nested tasks/types.
*
- * @return true if the introspected class is a container;
- * false otherwise.
+ * @return true if the introspected class is a container;
+ * false otherwise.
* @since Ant 1.6.3
*
* @see TaskContainer
@@ -984,13 +984,13 @@ public final class IntrospectionHelper {
* Returns a read-only list of extension points supported
* by the introspected class.
*
- * A task/type or nested element with void methods named add()
+ * A task/type or nested element with void methods named add()
* or addConfigured(), taking a single class or interface
* argument, supports extensions point. This method returns the list of
* all these void add[Configured](type) methods.
*
* @return a list of void, single argument add() or addConfigured()
- * Methods of all supported extension points.
+ * Methods of all supported extension points.
* These methods are sorted such that if the argument type of a
* method derives from another type also an argument of a method
* of this list, the method with the most derived argument will
diff --git a/src/main/org/apache/tools/ant/ProjectHelper.java b/src/main/org/apache/tools/ant/ProjectHelper.java
index fa54a9f24..a95c2668a 100644
--- a/src/main/org/apache/tools/ant/ProjectHelper.java
+++ b/src/main/org/apache/tools/ant/ProjectHelper.java
@@ -48,7 +48,7 @@ public class ProjectHelper {
* */
public static final String ANT_ATTRIBUTE_URI = "ant:attribute";
- /** The URI for defined types/tasks - the format is antlib: */
+ /** The URI for defined types/tasks - the format is antlib:<package> */
public static final String ANTLIB_URI = "antlib:";
/** Polymorphic attribute */
@@ -296,7 +296,7 @@ public class ProjectHelper {
}
/**
- * JDK1.1 compatible access to the context class loader. Cut & paste from JAXP.
+ * JDK1.1 compatible access to the context class loader. Cut & paste from JAXP.
*
* @deprecated since 1.6.x.
* Use LoaderUtils.getContextClassLoader()
diff --git a/src/main/org/apache/tools/ant/PropertyHelper.java b/src/main/org/apache/tools/ant/PropertyHelper.java
index a6f60b610..1dbb280c9 100644
--- a/src/main/org/apache/tools/ant/PropertyHelper.java
+++ b/src/main/org/apache/tools/ant/PropertyHelper.java
@@ -1125,7 +1125,7 @@ public class PropertyHelper implements GetProperty {
/**
* Get all Delegate interfaces (excluding Delegate itself) from the specified Delegate.
* @param d the Delegate to inspect.
- * @return Set
+ * @return Set<Class>
* @since Ant 1.8.0
*/
protected static Set> getDelegateInterfaces(Delegate d) {
diff --git a/src/main/org/apache/tools/ant/dispatch/DispatchTask.java b/src/main/org/apache/tools/ant/dispatch/DispatchTask.java
index 817b90cfe..a848ed138 100644
--- a/src/main/org/apache/tools/ant/dispatch/DispatchTask.java
+++ b/src/main/org/apache/tools/ant/dispatch/DispatchTask.java
@@ -23,8 +23,8 @@ 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/ConcatFilter.java b/src/main/org/apache/tools/ant/filters/ConcatFilter.java
index 3d0943bed..a7b080cb3 100644
--- a/src/main/org/apache/tools/ant/filters/ConcatFilter.java
+++ b/src/main/org/apache/tools/ant/filters/ConcatFilter.java
@@ -27,15 +27,16 @@ import org.apache.tools.ant.types.Parameter;
/**
* Concats a file before and/or after the file.
*
- * Example:
- *
- *
- *
- *
+ * Example:
+ * <copy todir="build">
+ * <fileset dir="src" includes="*.java"/>
+ * <filterchain>
+ * <concatfilter prepend="apache-license-java.txt"/>
+ * </filterchain>
+ * </copy>
*
- * Copies all java sources from src to build and adds the
+ *
+ * Copies all java sources from src to build and adds the
* content of apache-license-java.txt add the beginning of each
* file.
*
diff --git a/src/main/org/apache/tools/ant/filters/TokenFilter.java b/src/main/org/apache/tools/ant/filters/TokenFilter.java
index c90cce595..cdfcd0656 100644
--- a/src/main/org/apache/tools/ant/filters/TokenFilter.java
+++ b/src/main/org/apache/tools/ant/filters/TokenFilter.java
@@ -365,7 +365,7 @@ public class TokenFilter extends BaseFilterReader
/**
* Filter a string 'line' replacing from with to
- * (C&P from the Replace task)
+ * (Copy&Paste from the Replace task)
* @param line the string to be filtered
* @return the filtered line
*/
@@ -684,7 +684,7 @@ public class TokenFilter extends BaseFilterReader
* xml does not do "c" like interpretation of strings.
* i.e. \n\r\t etc.
* this method processes \n, \r, \t, \f, \\
- * also subs \s -> " \n\r\t\f"
+ * also subs \s with " \n\r\t\f"
* a trailing '\' will be ignored
*
* @param input raw string with possible embedded '\'s
@@ -696,12 +696,12 @@ public class TokenFilter extends BaseFilterReader
/**
* convert regex option flag characters to regex options
- *
+ *
* - g - Regexp.REPLACE_ALL
* - i - Regexp.MATCH_CASE_INSENSITIVE
* - m - Regexp.MATCH_MULTILINE
* - s - Regexp.MATCH_SINGLELINE
- *
+ *
* @param flags the string containing the flags
* @return the Regexp option bits
*/
diff --git a/src/main/org/apache/tools/ant/listener/AnsiColorLogger.java b/src/main/org/apache/tools/ant/listener/AnsiColorLogger.java
index 39c96cce3..f6a988caa 100644
--- a/src/main/org/apache/tools/ant/listener/AnsiColorLogger.java
+++ b/src/main/org/apache/tools/ant/listener/AnsiColorLogger.java
@@ -29,72 +29,76 @@ import org.apache.tools.ant.Project;
* Uses ANSI Color Code Sequences to colorize messages
* sent to the console.
*
- * If used with the -logfile option, the output file
+ * If used with the -logfile option, the output file
* will contain all the necessary escape codes to
* display the text in colorized mode when displayed
* in the console using applications like cat, more,
- * etc.
+ * etc.
*
- * This is designed to work on terminals that support ANSI
+ * This is designed to work on terminals that support ANSI
* color codes. It works on XTerm, ETerm, Mindterm, etc.
- * It also works on Win9x (with ANSI.SYS loaded.)
+ * It also works on Win9x (with ANSI.SYS loaded.)
*
- * NOTE:
+ * NOTE:
* It doesn't work on WinNT's COMMAND.COM even with
- * ANSI.SYS loaded.
+ * ANSI.SYS loaded.
*
- * The default colors used for differentiating
+ * The default colors used for differentiating
* the message levels can be changed by editing the
* /org/apache/tools/ant/listener/defaults.properties
* file.
- * This file contains 5 key/value pairs:
+ * This file contains 5 key/value pairs:
+ *
* AnsiColorLogger.ERROR_COLOR=2;31
* AnsiColorLogger.WARNING_COLOR=2;35
* AnsiColorLogger.INFO_COLOR=2;36
* AnsiColorLogger.VERBOSE_COLOR=2;32
* AnsiColorLogger.DEBUG_COLOR=2;34
+ *
*
- * Another option is to pass a system variable named
+ * Another option is to pass a system variable named
* ant.logger.defaults, with value set to the path of
* the file that contains user defined Ansi Color
- * Codes, to the java command using -D option.
+ * Codes, to the java command using -D option.
*
* To change these colors use the following chart:
*
- * ANSI COLOR LOGGER CONFIGURATION
+ * ANSI COLOR LOGGER CONFIGURATION
*
* Format for AnsiColorLogger.*=
* Attribute;Foreground;Background
*
- * Attribute is one of the following:
- * 0 -> Reset All Attributes (return to normal mode)
- * 1 -> Bright (Usually turns on BOLD)
- * 2 -> Dim
- * 3 -> Underline
- * 5 -> link
- * 7 -> Reverse
- * 8 -> Hidden
- *
- * Foreground is one of the following:
- * 30 -> Black
- * 31 -> Red
- * 32 -> Green
- * 33 -> Yellow
- * 34 -> Blue
- * 35 -> Magenta
- * 36 -> Cyan
- * 37 -> White
- *
- * Background is one of the following:
- * 40 -> Black
- * 41 -> Red
- * 42 -> Green
- * 43 -> Yellow
- * 44 -> Blue
- * 45 -> Magenta
- * 46 -> Cyan
- * 47 -> White
+ * Attribute is one of the following:
+ * 0 -> Reset All Attributes (return to normal mode)
+ * 1 -> Bright (Usually turns on BOLD)
+ * 2 -> Dim
+ * 3 -> Underline
+ * 5 -> link
+ * 7 -> Reverse
+ * 8 -> Hidden
+ *
+ *
+ * Foreground is one of the following:
+ * 30 -> Black
+ * 31 -> Red
+ * 32 -> Green
+ * 33 -> Yellow
+ * 34 -> Blue
+ * 35 -> Magenta
+ * 36 -> Cyan
+ * 37 -> White
+ *
*
+ * Background is one of the following:
+ * 40 -> Black
+ * 41 -> Red
+ * 42 -> Green
+ * 43 -> Yellow
+ * 44 -> Blue
+ * 45 -> Magenta
+ * 46 -> Cyan
+ * 47 -> White
+ *
*/
public class AnsiColorLogger extends DefaultLogger {
// private static final int ATTR_NORMAL = 0;
diff --git a/src/main/org/apache/tools/ant/taskdefs/Ant.java b/src/main/org/apache/tools/ant/taskdefs/Ant.java
index 8c52f919f..eba4731a5 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Ant.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Ant.java
@@ -24,21 +24,22 @@ import java.io.IOException;
import java.io.PrintStream;
import java.lang.reflect.Method;
import java.util.Enumeration;
+import java.util.HashSet;
import java.util.Hashtable;
import java.util.Iterator;
-import java.util.Vector;
import java.util.Set;
-import java.util.HashSet;
+import java.util.Vector;
+
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.BuildListener;
import org.apache.tools.ant.DefaultLogger;
+import org.apache.tools.ant.MagicNames;
+import org.apache.tools.ant.Main;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.ProjectComponent;
import org.apache.tools.ant.ProjectHelper;
import org.apache.tools.ant.Target;
import org.apache.tools.ant.Task;
-import org.apache.tools.ant.MagicNames;
-import org.apache.tools.ant.Main;
import org.apache.tools.ant.types.PropertySet;
import org.apache.tools.ant.util.FileUtils;
import org.apache.tools.ant.util.VectorSet;
@@ -51,8 +52,8 @@ import org.apache.tools.ant.util.VectorSet;
* <ant antfile="build.xml" target="bar" >
* <property name="property1" value="aaaaa" />
* <property name="foo" value="baz" />
- * </ant>
- * </target>
+ * </ant>
+ * </target>
*
* <target name="bar" depends="init">
* <echo message="prop is ${property1} ${foo}" />
diff --git a/src/main/org/apache/tools/ant/taskdefs/Apt.java b/src/main/org/apache/tools/ant/taskdefs/Apt.java
index 3f91af21d..5b76b5843 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Apt.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Apt.java
@@ -48,7 +48,7 @@ public class Apt
/** An warning message when ignoring compiler attribute. */
public static final String ERROR_IGNORING_COMPILER_OPTION
= "Ignoring compiler attribute for the APT task, as it is fixed";
- /** A warning message if used with java < 1.5. */
+ /** A warning message if used with java < 1.5. */
public static final String ERROR_WRONG_JAVA_VERSION
= "Apt task requires Java 1.5+";
diff --git a/src/main/org/apache/tools/ant/taskdefs/Componentdef.java b/src/main/org/apache/tools/ant/taskdefs/Componentdef.java
index 275c9f0d7..36a0c0fda 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Componentdef.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Componentdef.java
@@ -20,10 +20,10 @@ package org.apache.tools.ant.taskdefs;
/**
* Adds a component definition to the current project.
- * used in the current project. Two attributes are needed, the name that identifies
- * this component uniquely, and the full name of the class (
- * including the packages) that
+ * Used in the current project two attributes are needed, the name that identifies
+ * this component uniquely, and the full name of the class (including the packages) that
* implements this component.
+ *
* @since Ant 1.8
* @ant.task category="internal"
*/
@@ -31,10 +31,9 @@ public class Componentdef extends Definer {
/**
* Default constructor.
- * Creates a new ComponentDef instance.
+ * Creates a new Componentdef instance.
* Sets the restrict attribute to true.
*/
-
public Componentdef() {
setRestrict(true);
}
diff --git a/src/main/org/apache/tools/ant/taskdefs/Concat.java b/src/main/org/apache/tools/ant/taskdefs/Concat.java
index 930ce27b6..0907fdff9 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Concat.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Concat.java
@@ -813,7 +813,7 @@ public class Concat extends Task implements ResourceCollection {
/**
* Implement ResourceCollection.
- * @return Iterator.
+ * @return Iterator<Resource>.
*/
public Iterator iterator() {
validate();
diff --git a/src/main/org/apache/tools/ant/taskdefs/Copy.java b/src/main/org/apache/tools/ant/taskdefs/Copy.java
index 2bc99c22a..c17ea458f 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Copy.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Copy.java
@@ -50,7 +50,7 @@ import org.apache.tools.ant.util.SourceFileScanner;
import org.apache.tools.ant.util.FlatFileNameMapper;
/**
- * Copies a file or directory to a new file
+ * Copies a file or directory to a new file
* or directory. Files are only copied if the source file is newer
* than the destination file, or when the destination file does not
* exist. It is possible to explicitly overwrite existing files.
diff --git a/src/main/org/apache/tools/ant/taskdefs/Definer.java b/src/main/org/apache/tools/ant/taskdefs/Definer.java
index ecd11dfd7..894bc9356 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Definer.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Definer.java
@@ -155,11 +155,11 @@ public abstract class Definer extends DefBase {
/**
* What to do if there is an error in loading the class.
- *
+ *
* - error - throw build exception
* - report - output at warning level
* - ignore - output at debug level
- *
+ *
*
* @param onError an OnError value
*/
diff --git a/src/main/org/apache/tools/ant/taskdefs/Exit.java b/src/main/org/apache/tools/ant/taskdefs/Exit.java
index c0a654a45..0eca50952 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Exit.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Exit.java
@@ -37,7 +37,7 @@ import org.apache.tools.ant.taskdefs.condition.ConditionBase;
*
* If both attributes are set, then the test fails only if both tests
* are true. i.e.
- * fail := defined(ifProperty) && !defined(unlessProperty)
+ * fail := defined(ifProperty) && !defined(unlessProperty)
*
* A single nested<condition> element can be specified
* instead of using if/unless (a combined
diff --git a/src/main/org/apache/tools/ant/taskdefs/JDBCTask.java b/src/main/org/apache/tools/ant/taskdefs/JDBCTask.java
index 0f5e6c960..d65ddb459 100644
--- a/src/main/org/apache/tools/ant/taskdefs/JDBCTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/JDBCTask.java
@@ -41,8 +41,9 @@ import org.apache.tools.ant.types.Reference;
*
* The following example class prints the contents of the first column of each row in TableName.
*
- *
+ *
package examples;
+
import java.sql.Connection;
import java.sql.ResultSet;
import java.sql.SQLException;
@@ -84,16 +85,11 @@ public class SQLExampleTask extends JDBCTask {
}
}
-
-
-
This task takes file and turns them into a URL, which it then assigns
+ * to a property. Use when for setting up RMI codebases.
+ *
+ * nested filesets are supported; if present, these are turned into the
+ * url with the given separator between them (default = " ").
*
* @ant.task category="core" name="makeurl"
*/
diff --git a/src/main/org/apache/tools/ant/taskdefs/Patch.java b/src/main/org/apache/tools/ant/taskdefs/Patch.java
index d5b7954a9..367717cad 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Patch.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Patch.java
@@ -107,7 +107,7 @@ public class Patch extends Task {
*
* patch's -p option.
* @param num number of lines to strip
- * @exception BuildException if num is < 0, or other errors
+ * @exception BuildException if num is < 0, or other errors
*/
public void setStrip(int num) throws BuildException {
if (num < 0) {
diff --git a/src/main/org/apache/tools/ant/taskdefs/Property.java b/src/main/org/apache/tools/ant/taskdefs/Property.java
index 3f029bef3..4c8d2ebe6 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Property.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Property.java
@@ -22,27 +22,25 @@ import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
-import java.util.Enumeration;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Properties;
-import java.util.Vector;
import org.apache.tools.ant.AntClassLoader;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.PropertyHelper;
import org.apache.tools.ant.Task;
+import org.apache.tools.ant.property.ResolvePropertyMap;
import org.apache.tools.ant.types.Path;
import org.apache.tools.ant.types.Reference;
import org.apache.tools.ant.util.FileUtils;
-import org.apache.tools.ant.property.ResolvePropertyMap;
/**
- * Sets a property by name, or set of properties (from file or
+ *
Sets a property by name, or set of properties (from file or
* resource) in the project.
- * Properties are immutable: whoever sets a property first freezes it for the
+ * Properties are immutable: whoever sets a property first freezes it for the
* rest of the build; they are most definitely not variable.
*
There are seven ways to set properties:
*
diff --git a/src/main/org/apache/tools/ant/taskdefs/Redirector.java b/src/main/org/apache/tools/ant/taskdefs/Redirector.java
index cec897561..c31ccc34a 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Redirector.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Redirector.java
@@ -370,7 +370,7 @@ public class Redirector {
/**
* This Redirector's subordinate
* PropertyOutputStreams will not set their respective
- * properties while (appendProperties && append).
+ * properties while (appendProperties && append).
*
* @param appendProperties
* whether to append properties.
diff --git a/src/main/org/apache/tools/ant/taskdefs/Replace.java b/src/main/org/apache/tools/ant/taskdefs/Replace.java
index 03ab593b6..0e1675612 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Replace.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Replace.java
@@ -214,7 +214,7 @@ public class Replace extends MatchingTask {
}
/**
- * The replacement string; required if property
+ * The replacement string; required if property
* is not set.
* @param value String value to replace.
*/
diff --git a/src/main/org/apache/tools/ant/taskdefs/Retry.java b/src/main/org/apache/tools/ant/taskdefs/Retry.java
index 5f9c812c8..bca5c15f6 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Retry.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Retry.java
@@ -67,12 +67,12 @@ public class Retry extends Task implements TaskContainer {
/**
* set the delay between retries (in milliseconds)
- * @param n the time between retries.
+ * @param retryDelay the time between retries.
* @since Ant 1.8.3
*/
public void setRetryDelay(int retryDelay) {
if (retryDelay < 0) {
- throw new BuildException("delay must be a non-negative number");
+ throw new BuildException("retryDelay must be a non-negative number");
}
this.retryDelay = retryDelay;
}
diff --git a/src/main/org/apache/tools/ant/taskdefs/Rmic.java b/src/main/org/apache/tools/ant/taskdefs/Rmic.java
index 7b5b200d9..da3130263 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Rmic.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Rmic.java
@@ -37,13 +37,15 @@ import org.apache.tools.ant.util.StringUtils;
import org.apache.tools.ant.util.facade.FacadeTaskHelper;
/**
- * Runs the rmic compiler against classes.
+ * Runs the rmic compiler against classes.
+ *
* Rmic can be run on a single class (as specified with the classname
* attribute) or a number of classes at once (all classes below base that
* are neither _Stub nor _Skel classes). If you want to rmic a single
* class and this class is a class nested into another class, you have to
* specify the classname in the form Outer$$Inner instead of
* Outer.Inner.
+ *
* It is possible to refine the set of files that are being rmiced. This can
* be done with the includes, includesfile, excludes,
* excludesfile and defaultexcludes
@@ -53,16 +55,19 @@ import org.apache.tools.ant.util.facade.FacadeTaskHelper;
* the files you want to have excluded. This is also done with patterns. And
* finally with the defaultexcludes attribute, you can specify whether
* you want to use default exclusions or not. See the section on
- * directory based tasks, on how the
+ * directory based tasks, on how the
* inclusion/exclusion of files works, and how to write patterns.
+ *
* This task forms an implicit FileSet and
* supports all attributes of <fileset>
* (dir becomes base) as well as the nested
* <include>, <exclude> and
* <patternset> elements.
+ *
* It is possible to use different compilers. This can be selected
* with the "build.rmic" property or the compiler
* attribute. There are three choices:
+ *
*
* - sun (the standard compiler of the JDK)
* - kaffe (the standard compiler of
diff --git a/src/main/org/apache/tools/ant/taskdefs/SQLExec.java b/src/main/org/apache/tools/ant/taskdefs/SQLExec.java
index 15db1a8b4..3f0327471 100644
--- a/src/main/org/apache/tools/ant/taskdefs/SQLExec.java
+++ b/src/main/org/apache/tools/ant/taskdefs/SQLExec.java
@@ -542,7 +542,7 @@ public class SQLExec extends JDBCTask {
* will be quoted, not even if they contain the column
* separator.
*
- *
Note: BLOB values will never be quoted.
+ * Note: BLOB values will never be quoted.
*
* Defaults to "not set"
*
diff --git a/src/main/org/apache/tools/ant/taskdefs/SignJar.java b/src/main/org/apache/tools/ant/taskdefs/SignJar.java
index a26caf2a4..2276a5599 100644
--- a/src/main/org/apache/tools/ant/taskdefs/SignJar.java
+++ b/src/main/org/apache/tools/ant/taskdefs/SignJar.java
@@ -511,13 +511,13 @@ public class SignJar extends AbstractJarSignerTask {
}
/**
- * Compare a jar file with its corresponding signed jar. The logic for this
+ * Compare a jar file with its corresponding signed jar. The logic for this
* is complex, and best explained in the source itself. Essentially if
* either file doesnt exist, or the destfile has an out of date timestamp,
- * then the return value is false.
- *
- * If we are signing ourself, the check {@link #isSigned(File)} is used to
- * trigger the process.
+ * then the return value is false.
+ *
+ * If we are signing ourself, the check {@link #isSigned(File)} is used to
+ * trigger the process.
*
* @param jarFile the unsigned jar file
* @param signedjarFile the result signed jar file
diff --git a/src/main/org/apache/tools/ant/taskdefs/Sleep.java b/src/main/org/apache/tools/ant/taskdefs/Sleep.java
index 7b0a05871..4e924f9f4 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Sleep.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Sleep.java
@@ -24,13 +24,14 @@ import org.apache.tools.ant.Task;
/**
* Sleep, or pause, for a period of time.
*
- * A task for sleeping a short period of time, useful when a
- * build or deployment process requires an interval between tasks.
- *
- * A negative value can be supplied to any of attributes provided the total sleep time
+ *
A task for sleeping a short period of time, useful when a
+ * build or deployment process requires an interval between tasks.
+ *
+ * A negative value can be supplied to any of attributes provided the total sleep time
* is positive, pending fundamental changes in physics and JVM
* execution times
- * Note that sleep times are always hints to be interpreted by the OS how it feels
+ *
+ * Note that sleep times are always hints to be interpreted by the OS how it feels
* small times may either be ignored or rounded up to a minimum timeslice. Note
* also that the system clocks often have a fairly low granularity too, which complicates
* measuring how long a sleep actually took.
@@ -38,7 +39,6 @@ import org.apache.tools.ant.Task;
* @since Ant 1.4
* @ant.task category="utility"
*/
-
public class Sleep extends Task {
/**
* failure flag
diff --git a/src/main/org/apache/tools/ant/taskdefs/Tar.java b/src/main/org/apache/tools/ant/taskdefs/Tar.java
index a0230dcd4..c8f867f07 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Tar.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Tar.java
@@ -611,7 +611,7 @@ public class Tar extends MatchingTask {
}
/**
- * Checks whether the archive is out-of-date with respect to the
+ * Checks whether the archive is out-of-date with respect to the
* given files, ensures that the archive won't contain itself.
*
* @param basedir base directory for file names
diff --git a/src/main/org/apache/tools/ant/taskdefs/Taskdef.java b/src/main/org/apache/tools/ant/taskdefs/Taskdef.java
index 7c6dbdafa..a7d0b71c2 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Taskdef.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Taskdef.java
@@ -22,14 +22,13 @@ import org.apache.tools.ant.Task;
import org.apache.tools.ant.TaskAdapter;
/**
- * Adds a task definition to the current project, such that this new task can be
+ * Adds a task definition to the current project, such that this new task can be
* used in the current project. Two attributes are needed, the name that identifies
* this task uniquely, and the full name of the class (including the packages) that
* implements this task.
* You can also define a group of tasks at once using the file or
- * resource attributes. These attributes point to files in the format of
- * Java property files. Each line defines a single task in the
- * format:
+ * resource attributes. These attributes point to files in the format of
+ * Java property files. Each line defines a single task in the format:
*
* taskname=fully.qualified.java.classname
*
diff --git a/src/main/org/apache/tools/ant/taskdefs/War.java b/src/main/org/apache/tools/ant/taskdefs/War.java
index 312f56afe..882769bf4 100644
--- a/src/main/org/apache/tools/ant/taskdefs/War.java
+++ b/src/main/org/apache/tools/ant/taskdefs/War.java
@@ -28,13 +28,15 @@ import org.apache.tools.zip.ZipOutputStream;
/**
- * An extension of <jar> to create a WAR archive.
+ * An extension of <jar> to create a WAR archive.
* Contains special treatment for files that should end up in the
* WEB-INF/lib, WEB-INF/classes or
* WEB-INF directories of the Web Application Archive.
+ *
* (The War task is a shortcut for specifying the particular layout of a WAR file.
* The same thing can be accomplished by using the prefix and fullpath
* attributes of zipfilesets in a Zip or Jar task.)
+ *
* The extended zipfileset element from the zip task
* (with attributes prefix, fullpath, and src)
* is available in the War task.
@@ -69,13 +71,14 @@ public class War extends Jar {
}
/**
- * Deprecated name of the file to create
+ * Deprecated name of the file to create
* -use destfile instead.
* @param warFile the destination file
* @deprecated since 1.5.x.
* Use setDestFile(File) instead
* @ant.attribute ignore="true"
*/
+ @Deprecated
public void setWarfile(File warFile) {
setDestFile(warFile);
}
diff --git a/src/main/org/apache/tools/ant/taskdefs/compilers/AptCompilerAdapter.java b/src/main/org/apache/tools/ant/taskdefs/compilers/AptCompilerAdapter.java
index 119df9435..bee4ecc8b 100644
--- a/src/main/org/apache/tools/ant/taskdefs/compilers/AptCompilerAdapter.java
+++ b/src/main/org/apache/tools/ant/taskdefs/compilers/AptCompilerAdapter.java
@@ -31,25 +31,25 @@ import java.util.Vector;
/**
- * The implementation of the apt compiler for JDK 1.5
- *
- * As usual, the low level entry points for Java tools are neither documented or
+ * The implementation of the apt compiler for JDK 1.5.
+ *
+ * As usual, the low level entry points for Java tools are neither documented or
* stable; this entry point may change from that of 1.5.0_01-b08 without any
- * warning at all. The IDE decompile of the tool entry points is as follows:
+ * warning at all. The IDE decompile of the tool entry points is as follows:
*
* public class Main {
* public Main() ;
- *
- * public static transient void main(String... strings) ;
- *
+ *
+ * public static transient void main(String... strings);
+ *
* public static transient int process(String... strings);
- *
+ *
* public static transient int process(PrintWriter printWriter,
- * String... strings) ;
+ * String... strings);
* public static transient int process(
* AnnotationProcessorFactory annotationProcessorFactory,
- * String... strings) ;
- *
+ * String... strings);
+ *
* public static transient int process(
* AnnotationProcessorFactory annotationProcessorFactory,
* PrintWriter printWriter,
@@ -65,8 +65,6 @@ import java.util.Vector;
* exposed to end-users, because it was too brittle during beta testing; classpath
* problems being the core issue.
*
- *
- *
* @since Ant 1.7
*/
public class AptCompilerAdapter extends DefaultCompilerAdapter {
diff --git a/src/main/org/apache/tools/ant/taskdefs/condition/IsReachable.java b/src/main/org/apache/tools/ant/taskdefs/condition/IsReachable.java
index c3708a232..d2abd047c 100644
--- a/src/main/org/apache/tools/ant/taskdefs/condition/IsReachable.java
+++ b/src/main/org/apache/tools/ant/taskdefs/condition/IsReachable.java
@@ -30,24 +30,24 @@ import java.net.URL;
import java.net.UnknownHostException;
/**
- * Test for a host being reachable using ICMP "ping" packets & echo operations.
+ * Test for a host being reachable using ICMP "ping" packets & echo operations.
* Ping packets are very reliable for assessing reachability in a LAN or WAN,
- * but they do not get through any well-configured firewall. Echo (port 7) may.
- *
- * This condition turns unknown host exceptions into false conditions. This is
+ * but they do not get through any well-configured firewall. Echo (port 7) may.
+ *
+ * This condition turns unknown host exceptions into false conditions. This is
* because on a laptop, DNS is one of the first services lost when the network
- * goes; you are implicitly offline.
- *
- * If a URL is supplied instead of a host, the hostname is extracted and used in
- * the test--all other parts of the URL are discarded.
- *
- * The test may not work through firewalls; that is, something may be reachable
+ * goes; you are implicitly offline.
+ *
+ * If a URL is supplied instead of a host, the hostname is extracted and used in
+ * the test--all other parts of the URL are discarded.
+ *
+ * The test may not work through firewalls; that is, something may be reachable
* using a protocol such as HTTP, while the lower level ICMP packets get dropped
* on the floor. Similarly, a host may be detected as reachable with ICMP, but not
- * reachable on other ports (i.e. port 80), because of firewalls.
- *
- * Requires Java 5+ to work properly. On Java 1.4, if a hostname
- * can be resolved, the destination is assumed to be reachable.
+ * reachable on other ports (i.e. port 80), because of firewalls.
+ *
+ * Requires Java 5+ to work properly. On Java 1.4, if a hostname
+ * can be resolved, the destination is assumed to be reachable.
*
* @since Ant 1.7
*/
diff --git a/src/main/org/apache/tools/ant/taskdefs/condition/Os.java b/src/main/org/apache/tools/ant/taskdefs/condition/Os.java
index 14c5c2d97..b1f9fca6f 100644
--- a/src/main/org/apache/tools/ant/taskdefs/condition/Os.java
+++ b/src/main/org/apache/tools/ant/taskdefs/condition/Os.java
@@ -126,8 +126,8 @@ public class Os implements Condition {
/**
* Sets the desired OS family type
*
- * @param f The OS family type desired
- * Possible values:
+ * @param f The OS family type desired
+ * Possible values:
*
* - dos
* - mac
diff --git a/src/main/org/apache/tools/ant/taskdefs/cvslib/ChangeLogTask.java b/src/main/org/apache/tools/ant/taskdefs/cvslib/ChangeLogTask.java
index a5495df6d..be387a7a6 100644
--- a/src/main/org/apache/tools/ant/taskdefs/cvslib/ChangeLogTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/cvslib/ChangeLogTask.java
@@ -133,7 +133,7 @@ public class ChangeLogTask extends AbstractCvsTask {
/**
- * Set a lookup list of user names & addresses
+ * Set a lookup list of user names & addresses
*
* @param usersFile The file containing the users info.
*/
diff --git a/src/main/org/apache/tools/ant/taskdefs/email/EmailAddress.java b/src/main/org/apache/tools/ant/taskdefs/email/EmailAddress.java
index bc76ff943..edc9c9dcd 100644
--- a/src/main/org/apache/tools/ant/taskdefs/email/EmailAddress.java
+++ b/src/main/org/apache/tools/ant/taskdefs/email/EmailAddress.java
@@ -35,12 +35,12 @@ public class EmailAddress {
/**
* Creates a new email address based on the given string
*
- * @param email the email address (with or without <>)
+ * @param email the email address (with or without <>)
* Acceptable forms include:
* address
- *
- * name
- * name
+ * <address>
+ * name <address>
+ * <address> name
* (name) address
* address (name)
*/
@@ -142,7 +142,7 @@ public class EmailAddress {
/**
- * Sets the personal / display name of the address
+ * Sets the personal / display name of the address.
*
* @param name the display name
*/
@@ -152,9 +152,9 @@ public class EmailAddress {
/**
- * Sets the email address
+ * Sets the email address.
*
- * @param address the actual email address (without <>)
+ * @param address the actual email address (without <>)
*/
public void setAddress(String address) {
this.address = address;
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/PropertyFile.java b/src/main/org/apache/tools/ant/taskdefs/optional/PropertyFile.java
index 2483cf6e2..a24b0aadf 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/PropertyFile.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/PropertyFile.java
@@ -43,69 +43,85 @@ import org.apache.tools.ant.types.EnumeratedAttribute;
import org.apache.tools.ant.util.FileUtils;
/**
- *Modifies settings in a property file.
+ * Modifies settings in a property file.
*
- *
- *The following is an example of its usage:
- *
<target name="setState">
- * <property
- * name="header"
- * value="##Generated file - do not modify!"/>
- * <propertyfile file="apropfile.properties" comment="${header}">
- * <entry key="product.version.major" type="int" value="5"/>
- * <entry key="product.version.minor" type="int" value="0"/>
- * <entry key="product.build.major" type="int" value="0" />
- * <entry key="product.build.minor" type="int" operation="+" />
- * <entry key="product.build.date" type="date" value="now" />
- * <entry key="intSet" type="int" operation="=" value="681"/>
- * <entry key="intDec" type="int" operation="-"/>
- * <entry key="StringEquals" type="string" value="testValue"/>
- * </propertyfile>
- * </target>
+ *
The following is an example of its usage:
+ *
+ * <target name="setState">
+ * <property
+ * name="header"
+ * value="##Generated file - do not modify!"/>
+ * <propertyfile file="apropfile.properties" comment="${header}">
+ * <entry key="product.version.major" type="int" value="5"/>
+ * <entry key="product.version.minor" type="int" value="0"/>
+ * <entry key="product.build.major" type="int" value="0" />
+ * <entry key="product.build.minor" type="int" operation="+" />
+ * <entry key="product.build.date" type="date" value="now" />
+ * <entry key="intSet" type="int" operation="=" value="681"/>
+ * <entry key="intDec" type="int" operation="-"/>
+ * <entry key="StringEquals" type="string" value="testValue"/>
+ * </propertyfile>
+ * </target>
+ *
*
- *The <propertyfile> task must have:
- * - file
- *Other parameters are:
- * - comment, key, operation, type and value (the final four being
- * eliminated shortly)
+ * The <propertyfile> task must have:
+ *
+ * - file
+ *
+ * Other parameters are:
+ *
+ * - comment
+ * - key
+ * - operation
+ * - type
+ * - value (the final four being eliminated shortly)
+ *
*
- *The <entry> task must have:
- * - key
- *Other parameters are:
- * - operation
- * - type
- * - value
- * - default
- * - unit
- *
+ * The <entry> task must have:
+ *
+ * - key
+ *
+ * Other parameters are:
+ *
+ * - operation
+ * - type
+ * - value
+ * - default
+ * - unit
+ *
*
- *If type is unspecified, it defaults to string
+ * If type is unspecified, it defaults to string.
*
- *Parameter values:
- * - operation:
- * - "=" (set -- default)
- * - "-" (dec)
- * - "+" (inc)
- *
- * - type:
- * - "int"
- * - "date"
- * - "string"
- *
- * - value:
- * - holds the default value, if the property
+ * Parameter values:
+ *
+ * - operation:
+ *
+ * - "=" (set -- default)
+ * - "-" (dec)
+ * - "+" (inc)
+ *
+ * - type:
+ *
+ * - "int"
+ * - "date"
+ * - "string"
+ *
+ * - value:
+ *
+ * - holds the default value, if the property
* was not found in property file
- * - "now" In case of type "date", the
+ *
- "now" In case of type "date", the
* value "now" will be replaced by the current
* date/time and used even if a valid date was
- * found in the property file.
- *
+ * found in the property file.
+ *
+ *
*
- *String property types can only use the "=" operation.
- *Int property types can only use the "=", "-" or "+" operations.
+ *
String property types can only use the "=" operation.
+ * Int property types can only use the "=", "-" or "+" operations.
*
- *The message property is used for the property file header, with "\\" being
- *a newline delimiter character.
+ * The message property is used for the property file header, with "\\" being
+ * a newline delimiter character.
*
*/
public class PropertyFile extends Task {
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 0718d14b7..e8c38091d 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.java
@@ -212,11 +212,13 @@ public class ReplaceRegExp extends Task {
* on one line at a time. This is useful if you
* want to only replace the first occurrence of a regular expression on
* each line, which is not easy to do when processing the file as a whole.
- * Defaults to false.
+ * Defaults to false.
+ *
* @param byline the byline attribute as a string
* @deprecated since 1.6.x.
* Use setByLine(boolean).
*/
+ @Deprecated
public void setByLine(String byline) {
Boolean res = Boolean.valueOf(byline);
@@ -231,14 +233,14 @@ public class ReplaceRegExp extends Task {
* on one line at a time. This is useful if you
* want to only replace the first occurrence of a regular expression on
* each line, which is not easy to do when processing the file as a whole.
- * Defaults to false.
+ * Defaults to false.
+ *
* @param byline the byline attribute
*/
public void setByLine(boolean byline) {
this.byline = byline;
}
-
/**
* Specifies the encoding Ant expects the files to be in -
* defaults to the platforms default encoding.
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 c777feb72..57ad33706 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java
@@ -120,7 +120,7 @@ public class XMLValidateTask extends Task {
/**
* Specify how parser error are to be handled.
*
- * If set to true (default), log a warn message for each SAX warn event.
+ * If set to true (default), log a warn message for each SAX warn event.
* @param bool if set to false do not send warnings
*/
public void setWarn(boolean bool) {
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 88cfc01ea..371d418bd 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
@@ -38,42 +38,42 @@ import org.apache.tools.ant.types.Commandline;
* viewpath
* Path to the ClearCase view file or directory that the command will operate on
* No
- *
+ *
*
* comment
* Specify a comment. Only one of comment or cfile may be used.
* No
- *
+ *
*
* commentfile
* Specify a file containing a comment. Only one of comment or cfile may be used.
* No
- *
+ *
*
* nowarn
* Suppress warning messages
* No
- *
+ *
*
* preservetime
* Preserve the modification time
* No
- *
+ *
*
* keepcopy
* Keeps a copy of the file with a .keep extension
* No
- *
+ *
*
* identical
* Allows the file to be checked in even if it is identical to the original
* No
- *
+ *
*
* failonerr
* Throw an exception if the command fails. Default is true
* No
- *
+ *
*
*
*/