You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ant.apache.org by bo...@apache.org on 2017/12/10 07:58:49 UTC
[04/11] ant git commit: Let’s use doclint
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/optional/unix/AbstractAccessTask.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/unix/AbstractAccessTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/unix/AbstractAccessTask.java
index d3385e6..2e1331f 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/unix/AbstractAccessTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/unix/AbstractAccessTask.java
@@ -17,11 +17,11 @@
*/
/*
- * Since the initial version of this file was deveolped on the clock on
+ * Since the initial version of this file was developed on the clock on
* an NSF grant I should say the following boilerplate:
*
* This material is based upon work supported by the National Science
- * Foundaton under Grant No. EIA-0196404. Any opinions, findings, and
+ * Foundation under Grant No. EIA-0196404. Any opinions, findings, and
* conclusions or recommendations expressed in this material are those
* of the author and do not necessarily reflect the views of the
* National Science Foundation.
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/optional/unix/Chgrp.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/unix/Chgrp.java b/src/main/org/apache/tools/ant/taskdefs/optional/unix/Chgrp.java
index 1279a2c..cd2cc49 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/unix/Chgrp.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/unix/Chgrp.java
@@ -17,11 +17,11 @@
*/
/*
- * Since the initial version of this file was deveolped on the clock on
+ * Since the initial version of this file was developed on the clock on
* an NSF grant I should say the following boilerplate:
*
* This material is based upon work supported by the National Science
- * Foundaton under Grant No. EIA-0196404. Any opinions, findings, and
+ * Foundation under Grant No. EIA-0196404. Any opinions, findings, and
* conclusions or recommendations expressed in this material are those
* of the author and do not necessarily reflect the views of the
* National Science Foundation.
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/optional/unix/Chown.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/unix/Chown.java b/src/main/org/apache/tools/ant/taskdefs/optional/unix/Chown.java
index 53f7253..02a1c17 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/unix/Chown.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/unix/Chown.java
@@ -17,11 +17,11 @@
*/
/*
- * Since the initial version of this file was deveolped on the clock on
+ * Since the initial version of this file was developed on the clock on
* an NSF grant I should say the following boilerplate:
*
* This material is based upon work supported by the National Science
- * Foundaton under Grant No. EIA-0196404. Any opinions, findings, and
+ * Foundation under Grant No. EIA-0196404. Any opinions, findings, and
* conclusions or recommendations expressed in this material are those
* of the author and do not necessarily reflect the views of the
* National Science Foundation.
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/optional/unix/Symlink.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/unix/Symlink.java b/src/main/org/apache/tools/ant/taskdefs/optional/unix/Symlink.java
index e83c0b6..86f199d 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/unix/Symlink.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/unix/Symlink.java
@@ -21,7 +21,7 @@
* an NSF grant I should say the following boilerplate:
*
* This material is based upon work supported by the National Science
- * Foundaton under Grant No. EIA-0196404. Any opinions, findings, and
+ * Foundation under Grant No. EIA-0196404. Any opinions, findings, and
* conclusions or recommendations expressed in this material are those
* of the author and do not necessarily reflect the views of the
* National Science Foundation.
@@ -58,7 +58,7 @@ import org.apache.tools.ant.util.SymbolicLinkUtils;
/**
* Creates, Deletes, Records and Restores Symlinks.
*
- * <p> This task performs several related operations. In the most trivial
+ * <p>This task performs several related operations. In the most trivial
* and default usage, it creates a link specified in the link attribute to
* a resource specified in the resource attribute. The second usage of this
* task is to traverse a directory structure specified by a fileset,
@@ -67,33 +67,33 @@ import org.apache.tools.ant.util.SymbolicLinkUtils;
* directory structure specified by a fileset, looking for properties files
* (also specified as included in the fileset) and recreate the links
* that have been previously recorded for each directory. Finally, it can be
- * used to remove a symlink without deleting the associated resource.
+ * used to remove a symlink without deleting the associated resource.</p>
*
- * <p> Usage examples:
+ * <p>Usage examples:</p>
*
- * <p> Make a link named "foo" to a resource named
- * "bar.foo" in subdir:
+ * <p>Make a link named "foo" to a resource named
+ * "bar.foo" in subdir:</p>
* <pre>
* <symlink link="${dir.top}/foo" resource="${dir.top}/subdir/bar.foo"/>
* </pre>
*
- * <p> Record all links in subdir and its descendants in files named
- * "dir.links":
+ * <p>Record all links in subdir and its descendants in files named
+ * "dir.links":</p>
* <pre>
* <symlink action="record" linkfilename="dir.links">
* <fileset dir="${dir.top}" includes="subdir/**" />
* </symlink>
* </pre>
*
- * <p> Recreate the links recorded in the previous example:
+ * <p>Recreate the links recorded in the previous example:</p>
* <pre>
* <symlink action="recreate">
* <fileset dir="${dir.top}" includes="subdir/**/dir.links" />
* </symlink>
* </pre>
*
- * <p> Delete a link named "foo" to a resource named
- * "bar.foo" in subdir:
+ * <p>Delete a link named "foo" to a resource named
+ * "bar.foo" in subdir:</p>
* <pre>
* <symlink action="delete" link="${dir.top}/foo"/>
* </pre>
@@ -107,9 +107,9 @@ import org.apache.tools.ant.util.SymbolicLinkUtils;
* or action="recreate", but action="record" should still
* work. Finally, the lack of support for symlinks in Java means that all links
* are recorded as links to the <strong>canonical</strong> resource name.
- * Therefore the link: <code>link --> subdir/dir/../foo.bar</code> will be
+ * Therefore the link: <code>link --> subdir/dir/../foo.bar</code> will be
* recorded as <code>link=subdir/foo.bar</code> and restored as
- * <code>link --> subdir/foo.bar</code>.
+ * <code>link --> subdir/foo.bar</code>.</p>
*
*/
public class Symlink extends DispatchTask {
@@ -463,7 +463,7 @@ public class Symlink extends DispatchTask {
/**
* Conduct the actual construction of a link.
*
- * <p> The link is constructed by calling <code>Execute.runCommand</code>.
+ * <p>The link is constructed by calling <code>Execute.runCommand</code>.</p>
*
* @param res The path of the resource we are linking to.
* @param lnk The name of the link we wish to make.
@@ -501,9 +501,9 @@ public class Symlink extends DispatchTask {
/**
* Find all the links in all supplied filesets.
*
- * <p> This method is invoked when the action attribute is
+ * <p>This method is invoked when the action attribute is
* "record". This means that filesets are interpreted
- * as the directories in which links may be found.
+ * as the directories in which links may be found.</p>
*
* @param v The filesets specified by the user.
* @return A HashSet of <code>File</code> objects containing the
@@ -539,10 +539,10 @@ public class Symlink extends DispatchTask {
/**
* Load links from properties files included in one or more FileSets.
*
- * <p> This method is only invoked when the action attribute is set to
+ * <p>This method is only invoked when the action attribute is set to
* "recreate". The filesets passed in are assumed to specify the
* names of the property files with the link information and the
- * subdirectories in which to look for them.
+ * subdirectories in which to look for them.</p>
*
* @param v The <code>FileSet</code>s for this task.
* @return The links to be made.
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.java b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.java
index a47b230..ce240e3 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.java
@@ -95,15 +95,15 @@ public abstract class MSVSS extends Task implements MSVSSConstants {
private int numDays = Integer.MIN_VALUE;
/** Date format for History */
private DateFormat dateFormat = DateFormat.getDateInstance(DateFormat.SHORT);
- /** Timestamp for retreived files */
+ /** Timestamp for retrieved files */
private CurrentModUpdated timestamp = null;
/** Behaviour for writable files */
private WritableFiles writableFiles = null;
/**
- * Each sub-class must implemnt this method and return the constructed
+ * Each sub-class must implement this method and return the constructed
* command line to be executed. It is up to the sub-task to determine the
- * required attrubutes and their order.
+ * required attributes and their order.
* @return The Constructed command line.
*/
abstract Commandline buildCmdLine();
@@ -170,9 +170,12 @@ public abstract class MSVSS extends Task implements MSVSSConstants {
}
/**
- * Executes the task. <br>
+ * Executes the task.
+ * <p>
* Builds a command line to execute ss.exe and then calls Exec's run method
* to execute the command line.
+ * </p>
+ *
* @throws BuildException if the command cannot execute.
*/
public void execute() throws BuildException {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java
index 0241ee3..2e04e20 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java
@@ -94,7 +94,7 @@ public class MSVSSADD extends MSVSS {
}
/**
- * Autoresponce behaviour. Valid options are Y and N.
+ * Autoresponse behaviour. Valid options are Y and N.
*
* @param response The auto response value.
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKOUT.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKOUT.java b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKOUT.java
index edbcde9..4e56e0b 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKOUT.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKOUT.java
@@ -123,7 +123,7 @@ public class MSVSSCHECKOUT extends MSVSS {
}
/**
- * Autoresponce behaviour. Valid options are Y and N.
+ * Autoresponse behaviour. Valid options are Y and N.
*
* @param response The auto response value.
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCP.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCP.java b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCP.java
index ae2fcb7..7d7edc2 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCP.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCP.java
@@ -59,7 +59,7 @@ public class MSVSSCP extends MSVSS {
}
/**
- * Autoresponce behaviour. Valid options are Y and N.
+ * Autoresponse behaviour. Valid options are Y and N.
*
* @param response The auto response value.
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCREATE.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCREATE.java b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCREATE.java
index 4f298c0..16f1015 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCREATE.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCREATE.java
@@ -81,7 +81,7 @@ public class MSVSSCREATE extends MSVSS {
}
/**
- * Autoresponce behaviour. Valid options are Y and N.
+ * Autoresponse behaviour. Valid options are Y and N.
*
* @param response The auto response value.
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSGET.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSGET.java b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSGET.java
index fd5ed09..59ee272 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSGET.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSGET.java
@@ -140,7 +140,7 @@ public class MSVSSGET extends MSVSS {
}
/**
- * Autoresponce behaviour. Valid options are Y and N.
+ * Autoresponse behaviour. Valid options are Y and N.
*
* @param response The auto response value.
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSHISTORY.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSHISTORY.java b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSHISTORY.java
index 05ec91c..4fdc95d 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSHISTORY.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSHISTORY.java
@@ -147,7 +147,7 @@ public class MSVSSHISTORY extends MSVSS {
}
/**
- * Format of dates in <code>fromDate</code and <code>toDate</code>.
+ * Format of dates in <code>fromDate</code> and <code>toDate</code>.
* Used when calculating dates with the numdays attribute.
* This string uses the formatting rules of <code>SimpleDateFormat</code>.
* Defaults to <code>DateFormat.SHORT</code>.
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSLABEL.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSLABEL.java b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSLABEL.java
index 4ba9d7b..6290f2e 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSLABEL.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSLABEL.java
@@ -98,7 +98,7 @@ public class MSVSSLABEL extends MSVSS {
}
/**
- * Autoresponce behaviour. Valid options are Y and N.
+ * Autoresponse behaviour. Valid options are Y and N.
*
* @param response The auto response value.
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/AbstractFileSet.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/AbstractFileSet.java b/src/main/org/apache/tools/ant/types/AbstractFileSet.java
index e3b8aa8..1639150 100644
--- a/src/main/org/apache/tools/ant/types/AbstractFileSet.java
+++ b/src/main/org/apache/tools/ant/types/AbstractFileSet.java
@@ -426,6 +426,7 @@ public abstract class AbstractFileSet extends DataType
* 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(int max) {
@@ -436,6 +437,7 @@ public abstract class AbstractFileSet extends DataType
* The maximum number of times a symbolic link may be followed
* during a scan.
*
+ * @return int
* @since Ant 1.8.0
*/
public int getMaxLevelsOfSymlinks() {
@@ -455,6 +457,8 @@ public abstract class AbstractFileSet extends DataType
/**
* Gets whether an error is/should be thrown if the base directory
* does not exist.
+ *
+ * @return boolean
* @since Ant 1.8.2
*/
public boolean getErrorOnMissingDir() {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/Assertions.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/Assertions.java b/src/main/org/apache/tools/ant/types/Assertions.java
index a54db50..ce7091a 100644
--- a/src/main/org/apache/tools/ant/types/Assertions.java
+++ b/src/main/org/apache/tools/ant/types/Assertions.java
@@ -98,7 +98,7 @@ public class Assertions extends DataType implements Cloneable {
/**
* enable or disable system assertions.
- * Default is not set (neither -enablesystemassersions or -disablesytemassertions
+ * Default is not set (neither -enablesystemassertions or -disablesytemassertions
* are used on the command line).
* @param enableSystemAssertions if true enable system assertions
*/
@@ -229,8 +229,8 @@ public class Assertions extends DataType implements Cloneable {
/**
* helper method to add a string JVM argument to a command
- * @param command
- * @param arg
+ * @param command ditto
+ * @param arg ditto
*/
private static void addVmArgument(CommandlineJava command, String arg) {
Commandline.Argument argument;
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/Commandline.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/Commandline.java b/src/main/org/apache/tools/ant/types/Commandline.java
index a417a0c..8b201cf 100644
--- a/src/main/org/apache/tools/ant/types/Commandline.java
+++ b/src/main/org/apache/tools/ant/types/Commandline.java
@@ -34,19 +34,19 @@ import org.apache.tools.ant.util.StringUtils;
/**
* Commandline objects help handling command lines specifying processes to
* execute.
- *
+ * <p>
* The class can be used to define a command line as nested elements or as a
* helper to define a command line by an application.
- * <p>
- * <code>
- * <someelement><br>
- * <acommandline executable="/executable/to/run"><br>
- * <argument value="argument 1" /><br>
- * <argument line="argument_1 argument_2 argument_3" /><br>
- * <argument value="argument 4" /><br>
- * </acommandline><br>
- * </someelement><br>
- * </code>
+ * </p>
+ * <pre>
+ * <someelement>
+ * <acommandline executable="/executable/to/run">
+ * <argument value="argument 1"/>
+ * <argument line="argument_1 argument_2 argument_3"/>
+ * <argument value="argument 4"/>
+ * </acommandline>
+ * </someelement>
+ * </pre>
* The element <code>someelement</code> must provide a method
* <code>createAcommandline</code> which returns an instance of this class.
*
@@ -251,6 +251,7 @@ public class Commandline implements Cloneable {
/**
* Get the prefix to be placed in front of the inserted argument.
*
+ * @return String
* @since Ant 1.8.0
*/
public String getPrefix() {
@@ -270,6 +271,7 @@ public class Commandline implements Cloneable {
/**
* Get the suffix to be placed at the end of the inserted argument.
*
+ * @return String
* @since Ant 1.8.0
*/
public String getSuffix() {
@@ -588,7 +590,7 @@ public class Commandline implements Cloneable {
/**
* Return a String that describes the command and arguments suitable for
- * verbose output before a call to <code>Runtime.exec(String[])<code>.
+ * verbose output before a call to <code>Runtime.exec(String[])</code>.
* @return a string that describes the command and arguments.
* @since Ant 1.5
*/
@@ -598,7 +600,7 @@ public class Commandline implements Cloneable {
/**
* Return a String that describes the arguments suitable for
- * verbose output before a call to <code>Runtime.exec(String[])<code>.
+ * verbose output before a call to <code>Runtime.exec(String[])</code>.
* @return a string that describes the arguments.
* @since Ant 1.5
*/
@@ -608,7 +610,7 @@ public class Commandline implements Cloneable {
/**
* Return a String that describes the command and arguments suitable for
- * verbose output before a call to <code>Runtime.exec(String[])<code>.
+ * verbose output before a call to <code>Runtime.exec(String[])</code>.
* @param line the Commandline to describe.
* @return a string that describes the command and arguments.
* @since Ant 1.5
@@ -619,7 +621,7 @@ public class Commandline implements Cloneable {
/**
* Return a String that describes the arguments suitable for
- * verbose output before a call to <code>Runtime.exec(String[])<code>.
+ * verbose output before a call to <code>Runtime.exec(String[])</code>.
* @param line the Commandline whose arguments to describe.
* @return a string that describes the arguments.
* @since Ant 1.5
@@ -630,7 +632,7 @@ public class Commandline implements Cloneable {
/**
* Return a String that describes the command and arguments suitable for
- * verbose output before a call to <code>Runtime.exec(String[])<code>.
+ * verbose output before a call to <code>Runtime.exec(String[])</code>.
*
* <p>This method assumes that the first entry in the array is the
* executable to run.</p>
@@ -656,7 +658,7 @@ public class Commandline implements Cloneable {
/**
* Return a String that describes the arguments suitable for
- * verbose output before a call to <code>Runtime.exec(String[])<code>.
+ * verbose output before a call to <code>Runtime.exec(String[])</code>.
* @param args the command line to describe as an array of strings.
* @return a string that describes the arguments.
* @since Ant 1.5
@@ -667,7 +669,7 @@ public class Commandline implements Cloneable {
/**
* Return a String that describes the arguments suitable for
- * verbose output before a call to <code>Runtime.exec(String[])<code>.
+ * verbose output before a call to <code>Runtime.exec(String[])</code>.
*
* @param args the command line to describe as an array of strings.
* @param offset ignore entries before this index.
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/CommandlineJava.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/CommandlineJava.java b/src/main/org/apache/tools/ant/types/CommandlineJava.java
index d811633..f588629 100644
--- a/src/main/org/apache/tools/ant/types/CommandlineJava.java
+++ b/src/main/org/apache/tools/ant/types/CommandlineJava.java
@@ -568,7 +568,7 @@ public class CommandlineJava implements Cloneable {
/**
* Return a String that describes the command and arguments suitable for
- * verbose output before a call to <code>Runtime.exec(String[])<code>.
+ * verbose output before a call to <code>Runtime.exec(String[])</code>.
* @return the description string.
* @since Ant 1.5
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/DataType.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/DataType.java b/src/main/org/apache/tools/ant/types/DataType.java
index fda4af6..c5ee1c9 100644
--- a/src/main/org/apache/tools/ant/types/DataType.java
+++ b/src/main/org/apache/tools/ant/types/DataType.java
@@ -128,7 +128,7 @@ public abstract class DataType extends ProjectComponent implements Cloneable {
* cannot hold other DataTypes as children.</p>
*
* <p>The general contract of this method is that it shouldn't do
- * anything if {@link #checked <code>checked</code>} is true and
+ * anything if {@link #checked} is true and
* set it to true on exit.</p>
* @param stack the stack of references to check.
* @param project the project to use to dereference the references.
@@ -217,6 +217,7 @@ public abstract class DataType extends ProjectComponent implements Cloneable {
/**
* Performs the check for circular references and returns the
* referenced object.
+ * @param <T> required reference type
* @param requiredClass the class that this reference should be a subclass of.
* @param dataTypeName the name of the datatype that the reference should be
* (error message use only).
@@ -231,6 +232,7 @@ public abstract class DataType extends ProjectComponent implements Cloneable {
/**
* Performs the check for circular references and returns the
* referenced object. This version allows the fallback Project instance to be specified.
+ * @param <T> required reference type
* @param requiredClass the class that this reference should be a subclass of.
* @param dataTypeName the name of the datatype that the reference should be
* (error message use only).
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/EnumeratedAttribute.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/EnumeratedAttribute.java b/src/main/org/apache/tools/ant/types/EnumeratedAttribute.java
index bc893d8..18603b2 100644
--- a/src/main/org/apache/tools/ant/types/EnumeratedAttribute.java
+++ b/src/main/org/apache/tools/ant/types/EnumeratedAttribute.java
@@ -71,7 +71,7 @@ public abstract class EnumeratedAttribute {
String value) throws BuildException {
if (!EnumeratedAttribute.class.isAssignableFrom(clazz)) {
throw new BuildException(
- "You have to provide a subclass from EnumeratedAttribut as clazz-parameter.");
+ "You have to provide a subclass from EnumeratedAttribute as clazz-parameter.");
}
EnumeratedAttribute ea = null;
try {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/FileList.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/FileList.java b/src/main/org/apache/tools/ant/types/FileList.java
index 42e2763..c36ba6c 100644
--- a/src/main/org/apache/tools/ant/types/FileList.java
+++ b/src/main/org/apache/tools/ant/types/FileList.java
@@ -100,7 +100,7 @@ public class FileList extends DataType implements ResourceCollection {
/**
* Set the filenames attribute.
*
- * @param filenames a string contains filenames, separated by , or
+ * @param filenames a string containing filenames, separated by comma or
* by whitespace.
*/
public void setFiles(String filenames) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/Path.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/Path.java b/src/main/org/apache/tools/ant/types/Path.java
index 16270e3..70358d8 100644
--- a/src/main/org/apache/tools/ant/types/Path.java
+++ b/src/main/org/apache/tools/ant/types/Path.java
@@ -39,28 +39,27 @@ import org.apache.tools.ant.util.JavaEnvUtils;
* This object represents a path as used by CLASSPATH or PATH
* environment variable. A path might also be described as a collection
* of unique filesystem resources.
- * <p>
- * <code>
- * <sometask><br>
- * <somepath><br>
- * <pathelement location="/path/to/file.jar" /><br>
- * <pathelement
- * path="/path/to/file2.jar:/path/to/class2;/path/to/class3" />
- * <br>
- * <pathelement location="/path/to/file3.jar" /><br>
- * <pathelement location="/path/to/file4.jar" /><br>
- * </somepath><br>
- * </sometask><br>
- * </code>
+ * <pre>
+ * <sometask>
+ * <somepath>
+ * <pathelement location="/path/to/file.jar"/>
+ * <pathelement path="/path/to/file2.jar:/path/to/class2;/path/to/class3"/>
+ * <pathelement location="/path/to/file3.jar"/>
+ * <pathelement location="/path/to/file4.jar"/>
+ * </somepath>
+ * </sometask>
+ * </pre>
* <p>
* The object implementation <code>sometask</code> must provide a method called
* <code>createSomepath</code> which returns an instance of <code>Path</code>.
* Nested path definitions are handled by the Path object and must be labeled
- * <code>pathelement</code>.<p>
- *
+ * <code>pathelement</code>.
+ * </p>
+ * <p>
* The path element takes a parameter <code>path</code> which will be parsed
* and split into single elements. It will usually be used
* to define a path from an environment variable.
+ * </p>
*/
public class Path extends DataType implements Cloneable, ResourceCollection {
@@ -356,6 +355,7 @@ public class Path extends DataType implements Cloneable, ResourceCollection {
/**
* Whether to cache the current path.
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setCache(boolean b) {
@@ -663,7 +663,7 @@ public class Path extends DataType implements Cloneable, ResourceCollection {
}
/**
- * Emulation of extdirs feature in java >= 1.2.
+ * Emulation of extdirs feature in Java >= 1.2.
* This method adds all files in the given
* directories (but not in sub-directories!) to the classpath,
* so that you don't have to specify them all one by one.
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/Quantifier.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/Quantifier.java b/src/main/org/apache/tools/ant/types/Quantifier.java
index ac1b84c..fae3dc5 100644
--- a/src/main/org/apache/tools/ant/types/Quantifier.java
+++ b/src/main/org/apache/tools/ant/types/Quantifier.java
@@ -22,17 +22,17 @@ import org.apache.tools.ant.BuildException;
/**
* EnumeratedAttribute for quantifier comparisons. Evaluates a
* <code>boolean[]</code> or raw <code>true</code> and <code>false</code>
- * counts. Accepts the following values:<ul>
- * <li>"all"</li> - none <code>false</code>
- * <li>"each"</li> - none <code>false</code>
- * <li>"every"</li> - none <code>false</code>
- * <li>"any"</li> - at least one <code>true</code>
- * <li>"some"</li> - at least one <code>true</code>
- * <li>"one"</li> - exactly one <code>true</code>
- * <li>"majority"</li> - more <code>true</code> than <code>false</code>
- * <li>"most"</li> - more <code>true</code> than <code>false</code>
- * <li>"none"</li> - none <code>true</code>
- * </ul>
+ * counts. Accepts the following values:<dl>
+ * <dt>"all"</dt><dd>none <code>false</code></dd>
+ * <dt>"each"</dt><dd>none <code>false</code></dd>
+ * <dt>"every"</dt><dd>none <code>false</code></dd>
+ * <dt>"any"</dt><dd>at least one <code>true</code></dd>
+ * <dt>"some"</dt><dd>at least one <code>true</code></dd>
+ * <dt>"one"</dt><dd>exactly one <code>true</code></dd>
+ * <dt>"majority"</dt><dd>more <code>true</code> than <code>false</code></dd>
+ * <dt>"most"</dt><dd>more <code>true</code> than <code>false</code></dd>
+ * <dt>"none"</dt><dd>none <code>true</code></dd>
+ * </dl>
* @since Ant 1.7
*/
public class Quantifier extends EnumeratedAttribute {
@@ -114,7 +114,7 @@ public class Quantifier extends EnumeratedAttribute {
}
/**
- * Evaluate a <code>boolean<code> array.
+ * Evaluate a <code>boolean</code> array.
* @param b the <code>boolean[]</code> to evaluate.
* @return true if the argument fell within the parameters of this Quantifier.
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/RedirectorElement.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/RedirectorElement.java b/src/main/org/apache/tools/ant/types/RedirectorElement.java
index d27b199..e72d394 100644
--- a/src/main/org/apache/tools/ant/types/RedirectorElement.java
+++ b/src/main/org/apache/tools/ant/types/RedirectorElement.java
@@ -435,6 +435,7 @@ public class RedirectorElement extends DataType {
* <p>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.</p>
+ * @param b boolean
* @since 1.9.4
*/
public void setBinaryOutput(boolean b) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/Resource.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/Resource.java b/src/main/org/apache/tools/ant/types/Resource.java
index 6cd0e07..5bf9814 100644
--- a/src/main/org/apache/tools/ant/types/Resource.java
+++ b/src/main/org/apache/tools/ant/types/Resource.java
@@ -28,10 +28,11 @@ import org.apache.tools.ant.types.resources.FileProvider;
/**
* Describes a "File-like" resource (File, ZipEntry, etc.).
- *
+ * <p>
* This class is meant to be used by classes needing to record path
* and date/time information about a file, a zip entry or some similar
* resource (URL, archive in a version control repository, ...).
+ * </p>
*
* @since Ant 1.5.2
* @see org.apache.tools.ant.types.resources.Touchable
@@ -434,6 +435,9 @@ public class Resource extends DataType implements Comparable<Resource>, Resource
* <p>This implementation of the method will return the current
* instance itself if it can be assigned to the given class.</p>
*
+ * @param <T> desired type
+ * @param clazz a class
+ * @return resource of a desired type
* @since Ant 1.8.0
*/
public <T> T as(Class<T> clazz) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/ResourceLocation.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/ResourceLocation.java b/src/main/org/apache/tools/ant/types/ResourceLocation.java
index c5a44ea..0879154 100644
--- a/src/main/org/apache/tools/ant/types/ResourceLocation.java
+++ b/src/main/org/apache/tools/ant/types/ResourceLocation.java
@@ -27,12 +27,11 @@ import java.net.URL;
* href="http://oasis-open.org/committees/entity/spec-2001-08-06.html">
* OASIS "Open Catalog" standard</a>.</p>
*
- * <p>Possible Future Enhancements:
+ * <p>Possible Future Enhancements:</p>
* <ul>
* <li>Bring the Ant element names into conformance with the OASIS standard</li>
* <li>Add support for additional OASIS catalog entry types</li>
* </ul>
- * </p>
*
* @see org.apache.xml.resolver.Catalog
* @since Ant 1.6
@@ -103,4 +102,4 @@ public class ResourceLocation {
return base;
}
-} //-- ResourceLocation
+}
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/Substitution.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/Substitution.java b/src/main/org/apache/tools/ant/types/Substitution.java
index 343f4c4..2b11da5 100644
--- a/src/main/org/apache/tools/ant/types/Substitution.java
+++ b/src/main/org/apache/tools/ant/types/Substitution.java
@@ -17,7 +17,6 @@
*/
package org.apache.tools.ant.types;
-
import org.apache.tools.ant.Project;
/***
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/XMLCatalog.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/XMLCatalog.java b/src/main/org/apache/tools/ant/types/XMLCatalog.java
index 2edd5a1..20bbe94 100644
--- a/src/main/org/apache/tools/ant/types/XMLCatalog.java
+++ b/src/main/org/apache/tools/ant/types/XMLCatalog.java
@@ -78,19 +78,18 @@ import org.xml.sax.XMLReader;
* <code>URI</code> respectively.</p>
*
* <p>The following is a usage example:</p>
- *
- * <code>
- * <xmlcatalog><br>
- * <dtd publicId="" location="/path/to/file.jar" /><br>
- * <dtd publicId="" location="/path/to/file2.jar" /><br>
- * <entity publicId="" location="/path/to/file3.jar" /><br>
- * <entity publicId="" location="/path/to/file4.jar" /><br>
- * <catalogpath><br>
- * <pathelement location="/etc/sgml/catalog"/><br>
- * </catalogpath><br>
- * <catalogfiles dir="/opt/catalogs/" includes="**\catalog.xml" /><br>
- * </xmlcatalog><br>
- * </code>
+ * <pre>
+ * <xmlcatalog>
+ * <dtd publicId="" location="/path/to/file.jar"/>
+ * <dtd publicId="" location="/path/to/file2.jar"/>
+ * <entity publicId="" location="/path/to/file3.jar"/>
+ * <entity publicId="" location="/path/to/file4.jar"/>
+ * <catalogpath>
+ * <pathelement location="/etc/sgml/catalog"/>
+ * </catalogpath>
+ * <catalogfiles dir="/opt/catalogs/" includes="**\catalog.xml"/>
+ * </xmlcatalog>
+ * </pre>
* <p>
* Tasks wishing to use <code><xmlcatalog></code> must provide a method called
* <code>createXMLCatalog</code> which returns an instance of
@@ -100,14 +99,13 @@ import org.xml.sax.XMLReader;
*
* <p>The following is a description of the resolution algorithm:
* entities/URIs/dtds are looked up in each of the following contexts,
- * stopping when a valid and readable resource is found:
+ * stopping when a valid and readable resource is found:</p>
* <ol>
* <li>In the local filesystem</li>
* <li>In the classpath</li>
* <li>Using the Apache xml-commons resolver (if it is available)</li>
* <li>In URL-space</li>
* </ol>
- * </p>
*
* <p>See {@link
* org.apache.tools.ant.taskdefs.optional.XMLValidateTask
@@ -484,7 +482,7 @@ public class XMLCatalog extends DataType
/**
* Factory method for creating the appropriate CatalogResolver
* strategy implementation.
- * <p> Until we query the classpath, we don't know whether the Apache
+ * <p>Until we query the classpath, we don't know whether the Apache
* resolver (Norm Walsh's library from xml-commons) is available or not.
* This method determines whether the library is available and creates the
* appropriate implementation of CatalogResolver based on the answer.</p>
@@ -1125,4 +1123,4 @@ public class XMLCatalog extends DataType
externalCatalogsProcessed = true;
}
}
-} //-- XMLCatalog
+}
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/mappers/CutDirsMapper.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/mappers/CutDirsMapper.java b/src/main/org/apache/tools/ant/types/mappers/CutDirsMapper.java
index b9e7cfb..ce8f39c 100644
--- a/src/main/org/apache/tools/ant/types/mappers/CutDirsMapper.java
+++ b/src/main/org/apache/tools/ant/types/mappers/CutDirsMapper.java
@@ -37,6 +37,7 @@ public class CutDirsMapper implements FileNameMapper {
/**
* The number of leading directories to cut.
+ * @param dirs int
*/
public void setDirs(final int dirs) {
this.dirs = dirs;
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/optional/AbstractScriptComponent.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/optional/AbstractScriptComponent.java b/src/main/org/apache/tools/ant/types/optional/AbstractScriptComponent.java
index df5a3ce..2028075 100644
--- a/src/main/org/apache/tools/ant/types/optional/AbstractScriptComponent.java
+++ b/src/main/org/apache/tools/ant/types/optional/AbstractScriptComponent.java
@@ -60,7 +60,7 @@ public abstract class AbstractScriptComponent extends ProjectComponent {
}
/**
- * Load the script from an external file ; optional.
+ * Load the script from an external file; optional.
*
* @param file the file containing the script source.
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/optional/ScriptFilter.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/optional/ScriptFilter.java b/src/main/org/apache/tools/ant/types/optional/ScriptFilter.java
index 3f6ec88..67d3cce 100644
--- a/src/main/org/apache/tools/ant/types/optional/ScriptFilter.java
+++ b/src/main/org/apache/tools/ant/types/optional/ScriptFilter.java
@@ -70,7 +70,7 @@ public class ScriptFilter extends TokenFilter.ChainableReaderFilter {
/**
* Initialize.
*
- * @exception BuildException if someting goes wrong
+ * @exception BuildException if something goes wrong
*/
private void init() throws BuildException {
if (runner != null) {
@@ -113,7 +113,7 @@ public class ScriptFilter extends TokenFilter.ChainableReaderFilter {
}
/**
- * Load the script from an external file ; optional.
+ * Load the script from an external file; optional.
*
* @param file the file containing the script source.
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/optional/ScriptMapper.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/optional/ScriptMapper.java b/src/main/org/apache/tools/ant/types/optional/ScriptMapper.java
index 38dab0b..36347a7 100644
--- a/src/main/org/apache/tools/ant/types/optional/ScriptMapper.java
+++ b/src/main/org/apache/tools/ant/types/optional/ScriptMapper.java
@@ -66,7 +66,7 @@ public class ScriptMapper extends AbstractScriptComponent implements FileNameMap
/**
* Returns an array containing the target filename(s) for the given source
* file.
- * <p/>
+ *
* <p>if the given rule doesn't apply to the source file, implementation
* must return null. SourceFileScanner will then omit the source file in
* question.</p>
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/optional/ScriptSelector.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/optional/ScriptSelector.java b/src/main/org/apache/tools/ant/types/optional/ScriptSelector.java
index ca28f69..c07ed13 100644
--- a/src/main/org/apache/tools/ant/types/optional/ScriptSelector.java
+++ b/src/main/org/apache/tools/ant/types/optional/ScriptSelector.java
@@ -86,7 +86,7 @@ public class ScriptSelector extends BaseSelector {
* Initialize on demand.
*
* @throws org.apache.tools.ant.BuildException
- * if someting goes wrong
+ * if something goes wrong
*/
private void init() throws BuildException {
if (runner != null) {
@@ -96,7 +96,7 @@ public class ScriptSelector extends BaseSelector {
}
/**
- * Load the script from an external file ; optional.
+ * Load the script from an external file; optional.
*
* @param file the file containing the script source.
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/optional/depend/DependScanner.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/optional/depend/DependScanner.java b/src/main/org/apache/tools/ant/types/optional/depend/DependScanner.java
index bb3cf54..27a1fdd 100644
--- a/src/main/org/apache/tools/ant/types/optional/depend/DependScanner.java
+++ b/src/main/org/apache/tools/ant/types/optional/depend/DependScanner.java
@@ -152,46 +152,47 @@ public class DependScanner extends DirectoryScanner {
/**
* @see DirectoryScanner#getExcludedDirectories
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public String[] getExcludedDirectories() {
return null;
}
/**
* @see DirectoryScanner#getExcludedFiles
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public String[] getExcludedFiles() {
return null;
}
/**
* @see DirectoryScanner#getIncludedDirectories
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public String[] getIncludedDirectories() {
return new String[0];
}
/**
* @see DirectoryScanner#getIncludedDirsCount
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public int getIncludedDirsCount() {
return 0;
}
/**
* @see DirectoryScanner#getNotIncludedDirectories
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public String[] getNotIncludedDirectories() {
return null;
}
/**
* @see DirectoryScanner#getNotIncludedFiles
+ * {@inheritDoc}.
*/
/** {@inheritDoc}. */
public String[] getNotIncludedFiles() {
@@ -200,6 +201,7 @@ public class DependScanner extends DirectoryScanner {
/**
* @see DirectoryScanner#setExcludes
+ * {@inheritDoc}.
*/
/** {@inheritDoc}. */
public void setExcludes(String[] excludes) {
@@ -207,6 +209,7 @@ public class DependScanner extends DirectoryScanner {
/**
* @see DirectoryScanner#setIncludes
+ * {@inheritDoc}.
*/
/** {@inheritDoc}. */
public void setIncludes(String[] includes) {
@@ -214,6 +217,7 @@ public class DependScanner extends DirectoryScanner {
/**
* @see DirectoryScanner#setCaseSensitive
+ * {@inheritDoc}.
*/
/** {@inheritDoc}. */
public void setCaseSensitive(boolean isCaseSensitive) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/optional/image/DrawOperation.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/optional/image/DrawOperation.java b/src/main/org/apache/tools/ant/types/optional/image/DrawOperation.java
index 4f6410c..e02d0c8 100644
--- a/src/main/org/apache/tools/ant/types/optional/image/DrawOperation.java
+++ b/src/main/org/apache/tools/ant/types/optional/image/DrawOperation.java
@@ -24,7 +24,7 @@ import javax.media.jai.PlanarImage;
* Interface which represents an Operation which is "drawable", such
* as a Rectangle, Circle or Text. The Operation is responsible for
* creating its own image buffer and drawing itself into it, then
- * wrapping and returning it as a PlanarImage. This allows multible
+ * wrapping and returning it as a PlanarImage. This allows multiple
* "drawable" objects to be nested.
*
* @see org.apache.tools.ant.taskdefs.optional.image.Image
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/optional/image/Ellipse.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/optional/image/Ellipse.java b/src/main/org/apache/tools/ant/types/optional/image/Ellipse.java
index 9924d90..9fa1802 100644
--- a/src/main/org/apache/tools/ant/types/optional/image/Ellipse.java
+++ b/src/main/org/apache/tools/ant/types/optional/image/Ellipse.java
@@ -36,7 +36,7 @@ public class Ellipse extends BasicShape implements DrawOperation {
/**
* Set the width.
- * @param width the width of the elipse.
+ * @param width the width of the ellipse.
*/
public void setWidth(int width) {
this.width = width;
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/optional/image/Rotate.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/optional/image/Rotate.java b/src/main/org/apache/tools/ant/types/optional/image/Rotate.java
index 3013bde..3d7a03a 100644
--- a/src/main/org/apache/tools/ant/types/optional/image/Rotate.java
+++ b/src/main/org/apache/tools/ant/types/optional/image/Rotate.java
@@ -75,19 +75,19 @@ public class Rotate extends TransformOperation implements DrawOperation {
if (instr instanceof DrawOperation) {
// If this TransformOperation has DrawOperation children
// then Rotate the first child and return.
- System.out.println("Execing Draws");
+ System.out.println("Exec'ing Draws");
PlanarImage op = ((DrawOperation) instr).executeDrawOperation();
image = performRotate(op);
return image;
} else if (instr instanceof TransformOperation) {
bi = image.getAsBufferedImage();
- System.out.println("Execing Transforms");
+ System.out.println("Exec'ing Transforms");
image = ((TransformOperation) instr)
.executeTransformOperation(PlanarImage.wrapRenderedImage(bi));
bi = image.getAsBufferedImage();
}
}
- System.out.println("Execing as TransformOperation");
+ System.out.println("Exec'ing as TransformOperation");
image = performRotate(image);
System.out.println(image);
return image;
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/resolver/ApacheCatalog.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/resolver/ApacheCatalog.java b/src/main/org/apache/tools/ant/types/resolver/ApacheCatalog.java
index cbf3f3f..66ed7ff 100644
--- a/src/main/org/apache/tools/ant/types/resolver/ApacheCatalog.java
+++ b/src/main/org/apache/tools/ant/types/resolver/ApacheCatalog.java
@@ -35,7 +35,7 @@ import org.apache.xml.resolver.helpers.PublicId;
* See XMLCatalog.java for the details of the entity and URI
* resolution algorithms.
*
- * @see org.apache.tools.ant.types.XMLCatalog.CatalogResolver
+ * @see org.apache.tools.ant.types.XMLCatalog
* @since Ant 1.6
*/
public class ApacheCatalog extends Catalog {
@@ -118,4 +118,4 @@ public class ApacheCatalog extends Catalog {
super.addEntry(entry);
}
-} //- ApacheCatalog
+}
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/resolver/ApacheCatalogResolver.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/resolver/ApacheCatalogResolver.java b/src/main/org/apache/tools/ant/types/resolver/ApacheCatalogResolver.java
index 2312d3d..f036247 100644
--- a/src/main/org/apache/tools/ant/types/resolver/ApacheCatalogResolver.java
+++ b/src/main/org/apache/tools/ant/types/resolver/ApacheCatalogResolver.java
@@ -53,7 +53,7 @@ import org.apache.xml.resolver.tools.CatalogResolver;
* in XMLCatalog's lookup algorithm. See XMLCatalog.java for more
* details.</p>
*
- * @see org.apache.tools.ant.types.XMLCatalog.CatalogResolver
+ * @see org.apache.tools.ant.types.XMLCatalog
* @see org.apache.xml.resolver.CatalogManager
* @since Ant 1.6
*/
@@ -171,4 +171,4 @@ public class ApacheCatalogResolver extends CatalogResolver {
xmlCatalog.addEntity(entity);
}
-} //-- ApacheCatalogResolver
+}
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/resources/AbstractClasspathResource.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/resources/AbstractClasspathResource.java b/src/main/org/apache/tools/ant/types/resources/AbstractClasspathResource.java
index 417da9a..5805c7c 100644
--- a/src/main/org/apache/tools/ant/types/resources/AbstractClasspathResource.java
+++ b/src/main/org/apache/tools/ant/types/resources/AbstractClasspathResource.java
@@ -30,11 +30,10 @@ import org.apache.tools.ant.types.Resource;
import org.apache.tools.ant.util.FileUtils;
/**
- *
* A Resource representation of anything that is accessed via a Java classloader.
* The core methods to set/resolve the classpath are provided.
- * @since Ant 1.8.0
*
+ * @since Ant 1.8.0
*/
public abstract class AbstractClasspathResource extends Resource {
@@ -107,10 +106,11 @@ public abstract class AbstractClasspathResource extends Resource {
* Use the reference to locate the loader. If the loader is not
* found, taskdef will use the specified classpath and register it
* with the specified name.
- *
+ * <p>
* This allow multiple taskdef/typedef to use the same class loader,
* so they can be used together. It eliminate the need to
* put them in the CLASSPATH.
+ * </p>
*
* @param r the reference to locate the loader.
*/
@@ -124,6 +124,7 @@ public abstract class AbstractClasspathResource extends Resource {
*
* <p>Only relevant if a classpath has been specified.</p>
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setParentFirst(boolean b) {
@@ -132,6 +133,7 @@ public abstract class AbstractClasspathResource extends Resource {
/**
* Overrides the super version.
+ *
* @param r the Reference to set.
*/
public void setRefid(Reference r) {
@@ -144,6 +146,7 @@ public abstract class AbstractClasspathResource extends Resource {
/**
* Learn whether this resource exists. This implementation opens the input stream
* as the test.
+ *
* @return true if this resource exists.
*/
public boolean isExists() {
@@ -164,6 +167,7 @@ public abstract class AbstractClasspathResource extends Resource {
/**
* Return an InputStream for reading the contents of this Resource.
+ *
* @return an InputStream object.
* @throws IOException if an error occurs.
*/
@@ -195,6 +199,8 @@ public abstract class AbstractClasspathResource extends Resource {
* combines the various ways that could specify a ClassLoader and
* potentially creates one that needs to be cleaned up when it is
* no longer needed so that classes can get garbage collected.
+ *
+ * @return ClassLoaderWithFlag
*/
protected ClassLoaderWithFlag getClassLoader() {
ClassLoader cl = null;
@@ -226,6 +232,7 @@ public abstract class AbstractClasspathResource extends Resource {
/**
* open the input stream from a specific classloader
+ *
* @param cl the classloader to use. Will be null if the system classloader is used
* @return an open input stream for the resource
* @throws IOException if an error occurs.
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/resources/ArchiveResource.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/resources/ArchiveResource.java b/src/main/org/apache/tools/ant/types/resources/ArchiveResource.java
index 09ce032..2d87aa6 100644
--- a/src/main/org/apache/tools/ant/types/resources/ArchiveResource.java
+++ b/src/main/org/apache/tools/ant/types/resources/ArchiveResource.java
@@ -235,7 +235,7 @@ public abstract class ArchiveResource extends Resource {
/**
* Format this Resource as a String.
- * @return String representatation of this Resource.
+ * @return String representation of this Resource.
*/
public String toString() {
return isReference() ? getCheckedRef().toString()
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/resources/Archives.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/resources/Archives.java b/src/main/org/apache/tools/ant/types/resources/Archives.java
index 4b0d51c..24bfd28 100644
--- a/src/main/org/apache/tools/ant/types/resources/Archives.java
+++ b/src/main/org/apache/tools/ant/types/resources/Archives.java
@@ -48,6 +48,8 @@ public class Archives extends DataType
/**
* Wrapper to identify nested resource collections as ZIP
* archives.
+ *
+ * @return Union
*/
public Union createZips() {
if (isReference()) {
@@ -60,6 +62,8 @@ public class Archives extends DataType
/**
* Wrapper to identify nested resource collections as ZIP
* archives.
+ *
+ * @return Union
*/
public Union createTars() {
if (isReference()) {
@@ -71,6 +75,8 @@ public class Archives extends DataType
/**
* Sums the sizes of nested archives.
+ *
+ * @return int
*/
public int size() {
if (isReference()) {
@@ -86,6 +92,8 @@ public class Archives extends DataType
/**
* Merges the nested collections.
+ *
+ * @return Iterator<Resource>
*/
public Iterator<Resource> iterator() {
if (isReference()) {
@@ -113,6 +121,7 @@ public class Archives extends DataType
/**
* Overrides the base version.
+ *
* @param r the Reference to set.
*/
@Override
@@ -127,6 +136,7 @@ public class Archives extends DataType
/**
* Implement clone. The nested resource collections are cloned as
* well.
+ *
* @return a cloned instance.
*/
@Override
@@ -146,6 +156,8 @@ public class Archives extends DataType
/**
* Turns all nested resources into corresponding ArchiveFileSets
* and returns an iterator over the collected archives.
+ *
+ * @return Iterator<ArchiveFileSet>
*/
protected Iterator<ArchiveFileSet> grabArchives() {
final List<ArchiveFileSet> l = new LinkedList<ArchiveFileSet>();
@@ -161,6 +173,10 @@ public class Archives extends DataType
/**
* Configures the archivefileset based on this type's settings,
* set the source.
+ *
+ * @param afs ArchiveFileSet
+ * @param src Resource
+ * @return ArchiveFileSet
*/
protected ArchiveFileSet configureArchive(final ArchiveFileSet afs,
final Resource src) {
@@ -172,6 +188,7 @@ public class Archives extends DataType
/**
* Overrides the version of DataType to recurse on all DataType
* child elements that may have been added.
+ *
* @param stk the stack of data types to use (recursively).
* @param p the project to use to dereference the references.
* @throws BuildException on error.
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/resources/BaseResourceCollectionContainer.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/resources/BaseResourceCollectionContainer.java b/src/main/org/apache/tools/ant/types/resources/BaseResourceCollectionContainer.java
index 281fa0f..c794aed 100644
--- a/src/main/org/apache/tools/ant/types/resources/BaseResourceCollectionContainer.java
+++ b/src/main/org/apache/tools/ant/types/resources/BaseResourceCollectionContainer.java
@@ -50,6 +50,7 @@ public abstract class BaseResourceCollectionContainer
/**
* Create a new BaseResourceCollectionContainer.
+ * @param project Project
* @since Ant 1.8
*/
public BaseResourceCollectionContainer(Project project) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/resources/ContentTransformingResource.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/resources/ContentTransformingResource.java b/src/main/org/apache/tools/ant/types/resources/ContentTransformingResource.java
index 79445bf..19e86b3 100644
--- a/src/main/org/apache/tools/ant/types/resources/ContentTransformingResource.java
+++ b/src/main/org/apache/tools/ant/types/resources/ContentTransformingResource.java
@@ -149,6 +149,8 @@ public abstract class ContentTransformingResource extends ResourceDecorator {
* are appended to, for example.</p>
*
* <p>This implementations returns false.</p>
+ *
+ * @return boolean false
*/
protected boolean isAppendSupported() {
return false;
@@ -158,7 +160,7 @@ public abstract class ContentTransformingResource extends ResourceDecorator {
* Get a content-filtering/transforming InputStream.
*
* @param in InputStream to wrap, will never be null.
- * @return a compressed inputstream.
+ * @return a compressed InputStream.
* @throws IOException if there is a problem.
*/
protected abstract InputStream wrapStream(InputStream in)
@@ -168,7 +170,7 @@ public abstract class ContentTransformingResource extends ResourceDecorator {
* Get a content-filtering/transforming OutputStream.
*
* @param out OutputStream to wrap, will never be null.
- * @return a compressed outputstream.
+ * @return a compressed OutputStream.
* @throws IOException if there is a problem.
*/
protected abstract OutputStream wrapStream(OutputStream out)
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/resources/LazyResourceCollectionWrapper.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/resources/LazyResourceCollectionWrapper.java b/src/main/org/apache/tools/ant/types/resources/LazyResourceCollectionWrapper.java
index 4f9acd3..bdcc95d 100644
--- a/src/main/org/apache/tools/ant/types/resources/LazyResourceCollectionWrapper.java
+++ b/src/main/org/apache/tools/ant/types/resources/LazyResourceCollectionWrapper.java
@@ -67,7 +67,7 @@ public class LazyResourceCollectionWrapper extends
/**
* Specify if the resource should be filtered or not. This function should
- * be overrided in order to define the filtering algorithm
+ * be overriden in order to define the filtering algorithm
*
* @param r resource considered for filtration
* @return whether the resource should be filtered or not
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/resources/LogOutputResource.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/resources/LogOutputResource.java b/src/main/org/apache/tools/ant/types/resources/LogOutputResource.java
index cd19c9c..9b48658 100644
--- a/src/main/org/apache/tools/ant/types/resources/LogOutputResource.java
+++ b/src/main/org/apache/tools/ant/types/resources/LogOutputResource.java
@@ -35,7 +35,7 @@ public class LogOutputResource extends Resource implements Appendable {
/**
* Create a new LogOutputResource.
- * @param managingComponent
+ * @param managingComponent ditto
*/
public LogOutputResource(ProjectComponent managingComponent) {
super(NAME);
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/resources/MappedResourceCollection.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/resources/MappedResourceCollection.java b/src/main/org/apache/tools/ant/types/resources/MappedResourceCollection.java
index 2f1a926..9df69cf 100644
--- a/src/main/org/apache/tools/ant/types/resources/MappedResourceCollection.java
+++ b/src/main/org/apache/tools/ant/types/resources/MappedResourceCollection.java
@@ -112,6 +112,7 @@ public class MappedResourceCollection
/**
* Set whether to cache collections.
+ * @param cache boolean
* @since Ant 1.8.1
*/
public void setCache(boolean cache) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/resources/ResourceDecorator.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/resources/ResourceDecorator.java b/src/main/org/apache/tools/ant/types/resources/ResourceDecorator.java
index 9eb8c1d..2d87fb1 100644
--- a/src/main/org/apache/tools/ant/types/resources/ResourceDecorator.java
+++ b/src/main/org/apache/tools/ant/types/resources/ResourceDecorator.java
@@ -201,6 +201,7 @@ public abstract class ResourceDecorator extends Resource {
/**
* De-references refids if any, ensures a wrapped resource has
* been specified.
+ * @return Resource
*/
protected final Resource getResource() {
if (isReference()) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/resources/ResourceList.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/resources/ResourceList.java b/src/main/org/apache/tools/ant/types/resources/ResourceList.java
index da83ea9..b24277d 100644
--- a/src/main/org/apache/tools/ant/types/resources/ResourceList.java
+++ b/src/main/org/apache/tools/ant/types/resources/ResourceList.java
@@ -56,6 +56,8 @@ public class ResourceList extends DataType implements ResourceCollection {
/**
* Adds a source.
+ *
+ * @param rc ResourceCollection
*/
public void add(ResourceCollection rc) {
if (isReference()) {
@@ -67,6 +69,8 @@ public class ResourceList extends DataType implements ResourceCollection {
/**
* Adds a FilterChain.
+ *
+ * @param filter FilterChain
*/
public final void addFilterChain(FilterChain filter) {
if (isReference()) {
@@ -78,12 +82,15 @@ public class ResourceList extends DataType implements ResourceCollection {
/**
* Encoding to use for input, defaults to the platform's default
- * encoding. <p>
+ * encoding.
*
+ * <p>
* For a list of possible values see
* <a href="http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html">
- * http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html
- * </a>.</p>
+ * http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html</a>.
+ * </p>
+ *
+ * @param encoding String
*/
public final void setEncoding(String encoding) {
if (isReference()) {
@@ -95,6 +102,8 @@ public class ResourceList extends DataType implements ResourceCollection {
/**
* Makes this instance in effect a reference to another ResourceList
* instance.
+ *
+ * @param r Reference
*/
public void setRefid(Reference r) throws BuildException {
if (encoding != null) {
@@ -110,6 +119,7 @@ public class ResourceList extends DataType implements ResourceCollection {
* Fulfill the ResourceCollection contract. The Iterator returned
* will throw ConcurrentModificationExceptions if ResourceCollections
* are added to this container while the Iterator is in use.
+ *
* @return a "fail-fast" Iterator.
*/
public final synchronized Iterator<Resource> iterator() {
@@ -121,6 +131,7 @@ public class ResourceList extends DataType implements ResourceCollection {
/**
* Fulfill the ResourceCollection contract.
+ *
* @return number of elements as int.
*/
public synchronized int size() {
@@ -132,6 +143,7 @@ public class ResourceList extends DataType implements ResourceCollection {
/**
* Fulfill the ResourceCollection contract.
+ *
* @return whether this is a filesystem-only resource collection.
*/
public synchronized boolean isFilesystemOnly() {
@@ -144,6 +156,7 @@ public class ResourceList extends DataType implements ResourceCollection {
/**
* Overrides the version of DataType to recurse on all DataType
* child elements that may have been added.
+ *
* @param stk the stack of data types to use (recursively).
* @param p the project to use to dereference the references.
* @throws BuildException on error.
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/resources/Resources.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/resources/Resources.java b/src/main/org/apache/tools/ant/types/resources/Resources.java
index 1dd888d..1e029b2 100644
--- a/src/main/org/apache/tools/ant/types/resources/Resources.java
+++ b/src/main/org/apache/tools/ant/types/resources/Resources.java
@@ -124,6 +124,7 @@ public class Resources extends DataType implements ResourceCollection {
/**
* Create a new Resources.
+ * @param project Project
* @since Ant 1.8
*/
public Resources(Project project) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/resources/SizeLimitCollection.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/resources/SizeLimitCollection.java b/src/main/org/apache/tools/ant/types/resources/SizeLimitCollection.java
index c8e772b..2992d5b 100644
--- a/src/main/org/apache/tools/ant/types/resources/SizeLimitCollection.java
+++ b/src/main/org/apache/tools/ant/types/resources/SizeLimitCollection.java
@@ -31,7 +31,7 @@ public abstract class SizeLimitCollection extends BaseResourceCollectionWrapper
/**
* Set the number of resources to be included.
- * @param i the count as <code>int</count>.
+ * @param i the count as <code>int</code>.
*/
public synchronized void setCount(int i) {
checkAttributesAllowed();
@@ -40,7 +40,7 @@ public abstract class SizeLimitCollection extends BaseResourceCollectionWrapper
/**
* Get the number of resources to be included. Default is 1.
- * @return the count as <code>int</count>.
+ * @return the count as <code>int</code>.
*/
public synchronized int getCount() {
return count;
@@ -57,7 +57,7 @@ public abstract class SizeLimitCollection extends BaseResourceCollectionWrapper
}
/**
- * Get the count, verifying it is >= 0.
+ * Get the count, verifying it is >= 0.
* @return int count
*/
protected int getValidCount() {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/resources/URLResource.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/resources/URLResource.java b/src/main/org/apache/tools/ant/types/resources/URLResource.java
index 027a9bd..643ec00 100644
--- a/src/main/org/apache/tools/ant/types/resources/URLResource.java
+++ b/src/main/org/apache/tools/ant/types/resources/URLResource.java
@@ -110,6 +110,7 @@ public class URLResource extends Resource implements URLProvider {
/**
* Base URL which combined with the relativePath attribute defines
* the URL.
+ * @param base URL
* @since Ant 1.8.0
*/
public synchronized void setBaseURL(URL base) {
@@ -123,6 +124,7 @@ public class URLResource extends Resource implements URLProvider {
/**
* Relative path which combined with the baseURL attribute defines
* the URL.
+ * @param r String
* @since Ant 1.8.0
*/
public synchronized void setRelativePath(String r) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/resources/Union.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/resources/Union.java b/src/main/org/apache/tools/ant/types/resources/Union.java
index e2f2f9f..5b07395 100644
--- a/src/main/org/apache/tools/ant/types/resources/Union.java
+++ b/src/main/org/apache/tools/ant/types/resources/Union.java
@@ -110,6 +110,7 @@ public class Union extends BaseResourceCollectionContainer {
/**
* Unify the contained Resources.
+ * @param <T> resource type
* @param asString indicates whether the resulting Collection
* should contain Strings instead of Resources.
* @return a Collection of Resources.
@@ -122,7 +123,7 @@ public class Union extends BaseResourceCollectionContainer {
/**
* Get a collection of strings representing the unified resource set (strings may duplicate).
- * @return Collection<String>
+ * @return Collection<String>
*/
protected Collection<String> getAllToStrings() {
final Set<Resource> allResources = getAllResources();
@@ -135,7 +136,7 @@ public class Union extends BaseResourceCollectionContainer {
/**
* Get the unified set of contained Resources.
- * @return Set<Resource>
+ * @return Set<Resource>
*/
protected Set<Resource> getAllResources() {
final List<ResourceCollection> resourceCollections = getResourceCollections();
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/resources/ZipResource.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/resources/ZipResource.java b/src/main/org/apache/tools/ant/types/resources/ZipResource.java
index 37fc98e..1dec546 100644
--- a/src/main/org/apache/tools/ant/types/resources/ZipResource.java
+++ b/src/main/org/apache/tools/ant/types/resources/ZipResource.java
@@ -186,6 +186,7 @@ public class ZipResource extends ArchiveResource {
/**
* The compression method that has been used.
+ * @return int
* @since Ant 1.8.0
*/
public int getMethod() {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/resources/comparators/Content.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/resources/comparators/Content.java b/src/main/org/apache/tools/ant/types/resources/comparators/Content.java
index 1810b64..07dd315 100644
--- a/src/main/org/apache/tools/ant/types/resources/comparators/Content.java
+++ b/src/main/org/apache/tools/ant/types/resources/comparators/Content.java
@@ -57,7 +57,7 @@ public class Content extends ResourceComparator {
* @return a negative integer, zero, or a positive integer as the first
* argument is less than, equal to, or greater than the second.
* @throws BuildException if I/O errors occur.
- * @see org.apache.tools.ant.util.ResourceUtils#compareContent(Resource, Resource, boolean).
+ * @see org.apache.tools.ant.util.ResourceUtils#compareContent(Resource, Resource, boolean)
*/
protected int resourceCompare(Resource foo, Resource bar) {
try {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/resources/selectors/Name.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/resources/selectors/Name.java b/src/main/org/apache/tools/ant/types/resources/selectors/Name.java
index 50c242a..baf9a3c 100644
--- a/src/main/org/apache/tools/ant/types/resources/selectors/Name.java
+++ b/src/main/org/apache/tools/ant/types/resources/selectors/Name.java
@@ -108,7 +108,7 @@ public class Name implements ResourceSelector {
/**
* Whether the difference between / and \ (the two common
* directory characters) is ignored.
- *
+ * @return boolean
* @since Ant 1.8.0
*/
public boolean doesHandledirSep() {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/resources/selectors/ResourceSelectorContainer.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/resources/selectors/ResourceSelectorContainer.java b/src/main/org/apache/tools/ant/types/resources/selectors/ResourceSelectorContainer.java
index 6b1c800..19e0140 100644
--- a/src/main/org/apache/tools/ant/types/resources/selectors/ResourceSelectorContainer.java
+++ b/src/main/org/apache/tools/ant/types/resources/selectors/ResourceSelectorContainer.java
@@ -43,11 +43,11 @@ public class ResourceSelectorContainer extends DataType {
/**
* Construct a new ResourceSelectorContainer with the specified array of selectors.
- * @param r the ResourceSelector[] to add.
+ * @param rs the ResourceSelector[] to add.
*/
- public ResourceSelectorContainer(ResourceSelector[] r) {
- for (int i = 0; i < r.length; i++) {
- add(r[i]);
+ public ResourceSelectorContainer(ResourceSelector[] rs) {
+ for (int i = 0; i < rs.length; i++) {
+ add(rs[i]);
}
}
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/selectors/BaseSelector.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/selectors/BaseSelector.java b/src/main/org/apache/tools/ant/types/selectors/BaseSelector.java
index 414390e..28e0556 100644
--- a/src/main/org/apache/tools/ant/types/selectors/BaseSelector.java
+++ b/src/main/org/apache/tools/ant/types/selectors/BaseSelector.java
@@ -59,6 +59,7 @@ public abstract class BaseSelector extends DataType implements FileSelector {
* the first error message is recorded.
*
* @param msg The error message any BuildException should throw.
+ * @param cause Throwable
*/
public void setError(String msg, Throwable cause) {
if (errmsg == null) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/selectors/DateSelector.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/selectors/DateSelector.java b/src/main/org/apache/tools/ant/types/selectors/DateSelector.java
index 8232e45..c5ff5d5 100644
--- a/src/main/org/apache/tools/ant/types/selectors/DateSelector.java
+++ b/src/main/org/apache/tools/ant/types/selectors/DateSelector.java
@@ -248,7 +248,6 @@ public class DateSelector extends BaseExtendSelector {
/**
* Enumerated attribute with the values for time comparison.
- * <p>
*/
public static class TimeComparisons extends TimeComparison {
}
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/selectors/DifferentSelector.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/selectors/DifferentSelector.java b/src/main/org/apache/tools/ant/types/selectors/DifferentSelector.java
index c701fb8..9c076fa 100644
--- a/src/main/org/apache/tools/ant/types/selectors/DifferentSelector.java
+++ b/src/main/org/apache/tools/ant/types/selectors/DifferentSelector.java
@@ -40,12 +40,13 @@ import org.apache.tools.ant.util.FileUtils;
* output files, followup tasks can be driven off copies made with a different
* selector, so their dependencies are driven on the absolute state of the
* files, not a timestamp.
+ * </p>
* <p>
* Clearly, however, bulk file comparisons is inefficient; anything that can
* use timestamps is to be preferred. If this selector must be used, use it
- * over as few files as possible, perhaps following it with an <uptodate;>
+ * over as few files as possible, perhaps following it with an <uptodate>
* to keep the descendant routines conditional.
- *
+ * </p>
*/
public class DifferentSelector extends MappingSelector {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/selectors/PresentSelector.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/selectors/PresentSelector.java b/src/main/org/apache/tools/ant/types/selectors/PresentSelector.java
index 1c0c000..725b31e 100644
--- a/src/main/org/apache/tools/ant/types/selectors/PresentSelector.java
+++ b/src/main/org/apache/tools/ant/types/selectors/PresentSelector.java
@@ -119,7 +119,7 @@ public class PresentSelector extends BaseSelector {
* that already exist in the source directory, hence the lack of
* a <code>destonly</code> option.
*
- * @param fp An attribute set to either <code>srconly</code or
+ * @param fp An attribute set to either <code>srconly</code> or
* <code>both</code>.
*/
public void setPresent(final FilePresence fp) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/selectors/SizeSelector.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/selectors/SizeSelector.java b/src/main/org/apache/tools/ant/types/selectors/SizeSelector.java
index 9ff91ad..3157ee5 100644
--- a/src/main/org/apache/tools/ant/types/selectors/SizeSelector.java
+++ b/src/main/org/apache/tools/ant/types/selectors/SizeSelector.java
@@ -70,8 +70,8 @@ public class SizeSelector extends BaseExtendSelector {
/**
* Returns a <code>String</code> object representing the specified
- * SizeSelector. This is "{sizeselector value: " + <"compare",
- * "less", "more", "equal"> + "}".
+ * SizeSelector. This is "{sizeselector value: " + <"compare",
+ * "less", "more", "equal"> + "}".
* @return a string describing this object
*/
public String toString() {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/selectors/TokenizedPath.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/selectors/TokenizedPath.java b/src/main/org/apache/tools/ant/types/selectors/TokenizedPath.java
index a712759..cc87786 100644
--- a/src/main/org/apache/tools/ant/types/selectors/TokenizedPath.java
+++ b/src/main/org/apache/tools/ant/types/selectors/TokenizedPath.java
@@ -93,12 +93,14 @@ public class TokenizedPath {
/**
* The depth (or length) of a path.
+ * @return int
*/
public int depth() {
return tokenizedPath.length;
}
- /* package */ String[] getTokens() {
+ /* package */
+ String[] getTokens() {
return tokenizedPath;
}
@@ -135,6 +137,7 @@ public class TokenizedPath {
* Do we have to traverse a symlink when trying to reach path from
* basedir?
* @param base base File (dir).
+ * @return boolean
*/
public boolean isSymlink(File base) {
for (int i = 0; i < tokenizedPath.length; i++) {
@@ -160,6 +163,7 @@ public class TokenizedPath {
/**
* true if the original paths are equal.
+ * @return boolean
*/
@Override
public boolean equals(Object o) {
@@ -214,6 +218,8 @@ public class TokenizedPath {
/**
* Creates a TokenizedPattern from the same tokens that make up
* this path.
+ *
+ * @return TokenizedPattern
*/
public TokenizedPattern toPattern() {
return new TokenizedPattern(path, tokenizedPath);
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/selectors/TokenizedPattern.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/selectors/TokenizedPattern.java b/src/main/org/apache/tools/ant/types/selectors/TokenizedPattern.java
index dbe7ec8..2f1be2f 100644
--- a/src/main/org/apache/tools/ant/types/selectors/TokenizedPattern.java
+++ b/src/main/org/apache/tools/ant/types/selectors/TokenizedPattern.java
@@ -73,6 +73,10 @@ public class TokenizedPattern {
/**
* Tests whether or not this pattern matches the start of
* a path.
+ *
+ * @param path TokenizedPath
+ * @param caseSensitive boolean
+ * @return boolean
*/
public boolean matchStartOf(TokenizedPath path,
boolean caseSensitive) {
@@ -93,6 +97,8 @@ public class TokenizedPattern {
/**
* true if the original patterns are equal.
+ *
+ * @param o Object
*/
public boolean equals(Object o) {
return o instanceof TokenizedPattern
@@ -105,6 +111,8 @@ public class TokenizedPattern {
/**
* The depth (or length) of a pattern.
+ *
+ * @return int
*/
public int depth() {
return tokenizedPattern.length;
@@ -112,6 +120,9 @@ public class TokenizedPattern {
/**
* Does the tokenized pattern contain the given string?
+ *
+ * @param pat String
+ * @return boolean
*/
public boolean containsPattern(String pat) {
for (int i = 0; i < tokenizedPattern.length; i++) {
@@ -125,6 +136,7 @@ public class TokenizedPattern {
/**
* Returns a new TokenizedPath where all tokens of this pattern to
* the right containing wildcards have been removed
+ *
* @return the leftmost part of the pattern without wildcards
*/
public TokenizedPath rtrimWildcardTokens() {
@@ -150,6 +162,9 @@ public class TokenizedPattern {
/**
* true if the last token equals the given string.
+ *
+ * @param s String
+ * @return boolean
*/
public boolean endsWith(String s) {
return tokenizedPattern.length > 0
@@ -158,6 +173,8 @@ public class TokenizedPattern {
/**
* Returns a new pattern without the last token of this pattern.
+ *
+ * @return TokenizedPattern
*/
public TokenizedPattern withoutLastToken() {
if (tokenizedPattern.length == 0) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/types/selectors/modifiedselector/ChecksumAlgorithm.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/types/selectors/modifiedselector/ChecksumAlgorithm.java b/src/main/org/apache/tools/ant/types/selectors/modifiedselector/ChecksumAlgorithm.java
index 210d5dc..d497f14 100644
--- a/src/main/org/apache/tools/ant/types/selectors/modifiedselector/ChecksumAlgorithm.java
+++ b/src/main/org/apache/tools/ant/types/selectors/modifiedselector/ChecksumAlgorithm.java
@@ -34,17 +34,18 @@ import org.apache.tools.ant.BuildException;
/**
* Computes a 'checksum' for the content of file using
* java.util.zip.CRC32 and java.util.zip.Adler32.
- * Use of this algorithm doesn't require any additional nested <param>s.
- * Supported <param>s are:
+ * Use of this algorithm doesn't require any additional nested <param>s.
+ * Supported <param>s are:
* <table>
+ * <caption>Checksum algorithm parameters</caption>
* <tr>
* <th>name</th><th>values</th><th>description</th><th>required</th>
* </tr>
* <tr>
- * <td> algorithm.algorithm </td>
- * <td> ADLER | CRC ( default ) </td>
- * <td> name of the algorithm the checksum should use </td>
- * <td> no, defaults to CRC </td>
+ * <td>algorithm.algorithm</td>
+ * <td>ADLER | CRC (default)</td>
+ * <td>name of the algorithm the checksum should use</td>
+ * <td>no, defaults to CRC</td>
* </tr>
* </table>
*