From 67f29ce0c2ad332570c0a1382c79532cee66dce8 Mon Sep 17 00:00:00 2001
From: Gintas Grigelionis
* If the argument is not supported, returns -1. Else, the position of the
* first argument not supported.
+ * 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(Listtrue
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
* 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, @@ -60,11 +61,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 @@ -73,41 +76,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.separator
s
- * 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:
+ *
File.separator
, the string
+ * to match must also start with a File.separator
.File.separator
, the
+ * string to match may not start with a File.separator
.
* 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\\*\\**"}; @@ -701,6 +717,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) { @@ -790,7 +807,7 @@ public class DirectoryScanner ** - *File.separatorChar
, so the separator used need not * matchFile.separatorChar
. * - *When a pattern ends with a '/' or '\', "**" is appended. + *
When a pattern ends with a '/' or '\', "**" is appended.
* * @since Ant 1.6.3 */ @@ -1378,7 +1395,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 benull
. + * @param path The tokenized path to match. Must not benull
. * @returntrue
when the name matches against at least one * include pattern, orfalse
otherwise. */ diff --git a/src/main/org/apache/tools/ant/IntrospectionHelper.java b/src/main/org/apache/tools/ant/IntrospectionHelper.java index 2b31e432f..9740338fe 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) { @@ -1529,7 +1529,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 67ab8a810..7c17c05c5 100644 --- a/src/main/org/apache/tools/ant/MagicNames.java +++ b/src/main/org/apache/tools/ant/MagicNames.java @@ -252,7 +252,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 @@ -266,7 +266,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 a7d477671..33dae8cb6 100644 --- a/src/main/org/apache/tools/ant/Main.java +++ b/src/main/org/apache/tools/ant/Main.java @@ -1275,9 +1275,6 @@ public class Main implements AntMain { * no descriptions are displayed. * If non-
* + * @return boolean * @since Ant 1.8.0 */ public static boolean isInIncludeMode() { @@ -260,6 +264,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) { @@ -591,6 +596,8 @@ public class ProjectHelper { * *null
, this should have * as many elements asnames
. - * @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 benull
. * @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 34dddb26f..b91b83ec9 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 theant.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 theant.executor.class
* property, they will have no effect. * @return "keep-going" mode @@ -1803,13 +1803,13 @@ public class Project implements ResourceFactory { /** * Topologically sort a set of targets. * - * @param rootString[]
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 benull
. + * @param rootsString[]
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 benull
. * @param targetTable A map of names to targets (String to Target). - * Must not benull
. + * Must not benull
. * @param returnAllboolean
indicating whether to return all * targets, or the execution sequence only. * @return a Vector of Target objects in sorted order. @@ -1817,7 +1817,7 @@ public class Project implements ResourceFactory { * targets, or if a named target does not exist. * @since Ant 1.6.3 */ - public final VectortopoSort(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 (); @@ -1831,19 +1831,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 StringBuffer buf = new StringBuffer("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); @@ -2019,6 +2019,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) { @@ -2041,6 +2043,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 ad92a3175..767d0c0c2 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 ab3936827..0c73b2654 100644 --- a/src/main/org/apache/tools/ant/ProjectHelper.java +++ b/src/main/org/apache/tools/ant/ProjectHelper.java @@ -151,8 +151,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 VectorThis implementation returns false.
* + * @param r Resource + * @return boolean * @since Ant 1.8.0 */ public boolean canParseAntlibDescriptor(Resource r) { @@ -601,6 +608,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 e370a54c7..df5d1a07c 100644 --- a/src/main/org/apache/tools/ant/ProjectHelperRepository.java +++ b/src/main/org/apache/tools/ant/ProjectHelperRepository.java @@ -79,7 +79,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(); @@ -248,6 +248,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 (nevernull
). */ public ProjectHelper getProjectHelperForBuildFile(Resource buildFile) throws BuildException { @@ -271,6 +272,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 (nevernull
). */ 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 1dbb280c9..9f94bda75 100644 --- a/src/main/org/apache/tools/ant/PropertyHelper.java +++ b/src/main/org/apache/tools/ant/PropertyHelper.java @@ -72,7 +72,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 @@ -1111,6 +1111,7 @@ public class PropertyHelper implements GetProperty { /** * Get the Collection of delegates of the specified type. * + * @param
desired type. * @param type * delegate type. * @return Collection. @@ -1149,6 +1150,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) { @@ -1172,6 +1175,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) { @@ -1183,6 +1188,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) { @@ -1197,6 +1204,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) { @@ -1207,6 +1216,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 0aafccbe2..302d8f6ed 100644 --- a/src/main/org/apache/tools/ant/RuntimeConfigurable.java +++ b/src/main/org/apache/tools/ant/RuntimeConfigurable.java @@ -70,7 +70,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 @@ -172,7 +172,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 */ @@ -267,10 +267,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++) { @@ -341,10 +342,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 benull
. + * @deprecated Deprecated since Ant 1.6 in favor of {@link #getAttributeMap}. */ + @Deprecated public synchronized AttributeList getAttributes() { return attributes; } @@ -415,7 +417,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. @@ -449,9 +451,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
* * @param p The project containing the wrapped element. * Must not beid
attribute, a reference * is added to the project as well. + *null
. @@ -468,18 +471,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
* * @param p The project containing the wrapped element. * Must not beid
attribute, a reference * is added to the project as well. + *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) @@ -540,7 +543,7 @@ public class RuntimeConfigurable implements Serializable { } catch (BuildException be) { if (name.equals("id")) { // 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 b1df2b243..33b8b7233 100644 --- a/src/main/org/apache/tools/ant/Target.java +++ b/src/main/org/apache/tools/ant/Target.java @@ -301,6 +301,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) { @@ -348,6 +349,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 3a3001f62..d4d8c3213 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 *- * myTaskContainer.addTask( new TaskAdapter(myProxy) ); + * myTaskContainer.addTask(new TaskAdapter(myProxy)); ** * @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 e8e74441a..9a520438c 100644 --- a/src/main/org/apache/tools/ant/TaskConfigurationChecker.java +++ b/src/main/org/apache/tools/ant/TaskConfigurationChecker.java @@ -95,7 +95,7 @@ public class TaskConfigurationChecker { public void checkErrors() throws BuildException { if (!errors.isEmpty()) { StringBuffer sb = new StringBuffer(); - sb.append("Configurationerror on <"); + sb.append("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 a848ed138..b88b873be 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 benull
. */ - 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:
**
- * Example:- 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:
*<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: + *
*- *
* None of which are required. *- eof - *
- eol - *
- fixlast - *
- javafiles - *
- tab - *
- tablength + *
- eof
+ *- eol
+ *- fixlast
+ *- javafiles
+ *- tab
+ *- tablength
*@@ -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. - * - *
+ *
+ ** Example: - * + *
** <<fixcrlf tab="add" eol="crlf" eof="asis"/> *- * * Or: - * ** <filterreader classname="org.apache.tools.ant.filters.FixCrLfFilter"> * <param eol="crlf" tab="asis"/> * </filterreader> *- * */ 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 09dce7759..5d144c2b3 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.9.10 */ 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
@@ -102,7 +102,7 @@ import org.apache.tools.ant.types.Parameter; * **.txt
from src location using as - * sorting criteriumEvenFirstCmp
class, that sorts the file + * sorting criterionEvenFirstCmp
class, that sorts the file * lines putting even lines first then odd lines for example. The modified files * are copied into build location. TheEvenFirstCmp
, - * has to an instanciable class viaClass.newInstance()
, + * has to an instantiable class viaClass.newInstance()
, * therefore in case of inner class has to be static. It also has to * implementjava.util.Comparator
interface, for example: *The example above is equivalent to:
* - *+ *+ ** <componentdef name="evenfirst" * classname="org.apache.tools.ant.filters.EvenFirstCmp"/> * <copy todir="build"> @@ -113,10 +113,10 @@ import org.apache.tools.ant.types.Parameter; * </sortfilter> * </filterchain> * </copy> - *
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.
- * 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
.
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 7519a7e8d..fb22f75da 100644
--- a/src/main/org/apache/tools/ant/listener/AnsiColorLogger.java
+++ b/src/main/org/apache/tools/ant/listener/AnsiColorLogger.java
@@ -200,8 +200,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 32474eea3..86fd6847a 100644
--- a/src/main/org/apache/tools/ant/listener/CommonsLoggingListener.java
+++ b/src/main/org/apache/tools/ant/listener/CommonsLoggingListener.java
@@ -128,8 +128,8 @@ public class CommonsLoggingListener implements BuildListener, BuildLogger {
/**
* @see BuildListener#targetStarted
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void targetStarted(final BuildEvent event) {
if (initialized) {
final Log log = getLog(TARGET_LOG,
@@ -143,8 +143,8 @@ public class CommonsLoggingListener implements BuildListener, BuildLogger {
/**
* @see BuildListener#targetFinished
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void targetFinished(final BuildEvent event) {
if (initialized) {
final String targetName = event.getTarget().getName();
@@ -162,8 +162,8 @@ public class CommonsLoggingListener implements BuildListener, BuildLogger {
/**
* @see BuildListener#taskStarted
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void taskStarted(final BuildEvent event) {
if (initialized) {
final Task task = event.getTask();
@@ -184,8 +184,8 @@ public class CommonsLoggingListener implements BuildListener, BuildLogger {
/**
* @see BuildListener#taskFinished
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void taskFinished(final BuildEvent event) {
if (initialized) {
final Task task = event.getTask();
@@ -213,8 +213,8 @@ public class CommonsLoggingListener implements BuildListener, BuildLogger {
/**
* @see BuildListener#messageLogged
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void messageLogged(final BuildEvent event) {
if (initialized) {
Object categoryObject = event.getTask();
diff --git a/src/main/org/apache/tools/ant/listener/Log4jListener.java b/src/main/org/apache/tools/ant/listener/Log4jListener.java
index 829f11834..501b511d3 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}. */
public void buildStarted(final BuildEvent event) {
if (initialized) {
final Logger log = Logger.getLogger(Project.class.getName());
@@ -66,8 +66,8 @@ public class Log4jListener implements BuildListener {
/**
* @see BuildListener#buildFinished
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void buildFinished(final BuildEvent event) {
if (initialized) {
final Logger log = Logger.getLogger(Project.class.getName());
@@ -81,8 +81,8 @@ public class Log4jListener implements BuildListener {
/**
* @see BuildListener#targetStarted
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void targetStarted(final BuildEvent event) {
if (initialized) {
final Logger log = Logger.getLogger(Target.class.getName());
@@ -92,8 +92,8 @@ public class Log4jListener implements BuildListener {
/**
* @see BuildListener#targetFinished
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void targetFinished(final BuildEvent event) {
if (initialized) {
final String targetName = event.getTarget().getName();
@@ -109,8 +109,8 @@ public class Log4jListener implements BuildListener {
/**
* @see BuildListener#taskStarted
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void taskStarted(final BuildEvent event) {
if (initialized) {
final Task task = event.getTask();
@@ -121,8 +121,8 @@ public class Log4jListener implements BuildListener {
/**
* @see BuildListener#taskFinished
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void taskFinished(final BuildEvent event) {
if (initialized) {
final Task task = event.getTask();
@@ -138,6 +138,7 @@ public class Log4jListener implements BuildListener {
/**
* @see BuildListener#messageLogged
+ * {@inheritDoc}.
*/
/** {@inheritDoc}. */
public void messageLogged(final BuildEvent event) {
diff --git a/src/main/org/apache/tools/ant/listener/MailLogger.java b/src/main/org/apache/tools/ant/listener/MailLogger.java
index 45289a1c4..2de55bf9f 100644
--- a/src/main/org/apache/tools/ant/listener/MailLogger.java
+++ b/src/main/org/apache/tools/ant/listener/MailLogger.java
@@ -323,8 +323,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(Hashtable+ * 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; /** @@ -848,6 +854,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 c93173b34..b2fe8d441 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 793d16c98..dbf8a225e 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Ant.java +++ b/src/main/org/apache/tools/ant/taskdefs/Ant.java @@ -137,6 +137,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) { @@ -466,7 +467,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
*/
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 f4919a16c..d8eb82fdc 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Available.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Available.java
@@ -492,8 +492,8 @@ public class Available extends Task implements Condition {
/**
* @see EnumeratedAttribute#getValues
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
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 aee071d31..7a661256c 100644
--- a/src/main/org/apache/tools/ant/taskdefs/BuildNumber.java
+++ b/src/main/org/apache/tools/ant/taskdefs/BuildNumber.java
@@ -140,7 +140,7 @@ public class BuildNumber
* Utility method to load properties from file.
*
* @return the loaded properties
- * @throws BuildException
+ * @throws BuildException if something goes wrong
*/
private Properties loadProperties()
throws BuildException {
diff --git a/src/main/org/apache/tools/ant/taskdefs/Concat.java b/src/main/org/apache/tools/ant/taskdefs/Concat.java
index 1af0143cd..93560ce06 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Concat.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Concat.java
@@ -361,7 +361,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) {
@@ -614,6 +614,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 2394b8f43..31901a6d8 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Copy.java +++ b/src/main/org/apache/tools/ant/taskdefs/Copy.java @@ -240,6 +240,7 @@ public class Copy extends Task { * *Defaults to false
* + * @param f boolean * @since Ant 1.8.2 */ public void setForce(final boolean f) { @@ -249,6 +250,7 @@ public class Copy extends Task { /** * Whether read-only destinations will be overwritten. * + * @return boolean * @since Ant 1.8.2 */ public boolean getForce() { @@ -465,7 +467,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 @@ -1044,7 +1046,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 6c34ccf2f..3329318e2 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Delete.java +++ b/src/main/org/apache/tools/ant/taskdefs/Delete.java @@ -206,6 +206,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) { @@ -246,7 +247,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 */ public PatternSet.NameEntry createIncludesFile() { usedMatchingTask = true; @@ -255,7 +256,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 */ public PatternSet.NameEntry createExclude() { usedMatchingTask = true; @@ -264,7 +265,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 */ public PatternSet.NameEntry createExcludesFile() { usedMatchingTask = true; @@ -361,6 +362,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) { @@ -369,6 +371,7 @@ public class Delete extends MatchingTask { /** * add a "Select" selector entry on the selector list + * * @param selector the selector to be added */ public void addSelector(SelectSelector selector) { @@ -378,6 +381,7 @@ public class Delete extends MatchingTask { /** * add an "And" selector entry on the selector list + * * @param selector the selector to be added */ public void addAnd(AndSelector selector) { @@ -387,6 +391,7 @@ public class Delete extends MatchingTask { /** * add an "Or" selector entry on the selector list + * * @param selector the selector to be added */ public void addOr(OrSelector selector) { @@ -396,6 +401,7 @@ public class Delete extends MatchingTask { /** * add a "Not" selector entry on the selector list + * * @param selector the selector to be added */ public void addNot(NotSelector selector) { @@ -405,6 +411,7 @@ public class Delete extends MatchingTask { /** * add a "None" selector entry on the selector list + * * @param selector the selector to be added */ public void addNone(NoneSelector selector) { @@ -414,6 +421,7 @@ public class Delete extends MatchingTask { /** * add a majority selector entry on the selector list + * * @param selector the selector to be added */ public void addMajority(MajoritySelector selector) { @@ -423,6 +431,7 @@ public class Delete extends MatchingTask { /** * add a selector date entry on the selector list + * * @param selector the selector to be added */ public void addDate(DateSelector selector) { @@ -432,6 +441,7 @@ public class Delete extends MatchingTask { /** * add a selector size entry on the selector list + * * @param selector the selector to be added */ public void addSize(SizeSelector selector) { @@ -441,6 +451,7 @@ public class Delete extends MatchingTask { /** * add a selector filename entry on the selector list + * * @param selector the selector to be added */ public void addFilename(FilenameSelector selector) { @@ -450,6 +461,7 @@ public class Delete extends MatchingTask { /** * add an extended selector entry on the selector list + * * @param selector the selector to be added */ public void addCustom(ExtendSelector selector) { @@ -459,6 +471,7 @@ public class Delete extends MatchingTask { /** * add a contains selector entry on the selector list + * * @param selector the selector to be added */ public void addContains(ContainsSelector selector) { @@ -468,6 +481,7 @@ public class Delete extends MatchingTask { /** * add a present selector entry on the selector list + * * @param selector the selector to be added */ public void addPresent(PresentSelector selector) { @@ -477,6 +491,7 @@ public class Delete extends MatchingTask { /** * add a depth selector entry on the selector list + * * @param selector the selector to be added */ public void addDepth(DepthSelector selector) { @@ -486,6 +501,7 @@ public class Delete extends MatchingTask { /** * add a depends selector entry on the selector list + * * @param selector the selector to be added */ public void addDepend(DependSelector selector) { @@ -495,6 +511,7 @@ public class Delete extends MatchingTask { /** * add a regular expression selector entry on the selector list + * * @param selector the selector to be added */ public void addContainsRegexp(ContainsRegexpSelector selector) { @@ -504,6 +521,7 @@ public class Delete extends MatchingTask { /** * add the modified selector + * * @param selector the selector to add * @since ant 1.6 */ @@ -514,6 +532,7 @@ public class Delete extends MatchingTask { /** * add an arbitrary selector + * * @param selector the selector to be added * @since Ant 1.6 */ @@ -524,6 +543,7 @@ public class Delete extends MatchingTask { /** * Delete the file(s). + * * @exception BuildException if an error occurs */ public void execute() throws BuildException { diff --git a/src/main/org/apache/tools/ant/taskdefs/DependSet.java b/src/main/org/apache/tools/ant/taskdefs/DependSet.java index dc42beb1a..549e0ffb5 100644 --- a/src/main/org/apache/tools/ant/taskdefs/DependSet.java +++ b/src/main/org/apache/tools/ant/taskdefs/DependSet.java @@ -180,6 +180,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 4a4fda292..40939e42f 100644 --- a/src/main/org/apache/tools/ant/taskdefs/EchoXML.java +++ b/src/main/org/apache/tools/ant/taskdefs/EchoXML.java @@ -59,8 +59,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 dd93978fe..b9eb963be 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() { @@ -405,6 +406,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 956309a6d..d9923e8cb 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Execute.java +++ b/src/main/org/apache/tools/ant/taskdefs/Execute.java @@ -625,14 +625,14 @@ public class Execute { for (String osEnvItem : osEnv.keySet()) { // Nb: using default locale as key is a env name if (osEnvItem.toLowerCase().equals(key.toLowerCase())) { - // 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 0ec233308..a586556bd 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Expand.java +++ b/src/main/org/apache/tools/ant/taskdefs/Expand.java @@ -88,6 +88,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) { @@ -97,6 +98,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) { @@ -106,6 +108,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() { @@ -472,6 +475,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) { @@ -482,6 +486,7 @@ public class Expand extends Task { } /** + * @return String * @since Ant 1.8.0 */ public String getEncoding() { @@ -491,6 +496,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) { @@ -500,6 +506,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) { @@ -511,6 +518,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) { @@ -518,6 +526,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 465bf462b..236b125d8 100644 --- a/src/main/org/apache/tools/ant/taskdefs/FixCRLF.java +++ b/src/main/org/apache/tools/ant/taskdefs/FixCRLF.java @@ -684,8 +684,8 @@ public class FixCRLF extends MatchingTask implements ChainableReader { public static class CrLf extends EnumeratedAttribute { /** * @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/taskdefs/Get.java b/src/main/org/apache/tools/ant/taskdefs/Get.java index 83f3b6bf0..26a20e4aa 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Get.java +++ b/src/main/org/apache/tools/ant/taskdefs/Get.java @@ -318,6 +318,7 @@ public class Get extends Task { /** * Adds URLs to get. + * @param rc ResourceCollection * @since Ant 1.8.0 */ public void add(final ResourceCollection rc) { @@ -406,6 +407,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) { @@ -420,7 +422,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) { @@ -436,7 +437,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) { @@ -449,6 +449,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) { @@ -463,6 +464,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) { @@ -476,6 +478,7 @@ public class Get extends Task { *Setting this to true also means Ant will uncompress
* .tar.gz
and similar files automatically.
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 63adf718d..0ddd59747 100644 --- a/src/main/org/apache/tools/ant/taskdefs/ImportTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/ImportTask.java @@ -98,6 +98,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) { @@ -108,6 +109,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) { @@ -117,6 +119,7 @@ public class ImportTask extends Task { /** * The resource to import. * + * @param r ResourceCollection * @since Ant 1.8.0 */ public void add(ResourceCollection r) { @@ -327,6 +330,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() { @@ -336,6 +340,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 2ca6e22ab..0954e7069 100644 --- a/src/main/org/apache/tools/ant/taskdefs/JDBCTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/JDBCTask.java @@ -246,6 +246,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) { @@ -314,6 +315,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) { @@ -388,7 +390,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 330b5dd7d..791fd0dbd 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Jar.java +++ b/src/main/org/apache/tools/ant/taskdefs/Jar.java @@ -150,7 +150,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"); @@ -481,6 +481,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) { @@ -491,6 +492,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) { @@ -1032,7 +1034,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(ListCurrent known limitations are: + *
Current known limitations are:
* - *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.
doc-files
directories.
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setDocFilesSubDirs(final boolean b) {
@@ -1683,6 +1684,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) {
@@ -1691,6 +1693,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 4c20c7c90..608631829 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 e23c02537..9fc94bc6a 100644 --- a/src/main/org/apache/tools/ant/taskdefs/MakeUrl.java +++ b/src/main/org/apache/tools/ant/taskdefs/MakeUrl.java @@ -283,7 +283,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 0d7c05e61..1daf52f60 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Manifest.java +++ b/src/main/org/apache/tools/ant/taskdefs/Manifest.java @@ -40,8 +40,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 9b600db55..ff6961ba5 100644 --- a/src/main/org/apache/tools/ant/taskdefs/ManifestTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/ManifestTask.java @@ -196,6 +196,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) { @@ -206,6 +207,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 113ff5ebd..c35af03a2 100644 --- a/src/main/org/apache/tools/ant/taskdefs/MatchingTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/MatchingTask.java @@ -154,7 +154,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 7f5d9680d..c549d1b71 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Move.java +++ b/src/main/org/apache/tools/ant/taskdefs/Move.java @@ -72,6 +72,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 daabd6ba6..63dfe05e2 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Pack.java +++ b/src/main/org/apache/tools/ant/taskdefs/Pack.java @@ -146,7 +146,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 ccfb35623..64a637620 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Property.java +++ b/src/main/org/apache/tools/ant/taskdefs/Property.java @@ -295,6 +295,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) { @@ -305,6 +306,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() { @@ -362,10 +364,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 ;).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 4b6819815..b2474a5f7 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) { @@ -290,7 +291,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) { @@ -900,6 +901,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) { @@ -916,6 +918,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) { @@ -925,6 +928,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) { @@ -944,6 +948,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(StringBuffer str, String str1, String str2) { int found = str.indexOf(str1); @@ -958,6 +966,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 IteratorThe miniRMI + *
The miniRMI * project contains a compiler implementation for this task as well, * please consult miniRMI's documentation to learn how to use it.
* @@ -535,6 +535,7 @@ public class Rmic extends MatchingTask { /** * Name of the executable to use when forking. * + * @param ex String * @since Ant 1.8.0 */ public void setExecutable(String ex) { @@ -545,6 +546,7 @@ public class Rmic extends MatchingTask { * Explicitly specified name of the executable to use when forking * - if any. * + * @return String * @since Ant 1.8.0 */ public String getExecutable() { @@ -555,6 +557,7 @@ public class Rmic 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() { @@ -563,6 +566,7 @@ public class Rmic extends MatchingTask { /** * If true, list the source files being handed off to the compiler. + * * @param list if true list the source files * @since Ant 1.8.0 */ @@ -572,6 +576,8 @@ public class Rmic extends MatchingTask { /** * Set the compiler adapter explicitly. + * + * @param adapter RmicAdapter * @since Ant 1.8.0 */ public void add(RmicAdapter adapter) { diff --git a/src/main/org/apache/tools/ant/taskdefs/SQLExec.java b/src/main/org/apache/tools/ant/taskdefs/SQLExec.java index d91356665..2f247c999 100644 --- a/src/main/org/apache/tools/ant/taskdefs/SQLExec.java +++ b/src/main/org/apache/tools/ant/taskdefs/SQLExec.java @@ -501,6 +501,8 @@ public class SQLExec extends JDBCTask { * If false, delimiters will be searched for in a case-insensitive * manner (i.e. delimiter="go" matches "GO") and surrounding * whitespace will be ignored (delimiter="go" matches "GO "). + * + * @param b boolean * @since Ant 1.8.0 */ public void setStrictDelimiterMatching(boolean b) { @@ -509,6 +511,8 @@ public class SQLExec extends JDBCTask { /** * whether to show SQLWarnings as WARN messages. + * + * @param b boolean * @since Ant 1.8.0 */ public void setShowWarnings(boolean b) { @@ -517,6 +521,8 @@ public class SQLExec extends JDBCTask { /** * Whether a warning is an error - in which case onError applies. + * + * @param b boolean * @since Ant 1.8.0 */ public void setTreatWarningsAsErrors(boolean b) { @@ -528,6 +534,7 @@ public class SQLExec extends JDBCTask { * *Defaults to ","
* + * @param s String * @since Ant 1.8.0 */ public void setCsvColumnSeparator(String s) { @@ -550,6 +557,7 @@ public class SQLExec extends JDBCTask { * *Defaults to "not set"
* + * @param s String * @since Ant 1.8.0 */ public void setCsvQuoteCharacter(String s) { @@ -585,6 +593,7 @@ public class SQLExec extends JDBCTask { /** * Sets a given property to the number of rows in the first * statement that returned a row count. + * @param rowCountProperty String * @since Ant 1.8.0 */ public void setRowCountProperty(String rowCountProperty) { @@ -593,6 +602,7 @@ public class SQLExec extends JDBCTask { /** * Force the csv quote character + * @param forceCsvQuoteChar boolean */ public void setForceCsvQuoteChar(boolean forceCsvQuoteChar) { this.forceCsvQuoteChar = forceCsvQuoteChar; @@ -986,6 +996,9 @@ public class SQLExec extends JDBCTask { * instances, should override this method but keep in mind that * this class expects to get the same connection instance on * consecutive calls. + * + * @return Statement + * @throws SQLException if statement creation or processing fails */ protected Statement getStatement() throws SQLException { if (statement == null) { diff --git a/src/main/org/apache/tools/ant/taskdefs/Sequential.java b/src/main/org/apache/tools/ant/taskdefs/Sequential.java index 468ac148c..f2f88a925 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Sequential.java +++ b/src/main/org/apache/tools/ant/taskdefs/Sequential.java @@ -45,9 +45,8 @@ public class Sequential extends Task implements TaskContainer { /** * Add a nested task to Sequential. - *+ * * @param nestedTask Nested task to execute Sequential - *
*/ public void addTask(Task nestedTask) { nestedTasks.addElement(nestedTask); diff --git a/src/main/org/apache/tools/ant/taskdefs/SignJar.java b/src/main/org/apache/tools/ant/taskdefs/SignJar.java index fc31b1d3d..bb17174bd 100644 --- a/src/main/org/apache/tools/ant/taskdefs/SignJar.java +++ b/src/main/org/apache/tools/ant/taskdefs/SignJar.java @@ -315,6 +315,7 @@ public class SignJar extends AbstractJarSignerTask { /** * Whether to force signing of a jar even it is already signed. + * @param b boolean * @since Ant 1.8.0 */ public void setForce(boolean b) { @@ -324,6 +325,7 @@ public class SignJar extends AbstractJarSignerTask { /** * Should the task force signing of a jar even it is already * signed? + * @return boolean * @since Ant 1.8.0 */ public boolean isForce() { @@ -341,6 +343,8 @@ public class SignJar extends AbstractJarSignerTask { /** * Signature Algorithm; optional + * + * @return String */ public String getSigAlg() { return sigAlg; @@ -357,6 +361,8 @@ public class SignJar extends AbstractJarSignerTask { /** * Digest Algorithm; optional + * + * @return String */ public String getDigestAlg() { return digestAlg; @@ -461,7 +467,7 @@ public class SignJar extends AbstractJarSignerTask { * * @param jarSource source to sign * @param jarTarget target; may be null - * @throws BuildException + * @throws BuildException if something goes wrong */ private void signOneJar(File jarSource, File jarTarget) throws BuildException { diff --git a/src/main/org/apache/tools/ant/taskdefs/SubAnt.java b/src/main/org/apache/tools/ant/taskdefs/SubAnt.java index c374d8326..f3207aa29 100644 --- a/src/main/org/apache/tools/ant/taskdefs/SubAnt.java +++ b/src/main/org/apache/tools/ant/taskdefs/SubAnt.java @@ -39,8 +39,8 @@ import org.apache.tools.ant.util.StringUtils; /** * Calls a given target for all defined sub-builds. This is an extension * of ant for bulk project execution. - *
- *
* subant can be used with directory sets to execute a build from different directories. * 2 different options are offered @@ -82,8 +82,9 @@ public class SubAnt 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 - * launcher. + * 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 * @since Ant 1.8.0 @@ -378,10 +379,10 @@ public class SubAnt extends Task { /** * The target to call on the different sub-builds. Set to "" to execute * the default target. + * * @param target the target - **/ - // REVISIT: Defaults to the target name that contains this task if not specified. + // REVISIT: Defaults to the target name that contains this task if not specified. public void setTarget(String target) { this.subTarget = target; } @@ -473,6 +474,7 @@ public class SubAnt extends Task { * Note that the directories will be added to the build path * in no particular order, so if order is significant, one should * use a file list instead! + *
* * @param set the directory set to add. */ @@ -486,6 +488,7 @@ public class SubAnt extends Task { * Note that the directories will be added to the build path * in no particular order, so if order is significant, one should * use a file list instead! + * * * @param set the file set to add. */ @@ -498,6 +501,7 @@ public class SubAnt extends Task { ** Note that contrary to file and directory sets, file lists * can reference non-existent files or directories! + *
* * @param list the file list to add. */ @@ -639,4 +643,4 @@ public class SubAnt extends Task { } } -} // END class SubAnt +} diff --git a/src/main/org/apache/tools/ant/taskdefs/Sync.java b/src/main/org/apache/tools/ant/taskdefs/Sync.java index bcdfd525c..e99bafd7f 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Sync.java +++ b/src/main/org/apache/tools/ant/taskdefs/Sync.java @@ -177,7 +177,7 @@ public class Sync extends Task { *If the directory is an orphan, it will also be removed.
* * @param nonOrphans the table of all non-orphanFile
s.
- * @param file the initial file or directory to scan or test.
+ * @param toDir the initial file or directory to scan or test.
* @param preservedDirectories will be filled with the directories
* matched by preserveInTarget - if any. Will not be
* filled unless preserveEmptyDirs and includeEmptyDirs
@@ -465,8 +465,8 @@ public class Sync extends Task {
/**
* @see Copy#scan(File, File, String[], String[])
+ * {@inheritDoc}
*/
- /** {@inheritDoc} */
@Override
protected void scan(File fromDir, File toDir, String[] files,
String[] dirs) {
@@ -484,8 +484,8 @@ public class Sync extends Task {
/**
* @see Copy#scan(Resource[], File)
+ * {@inheritDoc}
*/
- /** {@inheritDoc} */
@Override
protected Map scan(Resource[] resources, File toDir) {
assertTrue("No mapper", mapperElement == null);
@@ -559,6 +559,7 @@ public class Sync extends Task {
* Whether empty directories matched by this fileset should be
* preserved.
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setPreserveEmptyDirs(boolean b) {
@@ -569,6 +570,7 @@ public class Sync extends Task {
* Whether empty directories matched by this fileset should be
* preserved.
*
+ * @return Boolean
* @since Ant 1.8.0
*/
public Boolean getPreserveEmptyDirs() {
diff --git a/src/main/org/apache/tools/ant/taskdefs/TempFile.java b/src/main/org/apache/tools/ant/taskdefs/TempFile.java
index 5f55a3767..9756fbc66 100644
--- a/src/main/org/apache/tools/ant/taskdefs/TempFile.java
+++ b/src/main/org/apache/tools/ant/taskdefs/TempFile.java
@@ -105,7 +105,7 @@ public class TempFile extends Task {
/**
* Sets the optional suffix string for the temp file.
*
- * @param suffix suffix including any "." , e.g ".xml"
+ * @param suffix suffix including any ".", e.g ".xml"
*/
public void setSuffix(String suffix) {
this.suffix = suffix;
diff --git a/src/main/org/apache/tools/ant/taskdefs/Tstamp.java b/src/main/org/apache/tools/ant/taskdefs/Tstamp.java
index a6a35d7b4..f86ed0300 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Tstamp.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Tstamp.java
@@ -112,6 +112,8 @@ public class Tstamp extends Task {
/**
* Return the {@link Date} instance to use as base for DSTAMP, TSTAMP and TODAY.
+ *
+ * @return Date
*/
protected Date getNow() {
String magicNow = getProject().getProperty(MagicNames.TSTAMP_NOW);
diff --git a/src/main/org/apache/tools/ant/taskdefs/Untar.java b/src/main/org/apache/tools/ant/taskdefs/Untar.java
index 8343aec52..53b8239d1 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Untar.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Untar.java
@@ -91,8 +91,8 @@ public class Untar extends Expand {
/**
* @see Expand#expandFile(FileUtils, File, File)
+ * {@inheritDoc}
*/
- /** {@inheritDoc} */
protected void expandFile(FileUtils fileUtils, File srcF, File dir) {
FileInputStream fis = null;
if (!srcF.exists()) {
@@ -231,8 +231,7 @@ public class Untar extends Expand {
final char[] magic = new char[] {'B', 'Z'};
for (int i = 0; i < magic.length; i++) {
if (istream.read() != magic[i]) {
- throw new BuildException(
- "Invalid bz2 file." + name);
+ throw new BuildException("Invalid bz2 file." + name);
}
}
return new CBZip2InputStream(istream);
diff --git a/src/main/org/apache/tools/ant/taskdefs/WaitFor.java b/src/main/org/apache/tools/ant/taskdefs/WaitFor.java
index d23beabc3..3f94d6fe2 100644
--- a/src/main/org/apache/tools/ant/taskdefs/WaitFor.java
+++ b/src/main/org/apache/tools/ant/taskdefs/WaitFor.java
@@ -268,8 +268,8 @@ public class WaitFor extends ConditionBase {
/**
* @see EnumeratedAttribute#getValues()
+ * {@inheritDoc}
*/
- /** {@inheritDoc} */
public String[] getValues() {
return UNITS;
}
diff --git a/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison.java b/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison.java
index 5976bce9e..617790a4a 100644
--- a/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison.java
+++ b/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison.java
@@ -66,4 +66,4 @@ public interface XSLTLiaison {
*/
void transform(File infile, File outfile) throws Exception; //NOSONAR
-} //-- XSLTLiaison
+}
diff --git a/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison2.java b/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison2.java
index f41f91511..0653b40a4 100644
--- a/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison2.java
+++ b/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison2.java
@@ -26,7 +26,7 @@ package org.apache.tools.ant.taskdefs;
*/
public interface XSLTLiaison2 extends XSLTLiaison {
/**
- * Configure the liaision from the XSLTProcess task
+ * Configure the liaison from the XSLTProcess task
* @param xsltTask the XSLTProcess task
*/
void configure(XSLTProcess xsltTask);
diff --git a/src/main/org/apache/tools/ant/taskdefs/XSLTProcess.java b/src/main/org/apache/tools/ant/taskdefs/XSLTProcess.java
index 8fce71eeb..676f6ae9a 100644
--- a/src/main/org/apache/tools/ant/taskdefs/XSLTProcess.java
+++ b/src/main/org/apache/tools/ant/taskdefs/XSLTProcess.java
@@ -607,6 +607,7 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
/**
* Whether to suppress warning messages of the processor.
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setSuppressWarnings(final boolean b) {
@@ -616,6 +617,7 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
/**
* Whether to suppress warning messages of the processor.
*
+ * @return boolean
* @since Ant 1.8.0
*/
public boolean getSuppressWarnings() {
@@ -625,6 +627,7 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
/**
* Whether transformation errors should make the build fail.
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setFailOnTransformationError(final boolean b) {
@@ -634,6 +637,7 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
/**
* Whether any errors should make the build fail.
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setFailOnError(final boolean b) {
@@ -643,6 +647,7 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
/**
* Whether the build should fail if the nested resource collection is empty.
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setFailOnNoResources(final boolean b) {
@@ -652,6 +657,7 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
/**
* A system property to set during transformation.
*
+ * @param sysp Environment.Variable
* @since Ant 1.8.0
*/
public void addSysproperty(final Environment.Variable sysp) {
@@ -661,6 +667,7 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
/**
* A set of system properties to set during transformation.
*
+ * @param sysp PropertySet
* @since Ant 1.8.0
*/
public void addSyspropertyset(final PropertySet sysp) {
@@ -674,6 +681,7 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
* processor other than trax or if the Transformer is not Xalan2's
* transformer implementation.
*
+ * @return TraceConfiguration
* @since Ant 1.8.0
*/
public TraceConfiguration createTrace() {
@@ -688,6 +696,7 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
/**
* Configuration for Xalan2 traces.
*
+ * @return TraceConfiguration
* @since Ant 1.8.0
*/
public TraceConfiguration getTraceConfiguration() {
@@ -719,7 +728,6 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
* As a side effect, the loader is set as the thread context classloader
* @param classname the name of the class to load.
* @return the requested class.
- * @exception Exception if the class could not be loaded.
*/
private Class loadClass(final String classname) throws ClassNotFoundException {
setupLoader();
@@ -753,7 +761,7 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
/**
* specifies a single XML document to be styled. Should be used
- * with the out attribute; ; required if out is set
+ * with the out attribute; required if out is set
*
* @param inFile the input file
*/
@@ -1021,6 +1029,7 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
}
/**
+ * @param type String
* @see ParamType
* @since Ant 1.9.3
*/
@@ -1056,6 +1065,7 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
}
/**
+ * @return String
* @see ParamType
* @since Ant 1.9.3
*/
@@ -1412,6 +1422,7 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
* Throws an exception with the given message if failOnError is
* true, otherwise logs the message using the WARN level.
*
+ * @param msg String
* @since Ant 1.8.0
*/
protected void handleError(final String msg) {
@@ -1427,6 +1438,7 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
* failOnError is true, otherwise logs the message using the WARN
* level.
*
+ * @param ex Throwable
* @since Ant 1.8.0
*/
protected void handleError(final Throwable ex) {
@@ -1442,6 +1454,7 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
* failOnError and failOnTransformationError are true, otherwise
* logs the message using the WARN level.
*
+ * @param ex Exception
* @since Ant 1.8.0
*/
protected void handleTransformationError(final Exception ex) {
@@ -1515,6 +1528,8 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
/**
* The configured features.
* @since Ant 1.9.8
+ *
+ * @return Iterable<Feature>
*/
public IterableThis task requires the following attributes:
+ *This task requires the following attributes:
* *Defaults to false.
* + * @param b boolean * @since Ant 1.8.0 */ public void setFallBackToUTF8(final boolean b) { @@ -567,6 +574,7 @@ public class Zip extends MatchingTask { * Whether to fall back to UTF-8 if a name cannot be encoded using * the specified encoding. * + * @return boolean * @since Ant 1.8.0 */ public boolean getFallBackToUTF8() { @@ -575,6 +583,7 @@ public class Zip extends MatchingTask { /** * Whether Zip64 extensions should be used. + * @param b boolean * @since Ant 1.9.1 */ public void setZip64Mode(final Zip64ModeAttribute b) { @@ -583,6 +592,7 @@ public class Zip extends MatchingTask { /** * Whether Zip64 extensions will be used. + * @return boolean * @since Ant 1.9.1 */ public Zip64ModeAttribute getZip64Mode() { @@ -606,6 +616,7 @@ public class Zip extends MatchingTask { /** * The file modification time previously provided to * {@link #setModificationtime(String)} or {@code null} if unset. + * @return String * @since Ant 1.9.10 */ public String getModificationtime() { @@ -1691,7 +1702,7 @@ public class Zip extends MatchingTask { /** * Add a directory to the zip stream. - * @param dir the directort to add to the archive + * @param dir the directory to add to the archive * @param zOut the stream to write to * @param vPath the name this entry shall have in the archive * @param mode the Unix permissions to set. @@ -1786,6 +1797,7 @@ public class Zip extends MatchingTask { /** * Provides the extra fields for the zip entry currently being * added to the archive - if any. + * @return ZipExtraField[] * @since Ant 1.8.0 */ protected final ZipExtraField[] getCurrentExtraFields() { @@ -1795,6 +1807,7 @@ public class Zip extends MatchingTask { /** * Sets the extra fields for the zip entry currently being * added to the archive - if any. + * @param extra ZipExtraField[] * @since Ant 1.8.0 */ protected final void setCurrentExtraFields(final ZipExtraField[] extra) { @@ -2115,6 +2128,7 @@ public class Zip extends MatchingTask { /** * Drops all resources from the given array that are not selected * @param orig the resources to filter + * @param selector ResourceSelector * @return the filters resources * @since Ant 1.8.0 */ @@ -2141,6 +2155,8 @@ public class Zip extends MatchingTask { * Logs a message at the given output level, but only if this is * the pass that will actually create the archive. * + * @param msg String + * @param level int * @since Ant 1.8.0 */ protected void logWhenWriting(final String msg, final int level) { @@ -2156,8 +2172,8 @@ public class Zip extends MatchingTask { public static class Duplicate extends EnumeratedAttribute { /** * @see EnumeratedAttribute#getValues() + * {@inheritDoc} */ - /** {@inheritDoc} */ @Override public String[] getValues() { return new String[] {"add", "preserve", "fail"}; @@ -2215,7 +2231,7 @@ public class Zip extends MatchingTask { } /** - * Policiy for creation of Unicode extra fields: never, always or + * Policy for creation of Unicode extra fields: never, always or * not-encodeable. * * @since Ant 1.8.0 diff --git a/src/main/org/apache/tools/ant/taskdefs/compilers/DefaultCompilerAdapter.java b/src/main/org/apache/tools/ant/taskdefs/compilers/DefaultCompilerAdapter.java index 350dbe560..7b291f5e9 100644 --- a/src/main/org/apache/tools/ant/taskdefs/compilers/DefaultCompilerAdapter.java +++ b/src/main/org/apache/tools/ant/taskdefs/compilers/DefaultCompilerAdapter.java @@ -299,7 +299,7 @@ public abstract class DefaultCompilerAdapter cmd.createArgument().setValue("-classpath"); - // Just add "sourcepath" to classpath ( for JDK1.1 ) + // Just add "sourcepath" to classpath (for JDK1.1) // as well as "bootclasspath" and "extdirs" if (assumeJava11()) { final Path cp = new Path(project); diff --git a/src/main/org/apache/tools/ant/taskdefs/compilers/JavacExternal.java b/src/main/org/apache/tools/ant/taskdefs/compilers/JavacExternal.java index ab2845442..e227ecf24 100644 --- a/src/main/org/apache/tools/ant/taskdefs/compilers/JavacExternal.java +++ b/src/main/org/apache/tools/ant/taskdefs/compilers/JavacExternal.java @@ -66,9 +66,9 @@ public class JavacExternal extends DefaultCompilerAdapter { /** * helper method to execute our command on VMS. - * @param cmd - * @param firstFileName - * @return + * @param cmd Commandline + * @param firstFileName int + * @return boolean */ private boolean execOnVMS(Commandline cmd, int firstFileName) { File vmsFile = null; diff --git a/src/main/org/apache/tools/ant/taskdefs/condition/Http.java b/src/main/org/apache/tools/ant/taskdefs/condition/Http.java index 4c0427886..0958c2df6 100644 --- a/src/main/org/apache/tools/ant/taskdefs/condition/Http.java +++ b/src/main/org/apache/tools/ant/taskdefs/condition/Http.java @@ -67,7 +67,7 @@ public class Http extends ProjectComponent implements Condition { * * @param method The HTTP request method to use. Valid values are * the same as those accepted by the - * HttpURLConnection.setRequestMetho d() method, + * HttpURLConnection.setRequestMethod() method, * such as "GET", "HEAD", "TRACE", etc. The default * if not specified is "GET". * @@ -82,6 +82,8 @@ public class Http extends ProjectComponent implements Condition { /** * Whether redirects sent by the server should be followed, * defaults to true. + * + * @param f boolean * @since Ant 1.9.7 */ public void setFollowRedirects(boolean f) { diff --git a/src/main/org/apache/tools/ant/taskdefs/condition/IsLastModified.java b/src/main/org/apache/tools/ant/taskdefs/condition/IsLastModified.java index ddacd9987..a8bdbba81 100644 --- a/src/main/org/apache/tools/ant/taskdefs/condition/IsLastModified.java +++ b/src/main/org/apache/tools/ant/taskdefs/condition/IsLastModified.java @@ -153,8 +153,8 @@ public class IsLastModified extends ProjectComponent implements Condition { /** * evaluate the condition - * @return true or false depending on the compoarison mode and the time of the resource - * @throws BuildException + * @return true or false depending on the comparison mode and the time of the resource + * @throws BuildException if something goes wrong */ public boolean eval() throws BuildException { validate(); 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 e699da115..e673b828b 100644 --- a/src/main/org/apache/tools/ant/taskdefs/condition/IsReachable.java +++ b/src/main/org/apache/tools/ant/taskdefs/condition/IsReachable.java @@ -187,7 +187,7 @@ public class IsReachable extends ProjectComponent implements Condition { //utterly implausible, but catered for anyway throw new BuildException("When calling " + reachableMethod); } catch (final InvocationTargetException e) { - //assume this is an IOexception about un readability + //assume this is an IOException about un readability final Throwable nested = e.getTargetException(); log(ERROR_ON_NETWORK + target + ": " + nested.toString()); //any kind of fault: not reachable. 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 974c396fb..7bd5b0123 100644 --- a/src/main/org/apache/tools/ant/taskdefs/condition/Os.java +++ b/src/main/org/apache/tools/ant/taskdefs/condition/Os.java @@ -102,8 +102,8 @@ public class Os implements Condition { /** * OpenJDK is reported to call MacOS X "Darwin" - * @see https://issues.apache.org/bugzilla/show_bug.cgi?id=44889 - * @see https://issues.apache.org/jira/browse/HADOOP-3318 + * @see Bugzilla + * @see Jira */ private static final String DARWIN = "darwin"; @@ -126,8 +126,8 @@ public class Os implements Condition { /** * Sets the desired OS family type * - * @param f The OS family type desiredPossible values:
*- * <!-- Root element --> - * <!ELEMENT changelog - * (entry+) - * > - * <!-- CVS Entry --> - * <!ELEMENT entry - * (date,author,file+,msg) - * > - * <!-- Date of cvs entry --> - * <!ELEMENT date (#PCDATA) - * > - * <!-- Author of change --> - * <!ELEMENT author (#PCDATA) - * > - * <!-- List of files affected --> - * <!ELEMENT msg (#PCDATA) - * > - * <!-- File changed --> - * <!ELEMENT file - * (name,revision,prevrevision? - * )> - * <!-- Name of the file --> - * <!ELEMENT name (#PCDATA) - * > - * <!-- Revision number --> - * <!ELEMENT revision - * (#PCDATA)> - * <!-- Previous revision number --> - * <!ELEMENT prevrevision - * (#PCDATA)> + * <!-- Root element --> + * <!ELEMENT changelog (entry+)> + * <!-- CVS Entry --> + * <!ELEMENT entry (date,author,file+,msg)> + * <!-- Date of cvs entry --> + * <!ELEMENT date (#PCDATA)> + * <!-- Author of change --> + * <!ELEMENT author (#PCDATA)> + * <!-- List of files affected --> + * <!ELEMENT msg (#PCDATA)> + * <!-- File changed --> + * <!ELEMENT file (name,revision,prevrevision?)> + * <!-- Name of the file --> + * <!ELEMENT name (#PCDATA)> + * <!-- Revision number --> + * <!ELEMENT revision (#PCDATA)> + * <!-- Previous revision number --> + * <!ELEMENT prevrevision (#PCDATA)> ** * @since Ant 1.5 @@ -191,6 +179,7 @@ public class ChangeLogTask extends AbstractCvsTask { * Whether to use rlog against a remote repository instead of log * in a working copy's directory. * + * @param remote boolean * @since Ant 1.8.0 */ public void setRemote(final boolean remote) { diff --git a/src/main/org/apache/tools/ant/taskdefs/cvslib/CvsTagDiff.java b/src/main/org/apache/tools/ant/taskdefs/cvslib/CvsTagDiff.java index 6f17402d8..79111bd4c 100644 --- a/src/main/org/apache/tools/ant/taskdefs/cvslib/CvsTagDiff.java +++ b/src/main/org/apache/tools/ant/taskdefs/cvslib/CvsTagDiff.java @@ -45,9 +45,9 @@ import org.w3c.dom.Element; * Examines the output of cvs rdiff between two tags. * * It produces an XML output representing the list of changes. - *
+ ** * @since Ant 1.5 * @ant.task name="cvstagdiff" 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 edc9c9dcd..25e355566 100644 --- a/src/main/org/apache/tools/ant/taskdefs/email/EmailAddress.java +++ b/src/main/org/apache/tools/ant/taskdefs/email/EmailAddress.java @@ -92,15 +92,15 @@ public class EmailAddress { } } - // DEBUG: System.out.println( email ); + // DEBUG: System.out.println(email); if (end == 0) { end = len; } - // DEBUG: System.out.println( "address: " + start + " " + end ); + // DEBUG: System.out.println("address: " + start + " " + end); if (nEnd == 0) { nEnd = len; } - // DEBUG: System.out.println( "name: " + nStart + " " + nEnd ); + // DEBUG: System.out.println("name: " + nStart + " " + nEnd); this.address = trim(email.substring(start, end), true); this.name = trim(email.substring(nStart, nEnd), false); diff --git a/src/main/org/apache/tools/ant/taskdefs/email/EmailTask.java b/src/main/org/apache/tools/ant/taskdefs/email/EmailTask.java index 0a5bc6817..7657794ee 100644 --- a/src/main/org/apache/tools/ant/taskdefs/email/EmailTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/email/EmailTask.java @@ -111,6 +111,7 @@ public class EmailTask extends Task { /** * Set the user for SMTP auth; this requires JavaMail. + * * @param user the String username. * @since Ant 1.6 */ @@ -120,6 +121,7 @@ public class EmailTask extends Task { /** * Set the password for SMTP auth; this requires JavaMail. + * * @param password the String password. * @since Ant 1.6 */ @@ -129,6 +131,7 @@ public class EmailTask extends Task { /** * Set whether to send data over SSL. + * * @param ssl boolean; if true SSL will be used. * @since Ant 1.6 */ @@ -139,6 +142,7 @@ public class EmailTask extends Task { /** * Set whether to allow authentication to switch to a TLS * connection via STARTTLS. + * * @param b boolean; if true STARTTLS will be supported. * @since Ant 1.8.0 */ @@ -425,6 +429,7 @@ public class EmailTask extends Task { ** <!-- Root element --> - * <!ELEMENT tagdiff ( entry+ ) > + * <!ELEMENT tagdiff (entry+) > * <!-- Start tag of the report --> * <!ATTLIST tagdiff startTag NMTOKEN #IMPLIED > * <!-- End tag of the report --> @@ -58,16 +58,16 @@ import org.w3c.dom.Element; * <!ATTLIST tagdiff endDate NMTOKEN #IMPLIED > * * <!-- CVS tag entry --> - * <!ELEMENT entry ( file ) > + * <!ELEMENT entry (file) > * <!-- File added, changed or removed --> - * <!ELEMENT file ( name, revision?, prevrevision? ) > + * <!ELEMENT file (name, revision?, prevrevision?) > * <!-- Name of the file --> - * <!ELEMENT name ( #PCDATA ) > + * <!ELEMENT name (#PCDATA) > * <!-- Revision number --> - * <!ELEMENT revision ( #PCDATA ) > + * <!ELEMENT revision (#PCDATA) > * <!-- Previous revision number --> - * <!ELEMENT prevrevision ( #PCDATA ) > - *+ * <!ELEMENT prevrevision (#PCDATA) > + *
Even with this property set to true the task will still fail * if the mail couldn't be sent to any recipient at all.
* + * @param b boolean * @since Ant 1.8.0 */ public void setIgnoreInvalidRecipients(boolean b) { diff --git a/src/main/org/apache/tools/ant/taskdefs/email/Mailer.java b/src/main/org/apache/tools/ant/taskdefs/email/Mailer.java index 4aaa9823c..352ae0b57 100644 --- a/src/main/org/apache/tools/ant/taskdefs/email/Mailer.java +++ b/src/main/org/apache/tools/ant/taskdefs/email/Mailer.java @@ -74,6 +74,8 @@ public abstract class Mailer { /** * Whether the port has been explicitly specified by the user. + * + * @param explicit boolean * @since Ant 1.8.2 */ public void setPortExplicitlySpecified(boolean explicit) { @@ -82,6 +84,8 @@ public abstract class Mailer { /** * Whether the port has been explicitly specified by the user. + * + * @return boolean * @since Ant 1.8.2 */ protected boolean isPortExplicitlySpecified() { @@ -151,9 +155,9 @@ public abstract class Mailer { } /** - * Set the replyto addresses. + * Set the replyTo addresses. * - * @param list a vector of reployTo addresses. + * @param list a vector of replyTo addresses. * @since Ant 1.6 */ public void setReplyToList(VectorEven with this property set to true the task will still fail * if the mail couldn't be sent to any recipient at all.
* + * @param b boolean * @since Ant 1.8.0 */ public void setIgnoreInvalidRecipients(boolean b) { @@ -256,6 +261,7 @@ public abstract class Mailer { /** * Whether invalid recipients should be ignored. * + * @return boolean * @since Ant 1.8.0 */ protected boolean shouldIgnoreInvalidRecipients() { @@ -267,7 +273,6 @@ public abstract class Mailer { * header. * * @return the current date in SMTP suitable format. - * * @since Ant 1.5 */ protected final String getDate() { diff --git a/src/main/org/apache/tools/ant/taskdefs/launcher/CommandLauncher.java b/src/main/org/apache/tools/ant/taskdefs/launcher/CommandLauncher.java index f39fff046..cc9fb886f 100644 --- a/src/main/org/apache/tools/ant/taskdefs/launcher/CommandLauncher.java +++ b/src/main/org/apache/tools/ant/taskdefs/launcher/CommandLauncher.java @@ -131,6 +131,9 @@ public class CommandLauncher { /** * Obtains the shell launcher configured for the given project or * the default shell launcher. + * + * @param project Project + * @return CommandLauncher */ public static CommandLauncher getShellLauncher(Project project) { CommandLauncher launcher = extractLauncher(ANT_SHELL_LAUNCHER_REF_ID, @@ -145,6 +148,9 @@ public class CommandLauncher { /** * Obtains the VM launcher configured for the given project or * the default VM launcher. + * + * @param project Project + * @return CommandLauncher */ public static CommandLauncher getVMLauncher(Project project) { CommandLauncher launcher = extractLauncher(ANT_VM_LAUNCHER_REF_ID, @@ -192,6 +198,9 @@ public class CommandLauncher { /** * Sets the VM launcher to use for the given project. + * + * @param project Project + * @param launcher CommandLauncher */ public static void setVMLauncher(Project project, CommandLauncher launcher) { @@ -202,6 +211,9 @@ public class CommandLauncher { /** * Sets the shell launcher to use for the given project. + * + * @param project Project + * @param launcher CommandLauncher */ public static void setShellLauncher(Project project, CommandLauncher launcher) { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ANTLR.java b/src/main/org/apache/tools/ant/taskdefs/optional/ANTLR.java index 605b33684..ba8afd275 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/ANTLR.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/ANTLR.java @@ -96,7 +96,7 @@ public class ANTLR extends Task { /** * The grammar file to process. - * @param target the gramer file + * @param target the grammar file */ public void setTarget(File target) { log("Setting target to: " + target.toString(), Project.MSG_VERBOSE); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/EchoProperties.java b/src/main/org/apache/tools/ant/taskdefs/optional/EchoProperties.java index 30bcc759c..141ed17ff 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/EchoProperties.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/EchoProperties.java @@ -55,35 +55,38 @@ import org.w3c.dom.Document; import org.w3c.dom.Element; /** - * Displays all the current properties in the build. The output can be sent to - * a file if desired.- * - * Attribute "destfile" defines a file to send the properties to. This can be - * processed as a standard property file later.
- * - * Attribute "prefix" defines a prefix which is used to filter the properties - * only those properties starting with this prefix will be echoed.
- * - * By default, the "failonerror" attribute is enabled. If an error occurs while - * writing the properties to a file, and this attribute is enabled, then a - * BuildException will be thrown. If disabled, then IO errors will be reported - * as a log statement, but no error will be thrown.
- * - * Examples:
+ * Displays all the current properties in the build. The output can be sent to + * a file if desired. + *+ * Report all properties beginning with 'ant' to the file + * "my.properties", and will log a message if the file could not be created or + * written to, but will still allow the build to continue. * *@since Ant 1.5 */ @@ -115,15 +118,15 @@ public class EchoProperties extends Task { private File inFile = null; /** - * File object pointing to the output file. If this is null, then - * we output to the project log, not to a file. + * File object pointing to the output file. If this is null, then + * we output to the project log, not to a file. */ private File destfile = null; /** - * If this is true, then errors generated during file output will become - * build errors, and if false, then such errors will be logged, but not - * thrown. + * If this is true, then errors generated during file output will become + * build errors, and if false, then such errors will be logged, but not + * thrown. */ private boolean failonerror = true; @@ -151,7 +154,7 @@ public class EchoProperties extends Task { * Set a file to store the property output. If this is never specified, * then the output will be sent to the Ant log. * - *@param destfile file to store the property output + * @param destfile file to store the property output */ public void setDestfile(File destfile) { this.destfile = destfile; @@ -162,7 +165,7 @@ public class EchoProperties extends Task { * If true, the task will fail if an error occurs writing the properties * file, otherwise errors are just logged. * - *@param failonerror true if IO exceptions are reported as build + * @param failonerror true if IO exceptions are reported as build * exceptions, or false if IO exceptions are ignored. */ public void setFailOnError(boolean failonerror) { @@ -171,15 +174,15 @@ public class EchoProperties extends Task { /** - * If the prefix is set, then only properties which start with this - * prefix string will be recorded. If regex is not set and if this - * is never set, or it is set to an empty string or null, - * then all properties will be recorded.+ * Attribute "destfile" defines a file to send the properties to. This can be + * processed as a standard property file later. + *
+ *+ * Attribute "prefix" defines a prefix which is used to filter the properties + * only those properties starting with this prefix will be echoed. + *
+ *+ * By default, the "failonerror" attribute is enabled. If an error occurs while + * writing the properties to a file, and this attribute is enabled, then a + * BuildException will be thrown. If disabled, then IO errors will be reported + * as a log statement, but no error will be thrown. + *
+ *Examples:
* <echoproperties /> - *Report the current properties to the log.- * - *
+ *+ * Report the current properties to the log. + ** <echoproperties destfile="my.properties" /> - *Report the current properties to the file "my.properties", and will - * fail the build if the file could not be created or written to.- * - *
+ *+ * Report the current properties to the file "my.properties", and will + * fail the build if the file could not be created or written to. + ** <echoproperties destfile="my.properties" failonerror="false" * prefix="ant" /> - *Report all properties beginning with 'ant' to the file - * "my.properties", and will log a message if the file could not be created or - * written to, but will still allow the build to continue. + *
+ * If the prefix is set, then only properties which start with this + * prefix string will be recorded. If regex is not set and if this + * is never set, or it is set to an empty string or null, + * then all properties will be recorded. * - * For example, if the attribute is set as: - *
<echoproperties prefix="ant." />- * then the property "ant.home" will be recorded, but "ant-example" - * will not. + *
For example, if the attribute is set as:
+ *<echoproperties prefix="ant." />+ * then the property "ant.home" will be recorded, but "ant-example" + * will not. * * @param prefix The new prefix value */ @@ -194,15 +197,15 @@ public class EchoProperties extends Task { } /** - * If the regex is set, then only properties whose names match it - * will be recorded. If prefix is not set and if this is never set, - * or it is set to an empty string or null, then all - * properties will be recorded.
+ * If the regex is set, then only properties whose names match it + * will be recorded. If prefix is not set and if this is never set, + * or it is set to an empty string or null, then all + * properties will be recorded. * - * For example, if the attribute is set as: - *
<echoproperties prefix=".*ant.*" />- * then the properties "ant.home" and "user.variant" will be recorded, - * but "ant-example" will not. + *
For example, if the attribute is set as:
+ *<echoproperties prefix=".*ant.*" />+ * then the properties "ant.home" and "user.variant" will be recorded, + * but "ant-example" will not. * * @param regex The new regex value * @@ -252,9 +255,9 @@ public class EchoProperties extends Task { } /** - * Run the task. + * Run the task. * - *@exception BuildException trouble, probably file IO + * @exception BuildException trouble, probably file IO */ public void execute() throws BuildException { if (prefix != null && regex != null) { @@ -368,10 +371,10 @@ public class EchoProperties extends Task { /** - * Send the key/value pairs in the hashtable to the given output stream. - * Only those properties matching the prefix constraint will be - * sent to the output stream. - * The output stream will be closed when this method returns. + * Send the key/value pairs in the hashtable to the given output stream. + * Only those properties matching the prefix constraint will be + * sent to the output stream. + * The output stream will be closed when this method returns. * * @param allProps propfile to save * @param os output stream @@ -461,7 +464,7 @@ public class EchoProperties extends Task { } private List sortProperties(Properties props) { - //sort the list. Makes SCM and manual diffs easier. + // sort the list. Makes SCM and manual diffs easier. List sorted = new ArrayList(props.size()); Enumeration e = props.propertyNames(); while (e.hasMoreElements()) { @@ -511,14 +514,14 @@ public class EchoProperties extends Task { } /** - * JDK 1.2 allows for the safer method - * Properties.store(OutputStream, String), which throws an - * IOException on an output error. + * JDK 1.2 allows for the safer method + * Properties.store(OutputStream, String), which throws an + * IOException on an output error. * - *@param props the properties to record - *@param os record the properties to this output stream - *@param header prepend this header to the property output - *@exception IOException on an I/O error during a write. + * @param props the properties to record + * @param os record the properties to this output stream + * @param header prepend this header to the property output + * @exception IOException on an I/O error during a write. */ protected void jdkSaveProperties(Properties props, OutputStream os, String header) throws IOException { @@ -542,7 +545,7 @@ public class EchoProperties extends Task { /** * Uses the DocumentBuilderFactory to get a DocumentBuilder instance. * - * @return The DocumentBuilder instance + * @return The DocumentBuilder instance */ private static DocumentBuilder getDocumentBuilder() { try { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/Javah.java b/src/main/org/apache/tools/ant/taskdefs/optional/Javah.java index 06e1d110d..bf2d679a1 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/Javah.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/Javah.java @@ -411,6 +411,7 @@ public class Javah extends Task { * The classpath to use when loading the javah implementation * if it is not a built-in one. * + * @return Path * @since Ant 1.8.0 */ public Path createImplementationClasspath() { @@ -419,6 +420,8 @@ public class Javah extends Task { /** * Set the adapter explicitly. + * + * @param adapter JavahAdapter * @since Ant 1.8.0 */ public void add(JavahAdapter adapter) { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/Native2Ascii.java b/src/main/org/apache/tools/ant/taskdefs/optional/Native2Ascii.java index 81a386fd2..2221e3985 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/Native2Ascii.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/Native2Ascii.java @@ -69,6 +69,7 @@ public class Native2Ascii extends MatchingTask { /** * The value of the reverse attribute. + * * @return the reverse attribute. * @since Ant 1.6.3 */ @@ -89,6 +90,7 @@ public class Native2Ascii extends MatchingTask { /** * The value of the encoding attribute. + * * @return the encoding attribute. * @since Ant 1.6.3 */ @@ -127,6 +129,7 @@ public class Native2Ascii extends MatchingTask { /** * Choose the implementation for this particular task. + * * @param impl the name of the implementation * @since Ant 1.6.3 */ @@ -142,7 +145,6 @@ public class Native2Ascii extends MatchingTask { * Defines the FileNameMapper to use (nested mapper element). * * @return the mapper to use for file name translations. - * * @throws BuildException if more than one mapper is defined. */ public Mapper createMapper() throws BuildException { @@ -156,6 +158,7 @@ public class Native2Ascii extends MatchingTask { /** * A nested filenamemapper + * * @param fileNameMapper the mapper to add * @since Ant 1.6.3 */ @@ -165,8 +168,8 @@ public class Native2Ascii extends MatchingTask { /** * Adds an implementation specific command-line argument. - * @return a ImplementationSpecificArgument to be configured * + * @return a ImplementationSpecificArgument to be configured * @since Ant 1.6.3 */ public ImplementationSpecificArgument createArg() { @@ -180,6 +183,7 @@ public class Native2Ascii extends MatchingTask { * The classpath to use when loading the native2ascii * implementation if it is not a built-in one. * + * @return Path * @since Ant 1.8.0 */ public Path createImplementationClasspath() { @@ -188,6 +192,8 @@ public class Native2Ascii extends MatchingTask { /** * Set the adapter explicitly. + * + * @param adapter Native2AsciiAdapter * @since Ant 1.8.0 */ public void add(Native2AsciiAdapter adapter) { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/NetRexxC.java b/src/main/org/apache/tools/ant/taskdefs/optional/NetRexxC.java index dff24bc9b..3f85ed749 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/NetRexxC.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/NetRexxC.java @@ -81,16 +81,15 @@ import org.apache.tools.ant.util.FileUtils; * *
When this task executes, it will recursively scan the srcdir * looking for NetRexx source files to compile. This task makes its - * compile decision based on timestamp. + * compile decision based on timestamp.
*Before files are compiled they and any other file in the * srcdir will be copied to the destdir allowing support files to be * located properly in the classpath. The reason for copying the source files - * before the compile is that NetRexxC has only two destinations for classfiles: + * before the compile is that NetRexxC has only two destinations for classfiles:
** The <propertyfile> task must have: + *
** The <entry> task must have: + *
** If type is unspecified, it defaults to string. - * + *
* Parameter values: - *String property types can only use the "=" operation. * Int property types can only use the "=", "-" or "+" operations.
@@ -246,6 +254,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 d088096ab..cf07885d7 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.java @@ -148,6 +148,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) { @@ -158,6 +159,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) { @@ -174,6 +176,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 */ @@ -191,15 +194,16 @@ public class ReplaceRegExp extends Task { * The flags to use when matching the regular expression. For more * information, consult the Perl5 syntax. *
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 350d673c7..7777718a4 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 @@ -109,22 +109,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 () + } } @@ -319,15 +319,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.getClass().getName()); } 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 28f806459..35a08343b 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 @@ -74,11 +74,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 371d418bd..f7c4a5fa3 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; ** The following attributes are interpreted: *
Attribute | *Values | diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.java index 0eaf09acc..e60bfc966 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.java @@ -30,6 +30,7 @@ import org.apache.tools.ant.types.Commandline; *
---|
Attribute | *Values | diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCLock.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCLock.java index c273554e7..ba7def72e 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCLock.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCLock.java @@ -37,6 +37,7 @@ import org.apache.tools.ant.types.Commandline; *
---|
Attribute | *Values | diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkattr.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkattr.java index 128ea16b7..89b55f970 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkattr.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkattr.java @@ -29,6 +29,7 @@ import org.apache.tools.ant.types.Commandline; *
---|
Attribute | *Values | diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkbl.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkbl.java index 82c960051..ac0f42b06 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkbl.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkbl.java @@ -28,6 +28,7 @@ import org.apache.tools.ant.types.Commandline; *
---|
Attribute | *Values | diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkdir.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkdir.java index 4c89539fe..441ff52f0 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkdir.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkdir.java @@ -29,6 +29,7 @@ import org.apache.tools.ant.types.Commandline; *
---|
Attribute | *Values | diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkelem.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkelem.java index 94faa5a6c..53d2f0bf1 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkelem.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkelem.java @@ -29,6 +29,7 @@ import org.apache.tools.ant.types.Commandline; *
---|
Attribute | *Values | diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklabel.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklabel.java index e3d288df5..b1a96868f 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklabel.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklabel.java @@ -28,6 +28,7 @@ import org.apache.tools.ant.types.Commandline; *
---|
Attribute | *Values | diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklbtype.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklbtype.java index 7bb7192e8..04db9cda4 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklbtype.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklbtype.java @@ -28,6 +28,7 @@ import org.apache.tools.ant.types.Commandline; *
---|
Attribute | *Values | diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCRmtype.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCRmtype.java index cef0c3a57..82a9e6399 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCRmtype.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCRmtype.java @@ -28,6 +28,7 @@ import org.apache.tools.ant.types.Commandline; *
---|
Attribute | *Values | @@ -41,7 +42,7 @@ import org.apache.tools.ant.types.Commandline; * eltype element typeYes | *|||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Attribute | *Values | diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnlock.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnlock.java index 4ca3e8905..7d7272670 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnlock.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnlock.java @@ -34,6 +34,7 @@ import org.apache.tools.ant.types.Commandline; *
---|
Attribute | *Values | diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUpdate.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUpdate.java index 712efdcae..a8ee850aa 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUpdate.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUpdate.java @@ -29,6 +29,7 @@ import org.apache.tools.ant.types.Commandline; *
---|
Attribute | *Values | 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 2cf335cbe..7b5113392 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 @@ -553,7 +553,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/constantpool/MethodHandleCPInfo.java b/src/main/org/apache/tools/ant/taskdefs/optional/depend/constantpool/MethodHandleCPInfo.java index e11e3aabd..a5906c745 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/DescriptorHandler.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/DescriptorHandler.java index 158cba937..ac2aa7224 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/DescriptorHandler.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/DescriptorHandler.java @@ -175,7 +175,7 @@ public class DescriptorHandler extends org.xml.sax.HandlerBase { /** * Resolve the entity. - * @see org.xml.sax.EntityResolver#resolveEntity(String, String). + * @see org.xml.sax.EntityResolver#resolveEntity(String, String) * @param publicId The public identifier, or
---|
key | description | default value | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
haltOnError | halt test on - * errors? | false | ||||||||||||||||||||||||||||||
haltOnFailure | halt test on - * failures? | false | ||||||||||||||||||||||||||||||
formatter | A JUnitResultFormatter given as
+ *
+ *
Interface groups XML constants. + * Interface groups XML constants. * Interface that groups all constants used throughout the XML * documents that are generated by the XMLJUnitResultFormatter. - * + * * As of now the DTD is: - *
+ *
* @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 416c10d43..171348f92 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
@@ -55,7 +55,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() {
@@ -363,4 +363,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 4f76c9687..1ba6ff6d1 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) @@ -229,7 +229,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. @@ -286,11 +286,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 3cd52afe5..c16a1a3bc 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 b78370657..80cb68109 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 @@ -61,13 +61,13 @@ import org.apache.tools.ant.util.VectorSet; /** * Basic FTP client. Performs the following actions: *
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 dd6016a8c..98f51ca0a 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.
- * - * + * Build the command line. + *
* CheckInFile required parameters: -server -name -password -database -project
* -file - * + * Build the command line + *
* CheckOutFile required parameters: -server -name -password -database -project -file - * + * Build the command line + *
* GetFile required parameters: -server -name -password -database -project -file - * AddLabel required parameters: -server -name -password -database -project -label - * AddLabel optional parameters: -verbose -comment + * Build the command line + *
+ * AddLabel required parameters: -server -name -password -database -project -label
- The <SOSGet> Retreives file(s) from a SOS database |