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:52 UTC
[07/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/AbstractCvsTask.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/AbstractCvsTask.java b/src/main/org/apache/tools/ant/taskdefs/AbstractCvsTask.java
index 1ce8116..09b9b4a 100644
--- a/src/main/org/apache/tools/ant/taskdefs/AbstractCvsTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/AbstractCvsTask.java
@@ -38,17 +38,18 @@ import org.apache.tools.ant.util.StringUtils;
/**
* original Cvs.java 1.20
- *
- * NOTE: This implementation has been moved here from Cvs.java with
- * the addition of some accessors for extensibility. Another task
- * can extend this with some customized output processing.
+ * <p>
+ * 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.
+ * </p>
*
* @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) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/AbstractJarSignerTask.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/AbstractJarSignerTask.java b/src/main/org/apache/tools/ant/taskdefs/AbstractJarSignerTask.java
index c93173b..b2fe8d4 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;
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Ant.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Ant.java b/src/main/org/apache/tools/ant/taskdefs/Ant.java
index 793d16c..dbf8a22 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.
* <p>
- * 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 <code>Hashtable</code> 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
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/AttributeNamespaceDef.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/AttributeNamespaceDef.java b/src/main/org/apache/tools/ant/taskdefs/AttributeNamespaceDef.java
index 150b728..c374d6f 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() {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Available.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Available.java b/src/main/org/apache/tools/ant/taskdefs/Available.java
index f4919a1..d8eb82f 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;
}
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/BuildNumber.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/BuildNumber.java b/src/main/org/apache/tools/ant/taskdefs/BuildNumber.java
index aee071d..7a66125 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 {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Concat.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Concat.java b/src/main/org/apache/tools/ant/taskdefs/Concat.java
index 1af0143..93560ce 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 {
*
* <p>Defaults to false</p>
*
+ * @param f boolean
* @since Ant 1.8.2
*/
public void setForceReadOnly(boolean f) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Copy.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Copy.java b/src/main/org/apache/tools/ant/taskdefs/Copy.java
index 2394b8f..31901a6 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 {
*
* <p>Defaults to false</p>
*
+ * @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;
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Delete.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Delete.java b/src/main/org/apache/tools/ant/taskdefs/Delete.java
index 6c34ccf..3329318 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.</p>
*
+ * @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 {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/DependSet.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/DependSet.java b/src/main/org/apache/tools/ant/taskdefs/DependSet.java
index dc42beb..549e0ff 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 {
*
* <p>All deleted files will be logged as well.</p>
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setVerbose(boolean b) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Echo.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Echo.java b/src/main/org/apache/tools/ant/taskdefs/Echo.java
index ac31ee3..f1e13c8 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 {
*
* <p>Defaults to false</p>
*
+ * @param f boolean
* @since Ant 1.8.2
*/
public void setForce(boolean f) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/EchoXML.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/EchoXML.java b/src/main/org/apache/tools/ant/taskdefs/EchoXML.java
index 4a4fda2..40939e4 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;
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/ExecTask.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/ExecTask.java b/src/main/org/apache/tools/ant/taskdefs/ExecTask.java
index dd93978..b9eb963 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() {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Execute.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Execute.java b/src/main/org/apache/tools/ant/taskdefs/Execute.java
index 956309a..d9923e8 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));
}
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Expand.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Expand.java b/src/main/org/apache/tools/ant/taskdefs/Expand.java
index 0ec2333..a586556 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() {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/FixCRLF.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/FixCRLF.java b/src/main/org/apache/tools/ant/taskdefs/FixCRLF.java
index 465bf46..236b125 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"};
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Get.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Get.java b/src/main/org/apache/tools/ant/taskdefs/Get.java
index 83f3b6b..26a20e4 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.</p>
*
* @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 {
* <p>Defaults to true (allow caching, which is also the
* HttpUrlConnection default value.</p>
*
+ * @param httpUseCache boolean
* @since Ant 1.8.0
*/
public void setHttpUseCaches(final boolean httpUseCache) {
@@ -476,6 +478,7 @@ public class Get extends Task {
* <p>Setting this to true also means Ant will uncompress
* <code>.tar.gz</code> and similar files automatically.</p>
*
+ * @param b boolean
* @since Ant 1.9.5
*/
public void setTryGzipEncoding(boolean b) {
@@ -864,7 +867,7 @@ public class Get extends Task {
/**
* Has the download completed successfully?
*
- * <p>Re-throws any exception caught during executaion.</p>
+ * <p>Re-throws any exception caught during execution.</p>
*/
boolean wasSuccessful() throws IOException, BuildException {
if (ioexception != null) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/ImportTask.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/ImportTask.java b/src/main/org/apache/tools/ant/taskdefs/ImportTask.java
index 63adf71..0ddd597 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.</p>
*
+ * @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,
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/JDBCTask.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/JDBCTask.java b/src/main/org/apache/tools/ant/taskdefs/JDBCTask.java
index 2ca6e22..0954e70 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) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Jar.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Jar.java b/src/main/org/apache/tools/ant/taskdefs/Jar.java
index 330b5dd..791fd0d 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 <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/versioning/spec/versioning2.html#wp89936"></a>
*/
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(List<String> dirs, List<String> files,
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Javac.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Javac.java b/src/main/org/apache/tools/ant/taskdefs/Javac.java
index 18e4941..7ccc5a1 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Javac.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Javac.java
@@ -1076,6 +1076,7 @@ public class Javac extends MatchingTask {
* The classpath to use when loading the compiler implementation
* if it is not a built-in one.
*
+ * @return Path
* @since Ant 1.8.0
*/
public Path createCompilerClasspath() {
@@ -1084,6 +1085,8 @@ public class Javac extends MatchingTask {
/**
* Set the compiler adapter explicitly.
+ *
+ * @param adapter CompilerAdapter
* @since Ant 1.8.0
*/
public void add(final CompilerAdapter adapter) {
@@ -1099,6 +1102,7 @@ public class Javac extends MatchingTask {
* matching package-info.java files that have been compiled but
* didn't create class files themselves.
*
+ * @param b boolean
* @since Ant 1.8.3
*/
public void setCreateMissingPackageInfoClass(final boolean b) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Javadoc.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Javadoc.java b/src/main/org/apache/tools/ant/taskdefs/Javadoc.java
index ebdce49..d5e77fd 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Javadoc.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Javadoc.java
@@ -64,9 +64,9 @@ import org.apache.tools.ant.util.StringUtils;
* Generates Javadoc documentation for a collection
* of source code.
*
- * <p>Current known limitations are:
+ * <p>Current known limitations are:</p>
*
- * <p><ul>
+ * <ul>
* <li>patterns must be of the form "xxx.*", every other pattern doesn't
* work.
* <li>there is no control on arguments sanity since they are left
@@ -74,10 +74,10 @@ import org.apache.tools.ant.util.StringUtils;
* </ul>
*
* <p>If no <code>doclet</code> is set, then the <code>version</code> and
- * <code>author</code> are by default <code>"yes"</code>.
+ * <code>author</code> are by default <code>"yes"</code>.</p>
*
* <p>Note: This task is run on another VM because the Javadoc code calls
- * <code>System.exit()</code> which would break Ant functionality.
+ * <code>System.exit()</code> which would break Ant functionality.</p>
*
* @since Ant 1.1
*
@@ -1673,6 +1673,7 @@ public class Javadoc extends Task {
/**
* Enables deep-copying of <code>doc-files</code> 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 <code>doc-files</code> 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) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/LoadProperties.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/LoadProperties.java b/src/main/org/apache/tools/ant/taskdefs/LoadProperties.java
index 4c20c7c..6086318 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) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/LogOutputStream.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/LogOutputStream.java b/src/main/org/apache/tools/ant/taskdefs/LogOutputStream.java
index 23bb6bd..370bcdd 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.<br>
+ * <p>Tries to be smart about line separators.</p>
*
* @since Ant 1.2
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/MakeUrl.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/MakeUrl.java b/src/main/org/apache/tools/ant/taskdefs/MakeUrl.java
index e23c025..9fc94bc 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) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Manifest.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Manifest.java b/src/main/org/apache/tools/ant/taskdefs/Manifest.java
index 0d7c05e..1daf52f 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 <a href="http://java.sun.com/j2se/1.5.0/docs/guide/jar/jar.html">Jar
- * file specification.</a>}.
+ * <a href="http://java.sun.com/j2se/1.5.0/docs/guide/jar/jar.html">Jar
+ * file specification</a>.
* 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
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/ManifestTask.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/ManifestTask.java b/src/main/org/apache/tools/ant/taskdefs/ManifestTask.java
index 9b600db..ff6961b 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) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/MatchingTask.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/MatchingTask.java b/src/main/org/apache/tools/ant/taskdefs/MatchingTask.java
index 113ff5e..c35af03 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.
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Move.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Move.java b/src/main/org/apache/tools/ant/taskdefs/Move.java
index 7f5d968..c549d1b 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.</p>
*
+ * @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 {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Pack.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Pack.java b/src/main/org/apache/tools/ant/taskdefs/Pack.java
index daabd6b..63dfe05 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 {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Property.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Property.java b/src/main/org/apache/tools/ant/taskdefs/Property.java
index ccfb356..64a6376 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 ;).<br>
+ * this functionality is supported on ;).
+ * </p>
* Note also that properties are case sensitive, even if the
* environment variables on your operating system are not, e.g. it
* will be ${env.Path} not ${env.PATH} on Windows 2000.
+ *
* @param env prefix
*
* @ant.attribute group="noname"
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/PumpStreamHandler.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/PumpStreamHandler.java b/src/main/org/apache/tools/ant/taskdefs/PumpStreamHandler.java
index 0f64544..9a23947 100644
--- a/src/main/org/apache/tools/ant/taskdefs/PumpStreamHandler.java
+++ b/src/main/org/apache/tools/ant/taskdefs/PumpStreamHandler.java
@@ -164,6 +164,7 @@ public class PumpStreamHandler implements ExecuteStreamHandler {
* ThreadWithPumper ThreadWithPumper} instance) or interrupting
* the thread.
*
+ * @param t Thread
* @since Ant 1.8.0
*/
protected final void finish(Thread t) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Recorder.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Recorder.java b/src/main/org/apache/tools/ant/taskdefs/Recorder.java
index cc3b432..a6f6a88 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Recorder.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Recorder.java
@@ -180,8 +180,8 @@ public class Recorder extends Task implements SubBuildListener {
/**
* @see EnumeratedAttribute#getValues()
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public String[] getValues() {
return VALUES;
}
@@ -321,4 +321,3 @@ public class Recorder extends Task implements SubBuildListener {
getProject().removeBuildListener(this);
}
}
-
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/RecorderEntry.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/RecorderEntry.java b/src/main/org/apache/tools/ant/taskdefs/RecorderEntry.java
index a495936..adbb265 100644
--- a/src/main/org/apache/tools/ant/taskdefs/RecorderEntry.java
+++ b/src/main/org/apache/tools/ant/taskdefs/RecorderEntry.java
@@ -90,16 +90,16 @@ public class RecorderEntry implements BuildLogger, SubBuildListener {
/**
* @see org.apache.tools.ant.BuildListener#buildStarted(BuildEvent)
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void buildStarted(BuildEvent event) {
log("> BUILD STARTED", Project.MSG_DEBUG);
}
/**
* @see org.apache.tools.ant.BuildListener#buildFinished(BuildEvent)
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void buildFinished(BuildEvent event) {
log("< BUILD FINISHED", Project.MSG_DEBUG);
@@ -144,8 +144,8 @@ public class RecorderEntry implements BuildLogger, SubBuildListener {
/**
* @see org.apache.tools.ant.BuildListener#targetStarted(BuildEvent)
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void targetStarted(BuildEvent event) {
log(">> TARGET STARTED -- " + event.getTarget(), Project.MSG_DEBUG);
log(StringUtils.LINE_SEP + event.getTarget().getName() + ":",
@@ -155,8 +155,8 @@ public class RecorderEntry implements BuildLogger, SubBuildListener {
/**
* @see org.apache.tools.ant.BuildListener#targetFinished(BuildEvent)
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void targetFinished(BuildEvent event) {
log("<< TARGET FINISHED -- " + event.getTarget(), Project.MSG_DEBUG);
@@ -168,16 +168,16 @@ public class RecorderEntry implements BuildLogger, SubBuildListener {
/**
* @see org.apache.tools.ant.BuildListener#taskStarted(BuildEvent)
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void taskStarted(BuildEvent event) {
log(">>> TASK STARTED -- " + event.getTask(), Project.MSG_DEBUG);
}
/**
* @see org.apache.tools.ant.BuildListener#taskFinished(BuildEvent)
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void taskFinished(BuildEvent event) {
log("<<< TASK FINISHED -- " + event.getTask(), Project.MSG_DEBUG);
flush();
@@ -185,8 +185,8 @@ public class RecorderEntry implements BuildLogger, SubBuildListener {
/**
* @see org.apache.tools.ant.BuildListener#messageLogged(BuildEvent)
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void messageLogged(BuildEvent event) {
log("--- MESSAGE LOGGED", Project.MSG_DEBUG);
@@ -231,8 +231,8 @@ public class RecorderEntry implements BuildLogger, SubBuildListener {
/**
* @see BuildLogger#setMessageOutputLevel(int)
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void setMessageOutputLevel(int level) {
if (level >= Project.MSG_ERR && level <= Project.MSG_DEBUG) {
loglevel = level;
@@ -241,8 +241,8 @@ public class RecorderEntry implements BuildLogger, SubBuildListener {
/**
* @see BuildLogger#setOutputPrintStream(PrintStream)
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void setOutputPrintStream(PrintStream output) {
closeFile();
out = output;
@@ -251,8 +251,8 @@ public class RecorderEntry implements BuildLogger, SubBuildListener {
/**
* @see BuildLogger#setEmacsMode(boolean)
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void setEmacsMode(boolean emacsMode) {
this.emacsMode = emacsMode;
}
@@ -260,8 +260,8 @@ public class RecorderEntry implements BuildLogger, SubBuildListener {
/**
* @see BuildLogger#setErrorPrintStream(PrintStream)
+ * {@inheritDoc}.
*/
- /** {@inheritDoc}. */
public void setErrorPrintStream(PrintStream err) {
setOutputPrintStream(err);
}
@@ -302,6 +302,7 @@ public class RecorderEntry implements BuildLogger, SubBuildListener {
/**
* Get the project associated with this recorder entry.
*
+ * @return Project
* @since 1.8.0
*/
public Project getProject() {
@@ -324,7 +325,7 @@ public class RecorderEntry implements BuildLogger, SubBuildListener {
* Used by Recorder.
* @param append Indicates if output must be appended to the logfile or that
* the logfile should be overwritten.
- * @throws BuildException
+ * @throws BuildException if something goes wrong
* @since 1.6.3
*/
void openFile(boolean append) throws BuildException {
@@ -346,7 +347,7 @@ public class RecorderEntry implements BuildLogger, SubBuildListener {
/**
* Re-opens the file associated with this recorder.
* Used by Recorder.
- * @throws BuildException
+ * @throws BuildException if something goes wrong
* @since 1.6.3
*/
void reopenFile() throws BuildException {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Redirector.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Redirector.java b/src/main/org/apache/tools/ant/taskdefs/Redirector.java
index 5b99d34..9871d16 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Redirector.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Redirector.java
@@ -534,6 +534,8 @@ public class Redirector {
* <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(final boolean b) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Replace.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Replace.java b/src/main/org/apache/tools/ant/taskdefs/Replace.java
index 4b68198..b2474a5 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 <b>not</b> want to set this to
* true.</p>
*
+ * @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 Iterator<Object> getOrderedIterator(Properties props) {
List<Object> keys = new ArrayList<Object>(props.keySet());
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Rmic.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Rmic.java b/src/main/org/apache/tools/ant/taskdefs/Rmic.java
index 6935f9e..d72c39e 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Rmic.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Rmic.java
@@ -72,11 +72,11 @@ import org.apache.tools.ant.util.facade.FacadeTaskHelper;
* <ul>
* <li>sun (the standard compiler of the JDK)</li>
* <li>kaffe (the standard compiler of
- * {@link <a href="http://www.kaffe.org">Kaffe</a>})</li>
+ * <a href="http://www.kaffe.org">Kaffe</a>)</li>
* <li>weblogic</li>
* </ul>
*
- * <p> The <a href="http://dione.zcu.cz/~toman40/miniRMI/">miniRMI</a>
+ * <p>The <a href="http://dione.zcu.cz/~toman40/miniRMI/">miniRMI</a>
* project contains a compiler implementation for this task as well,
* please consult miniRMI's documentation to learn how to use it.</p>
*
@@ -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) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/SQLExec.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/SQLExec.java b/src/main/org/apache/tools/ant/taskdefs/SQLExec.java
index d913566..2f247c9 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 {
*
* <p>Defaults to ","</p>
*
+ * @param s String
* @since Ant 1.8.0
*/
public void setCsvColumnSeparator(String s) {
@@ -550,6 +557,7 @@ public class SQLExec extends JDBCTask {
*
* <p>Defaults to "not set"</p>
*
+ * @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.</p>
+ *
+ * @return Statement
+ * @throws SQLException if statement creation or processing fails
*/
protected Statement getStatement() throws SQLException {
if (statement == null) {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Sequential.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Sequential.java b/src/main/org/apache/tools/ant/taskdefs/Sequential.java
index 468ac14..f2f88a9 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.
- * <p>
+ *
* @param nestedTask Nested task to execute Sequential
- * <p>
*/
public void addTask(Task nestedTask) {
nestedTasks.addElement(nestedTask);
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/SignJar.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/SignJar.java b/src/main/org/apache/tools/ant/taskdefs/SignJar.java
index fc31b1d..bb17174 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 {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/SubAnt.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/SubAnt.java b/src/main/org/apache/tools/ant/taskdefs/SubAnt.java
index c374d83..f3207aa 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.
- * <p>
- * <h2> Use with directories </h2>
+ *
+ * <h2>Use with directories</h2>
* <p>
* 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.
* <p>
- * 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.
+ * </p>
*
* @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
- * <p>
*/
- // 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 {
* <em>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!</em>
+ * </p>
*
* @param set the directory set to add.
*/
@@ -486,6 +488,7 @@ public class SubAnt extends Task {
* <em>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!</em>
+ * </p>
*
* @param set the file set to add.
*/
@@ -498,6 +501,7 @@ public class SubAnt extends Task {
* <p>
* <em>Note that contrary to file and directory sets, file lists
* can reference non-existent files or directories!</em>
+ * </p>
*
* @param list the file list to add.
*/
@@ -639,4 +643,4 @@ public class SubAnt extends Task {
}
}
-} // END class SubAnt
+}
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Sync.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Sync.java b/src/main/org/apache/tools/ant/taskdefs/Sync.java
index bcdfd52..e99bafd 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 {
* <p>If the directory is an orphan, it will also be removed.</p>
*
* @param nonOrphans the table of all non-orphan <code>File</code>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() {
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/TempFile.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/TempFile.java b/src/main/org/apache/tools/ant/taskdefs/TempFile.java
index 5f55a37..9756fbc 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;
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Tstamp.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Tstamp.java b/src/main/org/apache/tools/ant/taskdefs/Tstamp.java
index a6a35d7..f86ed03 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);
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Untar.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Untar.java b/src/main/org/apache/tools/ant/taskdefs/Untar.java
index 8343aec..53b8239 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);
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/WaitFor.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/WaitFor.java b/src/main/org/apache/tools/ant/taskdefs/WaitFor.java
index d23beab..3f94d6f 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;
}
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison.java b/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison.java
index 5976bce..617790a 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
+}
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison2.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison2.java b/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison2.java
index f41f915..0653b40 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);
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/XSLTProcess.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/XSLTProcess.java b/src/main/org/apache/tools/ant/taskdefs/XSLTProcess.java
index 8fce71e..676f6ae 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.</p>
*
+ * @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 <tt>out</tt> attribute; ; required if <tt>out</tt> is set
+ * with the <tt>out</tt> attribute; required if <tt>out</tt> 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 Iterable<Feature> getFeatures() {
return features;
@@ -1678,6 +1693,8 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
/**
* Set to true if the listener is to print events that occur
* as each node is 'executed' in the stylesheet.
+ *
+ * @param b boolean
*/
public void setElements(final boolean b) {
elements = b;
@@ -1686,6 +1703,8 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
/**
* True if the listener is to print events that occur as each
* node is 'executed' in the stylesheet.
+ *
+ * @return boolean
*/
public boolean getElements() {
return elements;
@@ -1694,6 +1713,8 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
/**
* Set to true if the listener is to print information after
* each extension event.
+ *
+ * @param b boolean
*/
public void setExtension(final boolean b) {
extension = b;
@@ -1702,6 +1723,8 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
/**
* True if the listener is to print information after each
* extension event.
+ *
+ * @return boolean
*/
public boolean getExtension() {
return extension;
@@ -1710,6 +1733,8 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
/**
* Set to true if the listener is to print information after
* each result-tree generation event.
+ *
+ * @param b boolean
*/
public void setGeneration(final boolean b) {
generation = b;
@@ -1718,6 +1743,8 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
/**
* True if the listener is to print information after each
* result-tree generation event.
+ *
+ * @return boolean
*/
public boolean getGeneration() {
return generation;
@@ -1726,6 +1753,8 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
/**
* Set to true if the listener is to print information after
* each selection event.
+ *
+ * @param b boolean
*/
public void setSelection(final boolean b) {
selection = b;
@@ -1734,6 +1763,8 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
/**
* True if the listener is to print information after each
* selection event.
+ *
+ * @return boolean
*/
public boolean getSelection() {
return selection;
@@ -1742,6 +1773,8 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
/**
* Set to true if the listener is to print an event whenever a
* template is invoked.
+ *
+ * @param b boolean
*/
public void setTemplates(final boolean b) {
templates = b;
@@ -1750,6 +1783,8 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
/**
* True if the listener is to print an event whenever a
* template is invoked.
+ *
+ * @return boolean
*/
public boolean getTemplates() {
return templates;
@@ -1757,6 +1792,8 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger {
/**
* The stream to write traces to.
+ *
+ * @return OutputStream
*/
public java.io.OutputStream getOutputStream() {
return new LogOutputStream(XSLTProcess.this);
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/XmlProperty.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/XmlProperty.java b/src/main/org/apache/tools/ant/taskdefs/XmlProperty.java
index ffd89d1..c919d33 100644
--- a/src/main/org/apache/tools/ant/taskdefs/XmlProperty.java
+++ b/src/main/org/apache/tools/ant/taskdefs/XmlProperty.java
@@ -140,7 +140,7 @@ import org.xml.sax.SAXException;
* </classpath>
* </pre>
*
- * <p> This task <i>requires</i> the following attributes:</p>
+ * <p>This task <i>requires</i> the following attributes:</p>
*
* <ul>
* <li><b>file</b>: The name of the file to load.</li>
@@ -732,10 +732,14 @@ public class XmlProperty extends org.apache.tools.ant.Task {
return this.rootDirectory;
}
+ @Deprecated
+ protected boolean getIncludeSementicAttribute() {
+ return getIncludeSemanticAttribute();
+ }
/**
* @return the include semantic attribute.
*/
- protected boolean getIncludeSementicAttribute () {
+ protected boolean getIncludeSemanticAttribute() {
return this.includeSemanticAttribute;
}
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/Zip.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/Zip.java b/src/main/org/apache/tools/ant/taskdefs/Zip.java
index d1e1065..bc965e1 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Zip.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Zip.java
@@ -505,6 +505,7 @@ public class Zip extends MatchingTask {
/**
* Assume 0 Unix mode is intentional.
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setPreserve0Permissions(final boolean b) {
@@ -513,6 +514,7 @@ public class Zip extends MatchingTask {
/**
* Assume 0 Unix mode is intentional.
+ * @return boolean
* @since Ant 1.8.0
*/
public boolean getPreserve0Permissions() {
@@ -521,6 +523,7 @@ public class Zip extends MatchingTask {
/**
* Whether to set the language encoding flag.
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setUseLanguageEncodingFlag(final boolean b) {
@@ -529,6 +532,7 @@ public class Zip extends MatchingTask {
/**
* Whether the language encoding flag will be used.
+ * @return boolean
* @since Ant 1.8.0
*/
public boolean getUseLanguageEnodingFlag() {
@@ -537,6 +541,7 @@ public class Zip extends MatchingTask {
/**
* Whether Unicode extra fields will be created.
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setCreateUnicodeExtraFields(final UnicodeExtraField b) {
@@ -545,6 +550,7 @@ public class Zip extends MatchingTask {
/**
* Whether Unicode extra fields will be created.
+ * @return boolean
* @since Ant 1.8.0
*/
public UnicodeExtraField getCreateUnicodeExtraFields() {
@@ -557,6 +563,7 @@ public class Zip extends MatchingTask {
*
* <p>Defaults to false.</p>
*
+ * @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
http://git-wip-us.apache.org/repos/asf/ant/blob/67f29ce0/src/main/org/apache/tools/ant/taskdefs/compilers/DefaultCompilerAdapter.java
----------------------------------------------------------------------
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 350dbe5..7b291f5 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);