You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ant.apache.org by gi...@apache.org on 2017/12/10 06:16:21 UTC
[6/8] ant git commit: Let’s use doclint
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/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 4168604..29b6275 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Zip.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Zip.java
@@ -496,6 +496,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) {
@@ -504,6 +505,7 @@ public class Zip extends MatchingTask {
/**
* Assume 0 Unix mode is intentional.
+ * @return boolean
* @since Ant 1.8.0
*/
public boolean getPreserve0Permissions() {
@@ -512,6 +514,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) {
@@ -520,6 +523,7 @@ public class Zip extends MatchingTask {
/**
* Whether the language encoding flag will be used.
+ * @return boolean
* @since Ant 1.8.0
*/
public boolean getUseLanguageEnodingFlag() {
@@ -528,6 +532,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) {
@@ -536,6 +541,7 @@ public class Zip extends MatchingTask {
/**
* Whether Unicode extra fields will be created.
+ * @return boolean
* @since Ant 1.8.0
*/
public UnicodeExtraField getCreateUnicodeExtraFields() {
@@ -548,6 +554,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) {
@@ -558,6 +565,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() {
@@ -566,6 +574,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) {
@@ -574,6 +583,7 @@ public class Zip extends MatchingTask {
/**
* Whether Zip64 extensions will be used.
+ * @return boolean
* @since Ant 1.9.1
*/
public Zip64ModeAttribute getZip64Mode() {
@@ -597,6 +607,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.10.2
*/
public String getModificationtime() {
@@ -1638,7 +1649,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.
@@ -1733,6 +1744,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() {
@@ -1742,6 +1754,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) {
@@ -2049,6 +2062,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
*/
@@ -2066,6 +2080,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) {
@@ -2081,8 +2097,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" };
@@ -2138,7 +2154,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/6656db28/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 62fb428..1a63064 100644
--- a/src/main/org/apache/tools/ant/taskdefs/compilers/DefaultCompilerAdapter.java
+++ b/src/main/org/apache/tools/ant/taskdefs/compilers/DefaultCompilerAdapter.java
@@ -301,7 +301,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);
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/compilers/JavacExternal.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/compilers/JavacExternal.java b/src/main/org/apache/tools/ant/taskdefs/compilers/JavacExternal.java
index 6a03709..f63d4ac 100644
--- a/src/main/org/apache/tools/ant/taskdefs/compilers/JavacExternal.java
+++ b/src/main/org/apache/tools/ant/taskdefs/compilers/JavacExternal.java
@@ -67,9 +67,9 @@ public class JavacExternal extends DefaultCompilerAdapter {
/**
* helper method to execute our command on VMS.
- * @param cmd
- * @param firstFileName
- * @return
+ * @param cmd Commandline
+ * @param firstFileName int
+ * @return boolean
*/
private boolean execOnVMS(Commandline cmd, int firstFileName) {
File vmsFile = null;
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/condition/Http.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/condition/Http.java b/src/main/org/apache/tools/ant/taskdefs/condition/Http.java
index 7f3427f..3b718df 100644
--- a/src/main/org/apache/tools/ant/taskdefs/condition/Http.java
+++ b/src/main/org/apache/tools/ant/taskdefs/condition/Http.java
@@ -68,7 +68,7 @@ public class Http extends ProjectComponent implements Condition {
*
* @param method The HTTP request method to use. Valid values are
* the same as those accepted by the
- * HttpURLConnection.setRequestMetho d() method,
+ * HttpURLConnection.setRequestMethod() method,
* such as "GET", "HEAD", "TRACE", etc. The default
* if not specified is "GET".
*
@@ -83,6 +83,8 @@ public class Http extends ProjectComponent implements Condition {
/**
* Whether redirects sent by the server should be followed,
* defaults to true.
+ *
+ * @param f boolean
* @since Ant 1.9.7
*/
public void setFollowRedirects(boolean f) {
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/condition/IsLastModified.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/condition/IsLastModified.java b/src/main/org/apache/tools/ant/taskdefs/condition/IsLastModified.java
index 51471c8..0446dd5 100644
--- a/src/main/org/apache/tools/ant/taskdefs/condition/IsLastModified.java
+++ b/src/main/org/apache/tools/ant/taskdefs/condition/IsLastModified.java
@@ -151,8 +151,8 @@ public class IsLastModified extends ProjectComponent implements Condition {
/**
* evaluate the condition
- * @return true or false depending on the compoarison mode and the time of the resource
- * @throws BuildException
+ * @return true or false depending on the comparison mode and the time of the resource
+ * @throws BuildException if something goes wrong
*/
@Override
public boolean eval() throws BuildException {
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/condition/IsReachable.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/condition/IsReachable.java b/src/main/org/apache/tools/ant/taskdefs/condition/IsReachable.java
index de3f811..9083dd6 100644
--- a/src/main/org/apache/tools/ant/taskdefs/condition/IsReachable.java
+++ b/src/main/org/apache/tools/ant/taskdefs/condition/IsReachable.java
@@ -185,7 +185,7 @@ public class IsReachable extends ProjectComponent implements Condition {
//utterly implausible, but catered for anyway
throw new BuildException("When calling " + reachableMethod);
} catch (final InvocationTargetException e) {
- //assume this is an IOexception about un readability
+ //assume this is an IOException about un readability
final Throwable nested = e.getTargetException();
log(ERROR_ON_NETWORK + target + ": " + nested.toString());
//any kind of fault: not reachable.
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/condition/Os.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/condition/Os.java b/src/main/org/apache/tools/ant/taskdefs/condition/Os.java
index 07ccb59..1d9e2d1 100644
--- a/src/main/org/apache/tools/ant/taskdefs/condition/Os.java
+++ b/src/main/org/apache/tools/ant/taskdefs/condition/Os.java
@@ -86,8 +86,8 @@ public class Os implements Condition {
/**
* OpenJDK is reported to call MacOS X "Darwin"
- * @see https://issues.apache.org/bugzilla/show_bug.cgi?id=44889
- * @see https://issues.apache.org/jira/browse/HADOOP-3318
+ * @see <a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=44889">Bugzilla</a>
+ * @see <a href="https://issues.apache.org/jira/browse/HADOOP-3318">Jira</a>
*/
private static final String DARWIN = "darwin";
@@ -127,8 +127,8 @@ public class Os implements Condition {
/**
* Sets the desired OS family type
*
- * @param f The OS family type desired<br>
- * Possible values:<br>
+ * @param f The OS family type desired
+ * <p>Possible values:</p>
* <ul>
* <li>dos</li>
* <li>mac</li>
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/condition/ResourceExists.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/condition/ResourceExists.java b/src/main/org/apache/tools/ant/taskdefs/condition/ResourceExists.java
index feda65b..0e4de58 100644
--- a/src/main/org/apache/tools/ant/taskdefs/condition/ResourceExists.java
+++ b/src/main/org/apache/tools/ant/taskdefs/condition/ResourceExists.java
@@ -32,6 +32,8 @@ public class ResourceExists extends ProjectComponent implements Condition {
/**
* The resource to test.
+ *
+ * @param r Resource
*/
public void add(Resource r) {
if (resource != null) {
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/cvslib/ChangeLogTask.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/cvslib/ChangeLogTask.java b/src/main/org/apache/tools/ant/taskdefs/cvslib/ChangeLogTask.java
index 6ef730e..8182749 100644
--- a/src/main/org/apache/tools/ant/taskdefs/cvslib/ChangeLogTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/cvslib/ChangeLogTask.java
@@ -41,36 +41,24 @@ import org.apache.tools.ant.types.FileSet;
*
* It produces an XML output representing the list of changes.
* <pre>
- * <font color=#0000ff><!-- Root element --></font>
- * <font color=#6a5acd><!ELEMENT</font> changelog <font color=#ff00ff>
- * (entry</font><font color=#ff00ff>+</font><font color=#ff00ff>)
- * </font><font color=#6a5acd>></font>
- * <font color=#0000ff><!-- CVS Entry --></font>
- * <font color=#6a5acd><!ELEMENT</font> entry <font color=#ff00ff>
- * (date,author,file</font><font color=#ff00ff>+</font><font color=#ff00ff>,msg)
- * </font><font color=#6a5acd>></font>
- * <font color=#0000ff><!-- Date of cvs entry --></font>
- * <font color=#6a5acd><!ELEMENT</font> date <font color=#ff00ff>(#PCDATA)
- * </font><font color=#6a5acd>></font>
- * <font color=#0000ff><!-- Author of change --></font>
- * <font color=#6a5acd><!ELEMENT</font> author <font color=#ff00ff>(#PCDATA)
- * </font><font color=#6a5acd>></font>
- * <font color=#0000ff><!-- List of files affected --></font>
- * <font color=#6a5acd><!ELEMENT</font> msg <font color=#ff00ff>(#PCDATA)
- * </font><font color=#6a5acd>></font>
- * <font color=#0000ff><!-- File changed --></font>
- * <font color=#6a5acd><!ELEMENT</font> file <font color=#ff00ff>
- * (name,revision,prevrevision</font><font color=#ff00ff>?</font>
- * <font color=#ff00ff>)</font><font color=#6a5acd>></font>
- * <font color=#0000ff><!-- Name of the file --></font>
- * <font color=#6a5acd><!ELEMENT</font> name <font color=#ff00ff>(#PCDATA)
- * </font><font color=#6a5acd>></font>
- * <font color=#0000ff><!-- Revision number --></font>
- * <font color=#6a5acd><!ELEMENT</font> revision <font color=#ff00ff>
- * (#PCDATA)</font><font color=#6a5acd>></font>
- * <font color=#0000ff><!-- Previous revision number --></font>
- * <font color=#6a5acd><!ELEMENT</font> prevrevision <font color=#ff00ff>
- * (#PCDATA)</font><font color=#6a5acd>></font>
+ * <!-- Root element -->
+ * <!ELEMENT changelog (entry+)>
+ * <!-- CVS Entry -->
+ * <!ELEMENT entry (date,author,file+,msg)>
+ * <!-- Date of cvs entry -->
+ * <!ELEMENT date (#PCDATA)>
+ * <!-- Author of change -->
+ * <!ELEMENT author (#PCDATA)>
+ * <!-- List of files affected -->
+ * <!ELEMENT msg (#PCDATA)>
+ * <!-- File changed -->
+ * <!ELEMENT file (name,revision,prevrevision?)>
+ * <!-- Name of the file -->
+ * <!ELEMENT name (#PCDATA)>
+ * <!-- Revision number -->
+ * <!ELEMENT revision (#PCDATA)>
+ * <!-- Previous revision number -->
+ * <!ELEMENT prevrevision (#PCDATA)>
* </pre>
*
* @since Ant 1.5
@@ -183,6 +171,7 @@ public class ChangeLogTask extends AbstractCvsTask {
* Whether to use rlog against a remote repository instead of log
* in a working copy's directory.
*
+ * @param remote boolean
* @since Ant 1.8.0
*/
public void setRemote(final boolean remote) {
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/cvslib/CvsTagDiff.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/cvslib/CvsTagDiff.java b/src/main/org/apache/tools/ant/taskdefs/cvslib/CvsTagDiff.java
index 83ec607..3a61f7c 100644
--- a/src/main/org/apache/tools/ant/taskdefs/cvslib/CvsTagDiff.java
+++ b/src/main/org/apache/tools/ant/taskdefs/cvslib/CvsTagDiff.java
@@ -42,9 +42,9 @@ import org.w3c.dom.Element;
* Examines the output of cvs rdiff between two tags.
*
* It produces an XML output representing the list of changes.
- * <PRE>
+ * <pre>
* <!-- Root element -->
- * <!ELEMENT tagdiff ( entry+ ) >
+ * <!ELEMENT tagdiff (entry+) >
* <!-- Start tag of the report -->
* <!ATTLIST tagdiff startTag NMTOKEN #IMPLIED >
* <!-- End tag of the report -->
@@ -55,16 +55,16 @@ import org.w3c.dom.Element;
* <!ATTLIST tagdiff endDate NMTOKEN #IMPLIED >
*
* <!-- CVS tag entry -->
- * <!ELEMENT entry ( file ) >
+ * <!ELEMENT entry (file) >
* <!-- File added, changed or removed -->
- * <!ELEMENT file ( name, revision?, prevrevision? ) >
+ * <!ELEMENT file (name, revision?, prevrevision?) >
* <!-- Name of the file -->
- * <!ELEMENT name ( #PCDATA ) >
+ * <!ELEMENT name (#PCDATA) >
* <!-- Revision number -->
- * <!ELEMENT revision ( #PCDATA ) >
+ * <!ELEMENT revision (#PCDATA) >
* <!-- Previous revision number -->
- * <!ELEMENT prevrevision ( #PCDATA ) >
- * </PRE>
+ * <!ELEMENT prevrevision (#PCDATA) >
+ * </pre>
*
* @since Ant 1.5
* @ant.task name="cvstagdiff"
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/email/EmailAddress.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/email/EmailAddress.java b/src/main/org/apache/tools/ant/taskdefs/email/EmailAddress.java
index a515478..f8e2133 100644
--- a/src/main/org/apache/tools/ant/taskdefs/email/EmailAddress.java
+++ b/src/main/org/apache/tools/ant/taskdefs/email/EmailAddress.java
@@ -92,15 +92,15 @@ public class EmailAddress {
}
}
- // DEBUG: System.out.println( email );
+ // DEBUG: System.out.println(email);
if (end == 0) {
end = len;
}
- // DEBUG: System.out.println( "address: " + start + " " + end );
+ // DEBUG: System.out.println("address: " + start + " " + end);
if (nEnd == 0) {
nEnd = len;
}
- // DEBUG: System.out.println( "name: " + nStart + " " + nEnd );
+ // DEBUG: System.out.println("name: " + nStart + " " + nEnd);
this.address = trim(email.substring(start, end), true);
this.name = trim(email.substring(nStart, nEnd), false);
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/email/EmailTask.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/email/EmailTask.java b/src/main/org/apache/tools/ant/taskdefs/email/EmailTask.java
index ec2987e..62b8ae5 100644
--- a/src/main/org/apache/tools/ant/taskdefs/email/EmailTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/email/EmailTask.java
@@ -111,6 +111,7 @@ public class EmailTask extends Task {
/**
* Set the user for SMTP auth; this requires JavaMail.
+ *
* @param user the String username.
* @since Ant 1.6
*/
@@ -120,6 +121,7 @@ public class EmailTask extends Task {
/**
* Set the password for SMTP auth; this requires JavaMail.
+ *
* @param password the String password.
* @since Ant 1.6
*/
@@ -129,6 +131,7 @@ public class EmailTask extends Task {
/**
* Set whether to send data over SSL.
+ *
* @param ssl boolean; if true SSL will be used.
* @since Ant 1.6
*/
@@ -139,6 +142,7 @@ public class EmailTask extends Task {
/**
* Set whether to allow authentication to switch to a TLS
* connection via STARTTLS.
+ *
* @param b boolean; if true STARTTLS will be supported.
* @since Ant 1.8.0
*/
@@ -425,6 +429,7 @@ public class EmailTask extends Task {
* <p>Even with this property set to true the task will still fail
* if the mail couldn't be sent to any recipient at all.</p>
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setIgnoreInvalidRecipients(boolean b) {
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/email/Mailer.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/email/Mailer.java b/src/main/org/apache/tools/ant/taskdefs/email/Mailer.java
index 4805177..010b87e 100644
--- a/src/main/org/apache/tools/ant/taskdefs/email/Mailer.java
+++ b/src/main/org/apache/tools/ant/taskdefs/email/Mailer.java
@@ -74,6 +74,8 @@ public abstract class Mailer {
/**
* Whether the port has been explicitly specified by the user.
+ *
+ * @param explicit boolean
* @since Ant 1.8.2
*/
public void setPortExplicitlySpecified(boolean explicit) {
@@ -82,6 +84,8 @@ public abstract class Mailer {
/**
* Whether the port has been explicitly specified by the user.
+ *
+ * @return boolean
* @since Ant 1.8.2
*/
protected boolean isPortExplicitlySpecified() {
@@ -151,9 +155,9 @@ public abstract class Mailer {
}
/**
- * Set the replyto addresses.
+ * Set the replyTo addresses.
*
- * @param list a vector of reployTo addresses.
+ * @param list a vector of replyTo addresses.
* @since Ant 1.6
*/
public void setReplyToList(Vector<EmailAddress> list) {
@@ -247,6 +251,7 @@ public abstract class Mailer {
* <p>Even with this property set to true the task will still fail
* if the mail couldn't be sent to any recipient at all.</p>
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setIgnoreInvalidRecipients(boolean b) {
@@ -256,6 +261,7 @@ public abstract class Mailer {
/**
* Whether invalid recipients should be ignored.
*
+ * @return boolean
* @since Ant 1.8.0
*/
protected boolean shouldIgnoreInvalidRecipients() {
@@ -267,7 +273,6 @@ public abstract class Mailer {
* header.
*
* @return the current date in SMTP suitable format.
- *
* @since Ant 1.5
*/
protected final String getDate() {
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/launcher/CommandLauncher.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/launcher/CommandLauncher.java b/src/main/org/apache/tools/ant/taskdefs/launcher/CommandLauncher.java
index 5139ce9..4af7936 100644
--- a/src/main/org/apache/tools/ant/taskdefs/launcher/CommandLauncher.java
+++ b/src/main/org/apache/tools/ant/taskdefs/launcher/CommandLauncher.java
@@ -132,6 +132,9 @@ public class CommandLauncher {
/**
* Obtains the shell launcher configured for the given project or
* the default shell launcher.
+ *
+ * @param project Project
+ * @return CommandLauncher
*/
public static CommandLauncher getShellLauncher(Project project) {
CommandLauncher launcher = extractLauncher(ANT_SHELL_LAUNCHER_REF_ID,
@@ -146,6 +149,9 @@ public class CommandLauncher {
/**
* Obtains the VM launcher configured for the given project or
* the default VM launcher.
+ *
+ * @param project Project
+ * @return CommandLauncher
*/
public static CommandLauncher getVMLauncher(Project project) {
CommandLauncher launcher = extractLauncher(ANT_VM_LAUNCHER_REF_ID,
@@ -180,6 +186,9 @@ public class CommandLauncher {
/**
* Sets the VM launcher to use for the given project.
+ *
+ * @param project Project
+ * @param launcher CommandLauncher
*/
public static void setVMLauncher(Project project,
CommandLauncher launcher) {
@@ -190,6 +199,9 @@ public class CommandLauncher {
/**
* Sets the shell launcher to use for the given project.
+ *
+ * @param project Project
+ * @param launcher CommandLauncher
*/
public static void setShellLauncher(Project project,
CommandLauncher launcher) {
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/ANTLR.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ANTLR.java b/src/main/org/apache/tools/ant/taskdefs/optional/ANTLR.java
index 3d13f26..fb7071c 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ANTLR.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ANTLR.java
@@ -96,7 +96,7 @@ public class ANTLR extends Task {
/**
* The grammar file to process.
- * @param target the gramer file
+ * @param target the grammar file
*/
public void setTarget(File target) {
log("Setting target to: " + target.toString(), Project.MSG_VERBOSE);
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/EchoProperties.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/EchoProperties.java b/src/main/org/apache/tools/ant/taskdefs/optional/EchoProperties.java
index 8132f36..e2945fb 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/EchoProperties.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/EchoProperties.java
@@ -54,35 +54,38 @@ import org.w3c.dom.Document;
import org.w3c.dom.Element;
/**
- * Displays all the current properties in the build. The output can be sent to
- * a file if desired. <P>
- *
- * Attribute "destfile" defines a file to send the properties to. This can be
- * processed as a standard property file later. <P>
- *
- * Attribute "prefix" defines a prefix which is used to filter the properties
- * only those properties starting with this prefix will be echoed. <P>
- *
- * By default, the "failonerror" attribute is enabled. If an error occurs while
- * writing the properties to a file, and this attribute is enabled, then a
- * BuildException will be thrown. If disabled, then IO errors will be reported
- * as a log statement, but no error will be thrown. <P>
- *
- * Examples: <pre>
+ * Displays all the current properties in the build. The output can be sent to
+ * a file if desired.
+ * <p>
+ * Attribute "destfile" defines a file to send the properties to. This can be
+ * processed as a standard property file later.
+ * </p>
+ * <p>
+ * Attribute "prefix" defines a prefix which is used to filter the properties
+ * only those properties starting with this prefix will be echoed.
+ * </p>
+ * <p>
+ * By default, the "failonerror" attribute is enabled. If an error occurs while
+ * writing the properties to a file, and this attribute is enabled, then a
+ * BuildException will be thrown. If disabled, then IO errors will be reported
+ * as a log statement, but no error will be thrown.
+ * </p>
+ * <p>Examples:</p><pre>
* <echoproperties />
- * </pre> Report the current properties to the log. <P>
- *
- * <pre>
+ * </pre>
+ * Report the current properties to the log.
+ * <pre>
* <echoproperties destfile="my.properties" />
- * </pre> Report the current properties to the file "my.properties", and will
- * fail the build if the file could not be created or written to. <P>
- *
- * <pre>
+ * </pre>
+ * Report the current properties to the file "my.properties", and will
+ * fail the build if the file could not be created or written to.
+ * <pre>
* <echoproperties destfile="my.properties" failonerror="false"
* prefix="ant" />
- * </pre> Report all properties beginning with 'ant' to the file
- * "my.properties", and will log a message if the file could not be created or
- * written to, but will still allow the build to continue.
+ * </pre>
+ * Report all properties beginning with 'ant' to the file
+ * "my.properties", and will log a message if the file could not be created or
+ * written to, but will still allow the build to continue.
*
*@since Ant 1.5
*/
@@ -114,15 +117,15 @@ public class EchoProperties extends Task {
private File inFile = null;
/**
- * File object pointing to the output file. If this is null, then
- * we output to the project log, not to a file.
+ * File object pointing to the output file. If this is null, then
+ * we output to the project log, not to a file.
*/
private File destfile = null;
/**
- * If this is true, then errors generated during file output will become
- * build errors, and if false, then such errors will be logged, but not
- * thrown.
+ * If this is true, then errors generated during file output will become
+ * build errors, and if false, then such errors will be logged, but not
+ * thrown.
*/
private boolean failonerror = true;
@@ -150,7 +153,7 @@ public class EchoProperties extends Task {
* Set a file to store the property output. If this is never specified,
* then the output will be sent to the Ant log.
*
- *@param destfile file to store the property output
+ * @param destfile file to store the property output
*/
public void setDestfile(File destfile) {
this.destfile = destfile;
@@ -160,7 +163,7 @@ public class EchoProperties extends Task {
* If true, the task will fail if an error occurs writing the properties
* file, otherwise errors are just logged.
*
- *@param failonerror <tt>true</tt> if IO exceptions are reported as build
+ * @param failonerror <tt>true</tt> if IO exceptions are reported as build
* exceptions, or <tt>false</tt> if IO exceptions are ignored.
*/
public void setFailOnError(boolean failonerror) {
@@ -168,15 +171,15 @@ public class EchoProperties extends Task {
}
/**
- * If the prefix is set, then only properties which start with this
- * prefix string will be recorded. If regex is not set and if this
- * is never set, or it is set to an empty string or <tt>null</tt>,
- * then all properties will be recorded. <P>
+ * If the prefix is set, then only properties which start with this
+ * prefix string will be recorded. If regex is not set and if this
+ * is never set, or it is set to an empty string or <tt>null</tt>,
+ * then all properties will be recorded.
*
- * For example, if the attribute is set as:
- * <PRE><echoproperties prefix="ant." /></PRE>
- * then the property "ant.home" will be recorded, but "ant-example"
- * will not.
+ * <p>For example, if the attribute is set as:</p>
+ * <pre><echoproperties prefix="ant." /></pre>
+ * then the property "ant.home" will be recorded, but "ant-example"
+ * will not.
*
* @param prefix The new prefix value
*/
@@ -191,15 +194,15 @@ public class EchoProperties extends Task {
}
/**
- * If the regex is set, then only properties whose names match it
- * will be recorded. If prefix is not set and if this is never set,
- * or it is set to an empty string or <tt>null</tt>, then all
- * properties will be recorded.<P>
+ * If the regex is set, then only properties whose names match it
+ * will be recorded. If prefix is not set and if this is never set,
+ * or it is set to an empty string or <tt>null</tt>, then all
+ * properties will be recorded.
*
- * For example, if the attribute is set as:
- * <PRE><echoproperties prefix=".*ant.*" /></PRE>
- * then the properties "ant.home" and "user.variant" will be recorded,
- * but "ant-example" will not.
+ * <p>For example, if the attribute is set as:</p>
+ * <pre><echoproperties prefix=".*ant.*" /></pre>
+ * then the properties "ant.home" and "user.variant" will be recorded,
+ * but "ant-example" will not.
*
* @param regex The new regex value
*
@@ -250,9 +253,9 @@ public class EchoProperties extends Task {
}
/**
- * Run the task.
+ * Run the task.
*
- *@exception BuildException trouble, probably file IO
+ * @exception BuildException trouble, probably file IO
*/
@Override
public void execute() throws BuildException {
@@ -328,10 +331,10 @@ public class EchoProperties extends Task {
}
/**
- * Send the key/value pairs in the hashtable to the given output stream.
- * Only those properties matching the <tt>prefix</tt> constraint will be
- * sent to the output stream.
- * The output stream will be closed when this method returns.
+ * Send the key/value pairs in the hashtable to the given output stream.
+ * Only those properties matching the <tt>prefix</tt> constraint will be
+ * sent to the output stream.
+ * The output stream will be closed when this method returns.
*
* @param allProps propfile to save
* @param os output stream
@@ -421,7 +424,7 @@ public class EchoProperties extends Task {
}
private List<Tuple> sortProperties(Properties props) {
- //sort the list. Makes SCM and manual diffs easier.
+ // sort the list. Makes SCM and manual diffs easier.
return props.stringPropertyNames().stream()
.map(k -> new Tuple(k, props.getProperty(k))).sorted()
.collect(Collectors.toList());
@@ -459,14 +462,14 @@ public class EchoProperties extends Task {
}
/**
- * JDK 1.2 allows for the safer method
- * <tt>Properties.store(OutputStream, String)</tt>, which throws an
- * <tt>IOException</tt> on an output error.
+ * JDK 1.2 allows for the safer method
+ * <tt>Properties.store(OutputStream, String)</tt>, which throws an
+ * <tt>IOException</tt> on an output error.
*
- *@param props the properties to record
- *@param os record the properties to this output stream
- *@param header prepend this header to the property output
- *@exception IOException on an I/O error during a write.
+ * @param props the properties to record
+ * @param os record the properties to this output stream
+ * @param header prepend this header to the property output
+ * @exception IOException on an I/O error during a write.
*/
protected void jdkSaveProperties(Properties props, OutputStream os,
String header) throws IOException {
@@ -512,7 +515,7 @@ public class EchoProperties extends Task {
/**
* Uses the DocumentBuilderFactory to get a DocumentBuilder instance.
*
- * @return The DocumentBuilder instance
+ * @return The DocumentBuilder instance
*/
private static DocumentBuilder getDocumentBuilder() {
try {
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/Javah.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/Javah.java b/src/main/org/apache/tools/ant/taskdefs/optional/Javah.java
index dd3e107..1e2e18e 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/Javah.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/Javah.java
@@ -395,6 +395,7 @@ public class Javah extends Task {
* The classpath to use when loading the javah implementation
* if it is not a built-in one.
*
+ * @return Path
* @since Ant 1.8.0
*/
public Path createImplementationClasspath() {
@@ -403,6 +404,8 @@ public class Javah extends Task {
/**
* Set the adapter explicitly.
+ *
+ * @param adapter JavahAdapter
* @since Ant 1.8.0
*/
public void add(JavahAdapter adapter) {
@@ -495,6 +498,6 @@ public class Javah extends Task {
}
private enum Settings {
- cls, files, classes;
+ cls, files, classes
}
}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/Native2Ascii.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/Native2Ascii.java b/src/main/org/apache/tools/ant/taskdefs/optional/Native2Ascii.java
index e761975..d7de33d 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/Native2Ascii.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/Native2Ascii.java
@@ -69,6 +69,7 @@ public class Native2Ascii extends MatchingTask {
/**
* The value of the reverse attribute.
+ *
* @return the reverse attribute.
* @since Ant 1.6.3
*/
@@ -89,6 +90,7 @@ public class Native2Ascii extends MatchingTask {
/**
* The value of the encoding attribute.
+ *
* @return the encoding attribute.
* @since Ant 1.6.3
*/
@@ -127,6 +129,7 @@ public class Native2Ascii extends MatchingTask {
/**
* Choose the implementation for this particular task.
+ *
* @param impl the name of the implementation
* @since Ant 1.6.3
*/
@@ -142,7 +145,6 @@ public class Native2Ascii extends MatchingTask {
* Defines the FileNameMapper to use (nested mapper element).
*
* @return the mapper to use for file name translations.
- *
* @throws BuildException if more than one mapper is defined.
*/
public Mapper createMapper() throws BuildException {
@@ -156,6 +158,7 @@ public class Native2Ascii extends MatchingTask {
/**
* A nested filenamemapper
+ *
* @param fileNameMapper the mapper to add
* @since Ant 1.6.3
*/
@@ -165,8 +168,8 @@ public class Native2Ascii extends MatchingTask {
/**
* Adds an implementation specific command-line argument.
- * @return a ImplementationSpecificArgument to be configured
*
+ * @return a ImplementationSpecificArgument to be configured
* @since Ant 1.6.3
*/
public ImplementationSpecificArgument createArg() {
@@ -180,6 +183,7 @@ public class Native2Ascii extends MatchingTask {
* The classpath to use when loading the native2ascii
* implementation if it is not a built-in one.
*
+ * @return Path
* @since Ant 1.8.0
*/
public Path createImplementationClasspath() {
@@ -188,6 +192,8 @@ public class Native2Ascii extends MatchingTask {
/**
* Set the adapter explicitly.
+ *
+ * @param adapter Native2AsciiAdapter
* @since Ant 1.8.0
*/
public void add(Native2AsciiAdapter adapter) {
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/NetRexxC.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/NetRexxC.java b/src/main/org/apache/tools/ant/taskdefs/optional/NetRexxC.java
index c3bd97b..f1fc669 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/NetRexxC.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/NetRexxC.java
@@ -84,16 +84,15 @@ import org.apache.tools.ant.util.FileUtils;
*
* <p>When this task executes, it will recursively scan the srcdir
* looking for NetRexx source files to compile. This task makes its
- * compile decision based on timestamp.
+ * compile decision based on timestamp.</p>
* <p>Before files are compiled they and any other file in the
* srcdir will be copied to the destdir allowing support files to be
* located properly in the classpath. The reason for copying the source files
- * before the compile is that NetRexxC has only two destinations for classfiles:
+ * before the compile is that NetRexxC has only two destinations for classfiles:</p>
* <ol>
* <li>The current directory, and,</li>
* <li>The directory the source is in (see sourcedir option)
* </ol>
- *
*/
public class NetRexxC extends MatchingTask {
@@ -532,7 +531,8 @@ public class NetRexxC extends MatchingTask {
/**
* Tells whether the trailing .keep in nocompile-mode should be removed
* so that the resulting java source really ends on .java.
- * This facilitates the use of the javadoc tool lateron.
+ * This facilitates the use of the javadoc tool later on.
+ * @param removeKeepExtension boolean
*/
public void setRemoveKeepExtension(boolean removeKeepExtension) {
this.removeKeepExtension = removeKeepExtension;
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/PropertyFile.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/PropertyFile.java b/src/main/org/apache/tools/ant/taskdefs/optional/PropertyFile.java
index 32239ce..7ea75e5 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/PropertyFile.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/PropertyFile.java
@@ -55,16 +55,17 @@ import org.apache.tools.ant.util.LayoutPreservingProperties;
* <entry key="product.version.major" type="int" value="5"/>
* <entry key="product.version.minor" type="int" value="0"/>
* <entry key="product.build.major" type="int" value="0" />
- * <entry key="product.build.minor" type="int" operation="+" />
- * <entry key="product.build.date" type="date" value="now" />
+ * <entry key="product.build.minor" type="int" operation="+"/>
+ * <entry key="product.build.date" type="date" value="now"/>
* <entry key="intSet" type="int" operation="=" value="681"/>
* <entry key="intDec" type="int" operation="-"/>
* <entry key="StringEquals" type="string" value="testValue"/>
* </propertyfile>
* </target>
* </pre>
- *
+ * <p>
* The <propertyfile> task must have:
+ * </p>
* <ul>
* <li>file</li>
* </ul>
@@ -76,8 +77,9 @@ import org.apache.tools.ant.util.LayoutPreservingProperties;
* <li>type</li>
* <li>value (the final four being eliminated shortly)</li>
* </ul>
- *
+ * <p>
* The <entry> task must have:
+ * </p>
* <ul>
* <li>key</li>
* </ul>
@@ -89,24 +91,29 @@ import org.apache.tools.ant.util.LayoutPreservingProperties;
* <li>default</li>
* <li>unit</li>
* </ul>
- *
+ * <p>
* If type is unspecified, it defaults to string.
- *
+ * </p>
* Parameter values:
- * <ul>
- * <li>operation:</li>
+ * <dl>
+ * <dt>operation:</dt>
+ * <dd>
* <ul>
* <li>"=" (set -- default)</li>
* <li>"-" (dec)</li>
* <li>"+" (inc)</li>
* </ul>
- * <li>type:</li>
+ * </dd>
+ * <dt>type:</dt>
+ * <dd>
* <ul>
* <li>"int"</li>
* <li>"date"</li>
* <li>"string"</li>
* </ul>
- * <li>value:</li>
+ * </dd>
+ * <dt>value:</dt>
+ * <dd>
* <ul>
* <li>holds the default value, if the property
* was not found in property file</li>
@@ -115,7 +122,8 @@ import org.apache.tools.ant.util.LayoutPreservingProperties;
* date/time and used even if a valid date was
* found in the property file.</li>
* </ul>
- * </ul>
+ * </dd>
+ * </dl>
*
* <p>String property types can only use the "=" operation.
* Int property types can only use the "=", "-" or "+" operations.<p>
@@ -231,6 +239,7 @@ public class PropertyFile extends Task {
/**
* optional flag to use original Java properties (as opposed to
* layout preserving properties)
+ * @param val boolean
*/
public void setJDKProperties(boolean val) {
useJDKProperties = val;
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.java b/src/main/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.java
index afc9a54..e4271ff 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.java
@@ -147,6 +147,7 @@ public class ReplaceRegExp extends Task {
/**
* file for which the regular expression should be replaced;
* required unless a nested fileset is supplied.
+ *
* @param file The file for which the reg exp should be replaced.
*/
public void setFile(File file) {
@@ -156,6 +157,7 @@ public class ReplaceRegExp extends Task {
/**
* the regular expression pattern to match in the file(s);
* required if no nested <regexp> is used
+ *
* @param match the match attribute.
*/
public void setMatch(String match) {
@@ -171,6 +173,7 @@ public class ReplaceRegExp extends Task {
* The substitution pattern to place in the file(s) in place
* of the regular expression.
* Required if no nested <substitution> is used
+ *
* @param replace the replace attribute
*/
@@ -188,15 +191,16 @@ public class ReplaceRegExp extends Task {
* The flags to use when matching the regular expression. For more
* information, consult the Perl5 syntax.
* <ul>
- * <li>g : Global replacement. Replace all occurrences found
- * <li>i : Case Insensitive. Do not consider case in the match
+ * <li>g : Global replacement. Replace all occurrences found</li>
+ * <li>i : Case Insensitive. Do not consider case in the match</li>
* <li>m : Multiline. Treat the string as multiple lines of input,
* using "^" and "$" as the start or end of any line, respectively,
- * rather than start or end of string.
- * <li> s : Singleline. Treat the string as a single line of input, using
+ * rather than start or end of string.</li>
+ * <li>s : Singleline. Treat the string as a single line of input, using
* "." to match any character, including a newline, which normally,
- * it would not match.
- *</ul>
+ * it would not match.</li>
+ * </ul>
+ *
* @param flags the flags attribute
*/
public void setFlags(String flags) {
@@ -235,8 +239,8 @@ public class ReplaceRegExp extends Task {
/**
* Specifies the encoding Ant expects the files to be in -
* defaults to the platforms default encoding.
- * @param encoding the encoding attribute
*
+ * @param encoding the encoding attribute
* @since Ant 1.6
*/
public void setEncoding(String encoding) {
@@ -245,6 +249,7 @@ public class ReplaceRegExp extends Task {
/**
* list files to apply the replacement to
+ *
* @param set the fileset element
*/
public void addFileset(FileSet set) {
@@ -254,6 +259,7 @@ public class ReplaceRegExp extends Task {
/**
* Support arbitrary file system based resource collections.
*
+ * @param rc ResourceCollection
* @since Ant 1.8.0
*/
public void addConfigured(ResourceCollection rc) {
@@ -285,6 +291,7 @@ public class ReplaceRegExp extends Task {
/**
* A substitution pattern. You can use this element to refer to a previously
* defined substitution pattern datatype instance.
+ *
* @return the substitution pattern object to be configured as an element
*/
public Substitution createSubstitution() {
@@ -301,6 +308,7 @@ public class ReplaceRegExp extends Task {
* Whether the file timestamp shall be preserved even if the file
* is modified.
*
+ * @param b boolean
* @since Ant 1.8.0
*/
public void setPreserveLastModified(boolean b) {
@@ -334,7 +342,7 @@ public class ReplaceRegExp extends Task {
}
/**
- * Perform the replacement on a file
+ * Perform the replacement on a file
*
* @param f the file to perform the replacement on
* @param options the regular expressions options
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/Rpm.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/Rpm.java b/src/main/org/apache/tools/ant/taskdefs/optional/Rpm.java
index 7ecf35d..752e599 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/Rpm.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/Rpm.java
@@ -204,7 +204,7 @@ public class Rpm extends Task {
/**
* The directory which will have the expected
- * subdirectories, SPECS, SOURCES, BUILD, SRPMS ; optional.
+ * subdirectories, SPECS, SOURCES, BUILD, SRPMS; optional.
* If this isn't specified,
* the <tt>baseDir</tt> value is used
*
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/SchemaValidate.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/SchemaValidate.java b/src/main/org/apache/tools/ant/taskdefs/optional/SchemaValidate.java
index a5db991..4e1837c 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/SchemaValidate.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/SchemaValidate.java
@@ -225,7 +225,7 @@ public class SchemaValidate extends XMLValidateTask {
//enable schema
setFeature(XmlConstants.FEATURE_NAMESPACES, true);
if (!enableXercesSchemaValidation() && !enableJAXP12SchemaValidation()) {
- //couldnt use the xerces or jaxp calls
+ //could not use xerces or jaxp calls
throw new BuildException(ERROR_NO_XSD_SUPPORT);
}
@@ -295,7 +295,7 @@ public class SchemaValidate extends XMLValidateTask {
try {
getXmlReader().setFeature(feature, value);
} catch (SAXNotRecognizedException e) {
- log("Not recognizied: " + feature, Project.MSG_VERBOSE);
+ log("Not recognized: " + feature, Project.MSG_VERBOSE);
} catch (SAXNotSupportedException e) {
log("Not supported: " + feature, Project.MSG_VERBOSE);
}
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/Script.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/Script.java b/src/main/org/apache/tools/ant/taskdefs/optional/Script.java
index de6bf5a..72b8f87 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/Script.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/Script.java
@@ -72,7 +72,7 @@ public class Script extends Task {
}
/**
- * Load the script from an external file ; optional.
+ * Load the script from an external file; optional.
*
* @param fileName the name of the file containing the script source.
*/
@@ -132,7 +132,7 @@ public class Script extends Task {
}
/**
- * Set the encoding of the script from an external file ; optional.
+ * Set the encoding of the script from an external file; optional.
*
* @param encoding the encoding of the file containing the script source.
* @since Ant 1.10.2
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/TraXLiaison.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/TraXLiaison.java b/src/main/org/apache/tools/ant/taskdefs/optional/TraXLiaison.java
index f5a6717..71c3f00 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/TraXLiaison.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/TraXLiaison.java
@@ -310,7 +310,6 @@ public class TraXLiaison implements XSLTLiaison4, ErrorListener, XSLTLoggerAware
/**
* Create a new transformer based on the liaison settings
- * @throws Exception thrown if there is an error during creation.
* @see #setStylesheet(java.io.File)
* @see #addParam(java.lang.String, java.lang.String)
* @see #setOutputProperty(java.lang.String, java.lang.String)
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java
index 8a25341..a2d1153 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java
@@ -145,10 +145,10 @@ public class XMLValidateTask extends Task {
* Specify the class name of the SAX parser to be used. (optional)
* @param className should be an implementation of SAX2
* <code>org.xml.sax.XMLReader</code> or SAX2 <code>org.xml.sax.Parser</code>.
- * <p> if className is an implementation of
+ * <p>If className is an implementation of
* <code>org.xml.sax.Parser</code>, {@link #setLenient(boolean)},
- * will be ignored.
- * <p> if not set, the default will be used.
+ * will be ignored.</p>
+ * <p>If not set, the default will be used.</p>
* @see org.xml.sax.XMLReader
* @see org.xml.sax.Parser
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCreateTask.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCreateTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCreateTask.java
index a3d2d46..09b39ab 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCreateTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCreateTask.java
@@ -134,22 +134,22 @@ public class CCMCreateTask extends Continuus implements ExecuteStreamHandler {
if (getPlatform() != null) {
cmd.createArgument().setValue(FLAG_PLATFORM);
cmd.createArgument().setValue(getPlatform());
- } // end of if ()
+ }
if (getResolver() != null) {
cmd.createArgument().setValue(FLAG_RESOLVER);
cmd.createArgument().setValue(getResolver());
- } // end of if ()
+ }
if (getSubSystem() != null) {
cmd.createArgument().setValue(FLAG_SUBSYSTEM);
cmd.createArgument().setValue("\"" + getSubSystem() + "\"");
- } // end of if ()
+ }
if (getRelease() != null) {
cmd.createArgument().setValue(FLAG_RELEASE);
cmd.createArgument().setValue(getRelease());
- } // end of if ()
+ }
}
/**
@@ -292,7 +292,7 @@ public class CCMCreateTask extends Continuus implements ExecuteStreamHandler {
String s = reader.readLine();
if (s != null) {
log("err " + s, Project.MSG_DEBUG);
- } // end of if ()
+ }
}
}
@@ -312,15 +312,15 @@ public class CCMCreateTask extends Continuus implements ExecuteStreamHandler {
taskstring = taskstring.substring(0, taskstring.lastIndexOf(' ')).trim();
setTask(taskstring);
log("task is " + getTask(), Project.MSG_DEBUG);
- } // end of if ()
+ }
} catch (NullPointerException npe) {
- log("error procession stream , null pointer exception", Project.MSG_ERR);
+ log("error procession stream, null pointer exception", Project.MSG_ERR);
log(StringUtils.getStackTrace(npe), Project.MSG_ERR);
throw new BuildException(npe);
} catch (Exception e) {
log("error procession stream " + e.getMessage(), Project.MSG_ERR);
throw new BuildException(e.getMessage());
- } // end of try-catch
+ }
}
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMReconfigure.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMReconfigure.java b/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMReconfigure.java
index a45f8bf..15ce99b 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMReconfigure.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMReconfigure.java
@@ -87,11 +87,11 @@ public class CCMReconfigure extends Continuus {
if (isRecurse()) {
cmd.createArgument().setValue(FLAG_RECURSE);
- } // end of if ()
+ }
if (isVerbose()) {
cmd.createArgument().setValue(FLAG_VERBOSE);
- } // end of if ()
+ }
if (getCcmProject() != null) {
cmd.createArgument().setValue(FLAG_PROJECT);
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckin.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckin.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckin.java
index 3e65848..8d2c66c 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckin.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckin.java
@@ -29,6 +29,7 @@ import org.apache.tools.ant.types.Commandline;
* <p>
* The following attributes are interpreted:
* <table border="1">
+ * <caption>Task attributes</caption>
* <tr>
* <th>Attribute</th>
* <th>Values</th>
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.java
index afcdcbc..795a098 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.java
@@ -30,6 +30,7 @@ import org.apache.tools.ant.types.Commandline;
* <p>
* The following attributes are interpreted:
* <table border="1">
+ * <caption>Task attributes</caption>
* <tr>
* <th>Attribute</th>
* <th>Values</th>
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCLock.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCLock.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCLock.java
index c2e36e9..6e6cb0d 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCLock.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCLock.java
@@ -37,6 +37,7 @@ import org.apache.tools.ant.types.Commandline;
* <p>
* The following attributes are interpreted:
* <table border="1">
+ * <caption>Task attributes</caption>
* <tr>
* <th>Attribute</th>
* <th>Values</th>
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkattr.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkattr.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkattr.java
index c428af0..b83e162 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkattr.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkattr.java
@@ -29,6 +29,7 @@ import org.apache.tools.ant.types.Commandline;
* <p>
* The following attributes are interpreted:
* <table border="1">
+ * <caption>Task attributes</caption>
* <tr>
* <th>Attribute</th>
* <th>Values</th>
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkbl.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkbl.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkbl.java
index 94cb5a1..bd597b1 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkbl.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkbl.java
@@ -28,6 +28,7 @@ import org.apache.tools.ant.types.Commandline;
* <p>
* The following attributes are interpreted:
* <table border="1">
+ * <caption>Task attributes</caption>
* <tr>
* <th>Attribute</th>
* <th>Values</th>
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkdir.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkdir.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkdir.java
index 09af65e..c37e82c 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkdir.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkdir.java
@@ -29,6 +29,7 @@ import org.apache.tools.ant.types.Commandline;
* <p>
* The following attributes are interpreted:
* <table border="1">
+ * <caption>Task attributes</caption>
* <tr>
* <th>Attribute</th>
* <th>Values</th>
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkelem.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkelem.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkelem.java
index 72a736a..bdab620 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkelem.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkelem.java
@@ -29,6 +29,7 @@ import org.apache.tools.ant.types.Commandline;
* <p>
* The following attributes are interpreted:
* <table border="1">
+ * <caption>Task attributes</caption>
* <tr>
* <th>Attribute</th>
* <th>Values</th>
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklabel.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklabel.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklabel.java
index c75dc6d..d873e90 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklabel.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklabel.java
@@ -28,6 +28,7 @@ import org.apache.tools.ant.types.Commandline;
* <p>
* The following attributes are interpreted:
* <table border="1">
+ * <caption>Task attributes</caption>
* <tr>
* <th>Attribute</th>
* <th>Values</th>
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklbtype.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklbtype.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklbtype.java
index 87e2137..eb07458 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklbtype.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklbtype.java
@@ -28,6 +28,7 @@ import org.apache.tools.ant.types.Commandline;
* <p>
* The following attributes are interpreted:
* <table border="1">
+ * <caption>Task attributes</caption>
* <tr>
* <th>Attribute</th>
* <th>Values</th>
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCRmtype.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCRmtype.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCRmtype.java
index c699de1..1cf0804 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCRmtype.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCRmtype.java
@@ -28,6 +28,7 @@ import org.apache.tools.ant.types.Commandline;
* <p>
* The following attributes are interpreted:
* <table border="1">
+ * <caption>Task attributes</caption>
* <tr>
* <th>Attribute</th>
* <th>Values</th>
@@ -41,7 +42,7 @@ import org.apache.tools.ant.types.Commandline;
* eltype element type<br>
* hltype hyperlink type<br>
* lbtype label type<br>
- * trtype trigger type<br>
+ * trtype trigger type
* </td>
* <td>Yes</td>
* <tr>
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnCheckout.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnCheckout.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnCheckout.java
index 266c098..b7ee573 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnCheckout.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnCheckout.java
@@ -29,6 +29,7 @@ import org.apache.tools.ant.types.Commandline;
* <p>
* The following attributes are interpreted:
* <table border="1">
+ * <caption>Task attributes</caption>
* <tr>
* <th>Attribute</th>
* <th>Values</th>
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnlock.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnlock.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnlock.java
index dbb5f12..4da01f6 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnlock.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnlock.java
@@ -36,6 +36,7 @@ import org.apache.tools.ant.types.Commandline;
* <p>
* The following attributes are interpreted:
* <table border="1">
+ * <caption>Task attributes</caption>
* <tr>
* <th>Attribute</th>
* <th>Values</th>
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUpdate.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUpdate.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUpdate.java
index 96afe8d..6fd91f4 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUpdate.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUpdate.java
@@ -29,6 +29,7 @@ import org.apache.tools.ant.types.Commandline;
* <p>
* The following attributes are interpreted:
* <table border="1">
+ * <caption>Task attributes</caption>
* <tr>
* <th>Attribute</th>
* <th>Values</th>
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/depend/Depend.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/depend/Depend.java b/src/main/org/apache/tools/ant/taskdefs/optional/depend/Depend.java
index cb3da26..3b6d341 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/depend/Depend.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/depend/Depend.java
@@ -510,7 +510,7 @@ public class Depend extends MatchingTask {
* warn when a class is out of date, but not deleted as its source is unknown.
* MSG_WARN is the normal level, but we downgrade to MSG_VERBOSE for RMI files
* if {@link #warnOnRmiStubs is false}
- * @param affectedClassInfo info about the affectd class
+ * @param affectedClassInfo info about the affected class
* @param affectedClass the name of the affected .class file
* @param className the file that is triggering the out of dateness
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/depend/DirectoryIterator.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/depend/DirectoryIterator.java b/src/main/org/apache/tools/ant/taskdefs/optional/depend/DirectoryIterator.java
index 7137918..98c91a9 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/depend/DirectoryIterator.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/depend/DirectoryIterator.java
@@ -19,14 +19,14 @@ package org.apache.tools.ant.taskdefs.optional.depend;
import java.io.File;
import java.io.IOException;
+import java.io.InputStream;
+import java.nio.file.Files;
import java.util.ArrayDeque;
import java.util.Arrays;
import java.util.Collections;
import java.util.Deque;
import java.util.Iterator;
import java.util.List;
-import java.io.InputStream;
-import java.nio.file.Files;
/**
* An iterator which iterates through the contents of a java directory. The
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/depend/constantpool/InterfaceMethodRefCPInfo.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/depend/constantpool/InterfaceMethodRefCPInfo.java b/src/main/org/apache/tools/ant/taskdefs/optional/depend/constantpool/InterfaceMethodRefCPInfo.java
index 4f7246c..5a3ba0f 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/depend/constantpool/InterfaceMethodRefCPInfo.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/depend/constantpool/InterfaceMethodRefCPInfo.java
@@ -99,7 +99,7 @@ public class InterfaceMethodRefCPInfo extends ConstantPoolEntry {
return "InterfaceMethod : Class = " + interfaceMethodClassName
+ ", name = " + interfaceMethodName + ", type = "
+ interfaceMethodType;
- }
+ }
return "InterfaceMethod : Class index = " + classIndex
+ ", name and type index = " + nameAndTypeIndex;
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/depend/constantpool/MethodHandleCPInfo.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/depend/constantpool/MethodHandleCPInfo.java b/src/main/org/apache/tools/ant/taskdefs/optional/depend/constantpool/MethodHandleCPInfo.java
index e304d41..f8fbbdb 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/depend/constantpool/MethodHandleCPInfo.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/depend/constantpool/MethodHandleCPInfo.java
@@ -29,7 +29,7 @@ public class MethodHandleCPInfo extends ConstantPoolEntry {
/** reference kind **/
private ReferenceKind referenceKind;
- /** Must be a valid index into the constant pool tabel. */
+ /** Must be a valid index into the constant pool table. */
private int referenceIndex;
/**
* the index into the constant pool which defined the name and type
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.java
index 948da53..672a094 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.java
@@ -198,7 +198,7 @@ public class EjbJar extends MatchingTask {
* Stores a handle to the directory to put the Jar files in. This is
* only used by the generic deployment descriptor tool which is created
* if no other deployment descriptor tools are provided. Normally each
- * deployment tool will specify the desitination dir itself.
+ * deployment tool will specify the destination dir itself.
*/
private File destDir;
@@ -482,11 +482,11 @@ public class EjbJar extends MatchingTask {
/**
* Sets the CMP version.
+ * Must be either <code>1.0</code> or <code>2.0</code>.
+ * Default is <code>1.0</code>.
+ * Initially, only the JBoss implementation does something specific for CMP 2.0.
*
* @param version CMP version.
- * Must be either <code>1.0</code> or <code>2.0</code>.<br/>
- * Default is <code>1.0</code>.<br/>
- * Initially, only the JBoss implementation does something specific for CMP 2.0.<br/>
* @since ant 1.6
*/
public void setCmpversion(CMPVersion version) {
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.java
index d25e3c3..bff47e9 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.java
@@ -385,7 +385,7 @@ public class GenericDeploymentTool implements EJBDeploymentTool {
try {
handler = getDescriptorHandler(config.srcDir);
- // Retrive the files to be added to JAR from EJB descriptor
+ // Retreive the files to be added to JAR from EJB descriptor
Hashtable<String, File> ejbFiles = parseEjbFiles(descriptorFileName, saxParser);
// Add any support classes specified in the build file
@@ -616,7 +616,7 @@ public class GenericDeploymentTool implements EJBDeploymentTool {
/**
* Add any vendor specific files which should be included in the
* EJB Jar.
- * @param ejbFiles a hashtable entryname -> file.
+ * @param ejbFiles a hashtable entryname -> file.
* @param ddPrefix a prefix to use.
*/
protected void addVendorFiles(Hashtable<String, File> ejbFiles, String ddPrefix) {
@@ -626,7 +626,9 @@ public class GenericDeploymentTool implements EJBDeploymentTool {
/**
* Get the vendor specific name of the Jar that will be output. The modification date
* of this jar will be checked against the dependent bean classes.
+ *
* @param baseName the basename to use.
+ * @return File
*/
File getVendorOutputJarFile(String baseName) {
return new File(destDir, baseName + genericJarSuffix);
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.java
index 181720f..fd7517f 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.java
@@ -35,9 +35,8 @@ import org.xml.sax.SAXException;
* <code>ejbjar</code> task. If only stubs and skeletons need to be generated
* (in other words, if no JAR file needs to be created), refer to the
* <code>iplanet-ejbc</code> task and the <code>IPlanetEjbcTask</code> class.
- * <p>
- * The following attributes may be specified by the user:
- * <ul>
+ * <p>The following attributes may be specified by the user:</p>
+ * <ul>
* <li><i>destdir</i> -- The base directory into which the generated JAR
* files will be written. Each JAR file is written
* in directories which correspond to their location
@@ -72,15 +71,14 @@ import org.xml.sax.SAXException;
* <li><i>suffix</i> -- String value appended to the JAR filename when
* creating each JAR. This attribute is not required
* (if omitted, it defaults to ".jar").
- * </ul>
- * <p>
- * For each EJB descriptor found in the "ejbjar" parent task, this deployment
+ * </ul>
+ * <p>For each EJB descriptor found in the "ejbjar" parent task, this deployment
* tool will locate the three classes that comprise the EJB. If these class
* files cannot be located in the specified <code>srcdir</code> directory, the
* task will fail. The task will also attempt to locate the EJB stubs and
* skeletons in this directory. If found, the timestamps on the stubs and
* skeletons will be checked to ensure they are up to date. Only if these files
- * cannot be found or if they are out of date will ejbc be called.
+ * cannot be found or if they are out of date will ejbc be called.</p>
*
* @see IPlanetEjbc
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.java
index c15a07a..3e1f21e 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.java
@@ -57,16 +57,14 @@ import org.apache.tools.ant.util.StringUtils;
* and skeletons in the specified destination directory. Only if the stubs and
* skeletons cannot be found or if they're out of date will the iPlanet
* Application Server ejbc utility be run.
- * <p>
- * Because this class (and it's assorted inner classes) may be bundled into the
+ * <p>Because this class (and it's assorted inner classes) may be bundled into the
* iPlanet Application Server distribution at some point (and removed from the
* Ant distribution), the class has been written to be independent of all
* Ant-specific classes. It is also for this reason (and to avoid cluttering
* the Apache Ant source files) that this utility has been packaged into a
- * single source file.
- * <p>
- * For more information on Ant Tasks for iPlanet Application Server, see the
- * <code>IPlanetDeploymentTool</code> and <code>IPlanetEjbcTask</code> classes.
+ * single source file.</p>
+ * <p>For more information on Ant Tasks for iPlanet Application Server, see the
+ * <code>IPlanetDeploymentTool</code> and <code>IPlanetEjbcTask</code> classes.</p>
*
* @see IPlanetDeploymentTool
* @see IPlanetEjbcTask
@@ -318,15 +316,12 @@ public class IPlanetEjbc {
} catch (IOException e) {
System.out.println("An IOException has occurred while reading the "
+ "XML descriptors (" + e.getMessage() + ").");
- return;
} catch (SAXException e) {
System.out.println("A SAXException has occurred while reading the "
+ "XML descriptors (" + e.getMessage() + ").");
- return;
} catch (IPlanetEjbc.EjbcException e) {
System.out.println("An error has occurred while executing the ejbc "
+ "utility (" + e.getMessage() + ").");
- return;
}
}
@@ -398,7 +393,7 @@ public class IPlanetEjbc {
private void callEjbc(String[] arguments) {
- /* If an iAS home directory is specified, prepend it to the commmand */
+ /* If an iAS home directory is specified, prepend it to the command */
String command;
if (iasHomeDir == null) {
command = "";
@@ -1060,7 +1055,8 @@ public class IPlanetEjbc {
if (hasession && (!beantype.equals(STATEFUL_SESSION))) {
System.out.println(
- "Highly available stubs and skeletons may only be generated for a Stateful Session Bean -- the \"hasession\" attribute will be ignored for the "
+ "Highly available stubs and skeletons may only be generated for a Stateful Session Bean"
+ + "-- the \"hasession\" attribute will be ignored for the "
+ name + " EJB.");
}
@@ -1106,12 +1102,9 @@ public class IPlanetEjbc {
* implementation) and returns the modification timestamp for the
* "oldest" class.
*
- * @param classpath The classpath to be used to find the source EJB
- * classes. If <code>null</code>, the system classpath
- * is used.
+ * @param buildDir The directory to be used to find the source EJB
+ * classes.
* @return The modification timestamp for the "oldest" EJB source class.
- * @throws BuildException If one of the EJB source classes cannot be
- * found on the classpath.
*/
private long sourceClassesModified(File buildDir) {
long latestModified; // The timestamp of the "newest" class
@@ -1198,16 +1191,14 @@ public class IPlanetEjbc {
/**
* Examines each of the EJB stubs and skeletons in the destination
* directory and returns the modification timestamp for the "oldest"
- * class. If one of the stubs or skeletons cannot be found, <code>-1
- * </code> is returned.
+ * class. If one of the stubs or skeletons cannot be found,
+ * <code>-1</code> is returned.
*
- * @param dest The directory in which the EJB stubs and skeletons are
+ * @param destDir The directory in which the EJB stubs and skeletons are
* stored.
* @return The modification timestamp for the "oldest" EJB stub or
- * skeleton. If one of the classes cannot be found, <code>-1
- * </code> is returned.
- * @throws BuildException If the canonical path of the destination
- * directory cannot be found.
+ * skeleton. If one of the classes cannot be found,
+ * <code>-1</code> is returned.
*/
private long destClassesModified(File destDir) {
String[] classnames = classesToGenerate(); // List of all stubs & skels
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/ejb/JbossDeploymentTool.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/JbossDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/JbossDeploymentTool.java
index c3a48ec..8951292 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/JbossDeploymentTool.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/JbossDeploymentTool.java
@@ -75,7 +75,6 @@ public class JbossDeploymentTool extends GenericDeploymentTool {
} else {
log("Unable to locate jboss cmp descriptor. It was expected to be in "
+ jbossCMPD.getPath(), Project.MSG_VERBOSE);
- return;
}
}
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/ejb/OrionDeploymentTool.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/OrionDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/OrionDeploymentTool.java
index 38e2ae3..03db7c5 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/OrionDeploymentTool.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/OrionDeploymentTool.java
@@ -35,13 +35,15 @@ public class OrionDeploymentTool extends GenericDeploymentTool {
protected static final String ORION_DD = "orion-ejb-jar.xml";
-
/** Instance variable that stores the suffix for the jboss jarfile. */
private String jarSuffix = ".jar";
/**
* Add any vendor specific files which should be included in the
* EJB Jar.
+ *
+ * @param ejbFiles Hashtable<String, File>
+ * @param baseName String
*/
protected void addVendorFiles(Hashtable ejbFiles, String baseName) {
String ddPrefix = (usingBaseJarName() ? "" : baseName );
@@ -51,7 +53,6 @@ public class OrionDeploymentTool extends GenericDeploymentTool {
ejbFiles.put(META_DIR + ORION_DD, orionDD);
} else {
log("Unable to locate Orion deployment descriptor. It was expected to be in " + orionDD.getPath(), Project.MSG_WARN);
- return;
}
}
@@ -59,6 +60,8 @@ public class OrionDeploymentTool extends GenericDeploymentTool {
/**
* Get the vendor specific name of the Jar that will be output. The modification date
* of this jar will be checked against the dependent bean classes.
+ *
+ * @param baseName String
*/
File getVendorOutputJarFile(String baseName) {
return new File(getDestDir(), baseName + jarSuffix);
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WebsphereDeploymentTool.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WebsphereDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WebsphereDeploymentTool.java
index 6acdc47..2ea7279 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WebsphereDeploymentTool.java
+++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WebsphereDeploymentTool.java
@@ -156,7 +156,7 @@ public class WebsphereDeploymentTool extends GenericDeploymentTool {
this.wasClasspath = wasClasspath;
}
- /** Sets the DB Vendor for the Entity Bean mapping ; optional.
+ /** Sets the DB Vendor for the Entity Bean mapping; optional.
* <p>
* Valid options can be obtained by running the following command:
* <code>
@@ -258,7 +258,7 @@ public class WebsphereDeploymentTool extends GenericDeploymentTool {
}
/**
- * Flag to use the WebSphere 3.5 compatible mapping rules ; optional, default false.
+ * Flag to use the WebSphere 3.5 compatible mapping rules; optional, default false.
*
* @param attr a <code>boolean</code> value.
*/
@@ -381,7 +381,7 @@ public class WebsphereDeploymentTool extends GenericDeploymentTool {
/**
* Add any vendor specific files which should be included in the EJB Jar.
- * @param ejbFiles a hashtable entryname -> file.
+ * @param ejbFiles a hashtable entryname -> file.
* @param baseName a prefix to use.
*/
@Override
@@ -441,7 +441,7 @@ public class WebsphereDeploymentTool extends GenericDeploymentTool {
log("Unable to locate the websphere Schema: "
+ websphereSchema.getPath(), Project.MSG_VERBOSE);
}
- // Theres nothing else to see here...keep moving sonny
+ // There is nothing else to see here...keep moving sonny
} catch (Exception e) {
throw new BuildException(
"Exception while adding Vendor specific files: "