diff --git a/src/main/org/apache/tools/ant/Main.java b/src/main/org/apache/tools/ant/Main.java index 01003bd5f..66938daf3 100644 --- a/src/main/org/apache/tools/ant/Main.java +++ b/src/main/org/apache/tools/ant/Main.java @@ -140,7 +140,7 @@ public class Main { private boolean projectHelp = false; /** - * Is a logfile being used? This is used to + * Whether or not a logfile is being used. This is used to * check if the output streams must be closed. */ private static boolean isLogFileUsed = false; diff --git a/src/main/org/apache/tools/ant/filters/StripJavaComments.java b/src/main/org/apache/tools/ant/filters/StripJavaComments.java index 3dbe46efc..2c98b55f3 100644 --- a/src/main/org/apache/tools/ant/filters/StripJavaComments.java +++ b/src/main/org/apache/tools/ant/filters/StripJavaComments.java @@ -69,7 +69,8 @@ public final class StripJavaComments /** * The read-ahead character, used for effectively pushing a single - * character back. -1 indicates that no character is in the buffer. + * character back. A value of -1 indicates that no character is in the + * buffer. */ private int readAheadCh = -1; diff --git a/src/main/org/apache/tools/ant/taskdefs/Concat.java b/src/main/org/apache/tools/ant/taskdefs/Concat.java index 4ee98cb00..a33400419 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Concat.java +++ b/src/main/org/apache/tools/ant/taskdefs/Concat.java @@ -109,7 +109,8 @@ public class Concat extends Task { private File destinationFile = null; /** - * If the destination file exists, should the stream be appended? + * Whether or not the stream should be appended if the destination file + * exists. * Defaults to false. */ private boolean append = false; diff --git a/src/main/org/apache/tools/ant/taskdefs/Definer.java b/src/main/org/apache/tools/ant/taskdefs/Definer.java index 3b13aa4ba..c5b8aa023 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Definer.java +++ b/src/main/org/apache/tools/ant/taskdefs/Definer.java @@ -319,14 +319,15 @@ public abstract class Definer extends Task { } /** - * what is the classname we are definining? Can be null + * Returns the classname of the object we are defining. + * May be null. */ public String getClassname() { return value; } /** - * the full class name of the object being defined. + * The full class name of the object being defined. * Required, unless file or resource have * been specified. */ @@ -335,8 +336,8 @@ public abstract class Definer extends Task { } /** - * this must be implemented by subclasses; it is the callback - * they will get to add a new definition of their type + * This must be implemented by subclasses; it is the callback + * they will get to add a new definition of their type. */ protected abstract void addDefinition(String name, Class c); } diff --git a/src/main/org/apache/tools/ant/taskdefs/PathConvert.java b/src/main/org/apache/tools/ant/taskdefs/PathConvert.java index 950b0587d..9d05f9613 100644 --- a/src/main/org/apache/tools/ant/taskdefs/PathConvert.java +++ b/src/main/org/apache/tools/ant/taskdefs/PathConvert.java @@ -237,11 +237,12 @@ public class PathConvert extends Task { /** * Set targetos to a platform to one of - * "windows", "unix", "netware", or "os/2"; required unless - * unless pathsep and/or dirsep are specified. + * "windows", "unix", "netware", or "os/2". + * + * Required unless unless pathsep and/or dirsep are specified. * * @deprecated use the method taking a TargetOs argument instead - * @see #setTargetos(TargetOs) + * @see #setTargetos(PathConvert.TargetOs) */ public void setTargetos(String target) { TargetOs to = new TargetOs(); diff --git a/src/main/org/apache/tools/ant/taskdefs/Replace.java b/src/main/org/apache/tools/ant/taskdefs/Replace.java index cfffe13d2..6c99d33aa 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Replace.java +++ b/src/main/org/apache/tools/ant/taskdefs/Replace.java @@ -183,8 +183,7 @@ public class Replace extends MatchingTask { } /** - * get the replacement value for this filter token - * @return + * Get the replacement value for this filter token. */ public String getReplaceValue() { if (property != null) { diff --git a/src/main/org/apache/tools/ant/taskdefs/Rmic.java b/src/main/org/apache/tools/ant/taskdefs/Rmic.java index 7b120876f..8c5165ce7 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Rmic.java +++ b/src/main/org/apache/tools/ant/taskdefs/Rmic.java @@ -102,7 +102,7 @@ import java.util.Vector; * * @@ -363,9 +363,9 @@ public class Rmic extends MatchingTask { } /** - * Include ant's own classpath in this task's classpath? - * sets whether to include the Ant run-time libraries; - * optional defaults to true. + * Sets whether or not to include ant's own classpath in this task's + * classpath. + * Optional; default is true. */ public void setIncludeantruntime(boolean include) { includeAntRuntime = include; diff --git a/src/main/org/apache/tools/ant/taskdefs/SQLExec.java b/src/main/org/apache/tools/ant/taskdefs/SQLExec.java index 17493dedd..0c5d32101 100644 --- a/src/main/org/apache/tools/ant/taskdefs/SQLExec.java +++ b/src/main/org/apache/tools/ant/taskdefs/SQLExec.java @@ -247,8 +247,8 @@ public class SQLExec extends JDBCTask { } /** - * Set the delimiter that separates SQL statements; - * optional, default ";" + * Sets the delimiter that separates SQL statements. + * Optional, defaults to ";". * *

For example, set this to "go" and delimitertype to "ROW" for * Sybase ASE or MS SQL Server.

diff --git a/src/main/org/apache/tools/ant/taskdefs/TempFile.java b/src/main/org/apache/tools/ant/taskdefs/TempFile.java index c79294e5f..a39b6b998 100644 --- a/src/main/org/apache/tools/ant/taskdefs/TempFile.java +++ b/src/main/org/apache/tools/ant/taskdefs/TempFile.java @@ -80,30 +80,30 @@ import org.apache.tools.ant.util.FileUtils; public class TempFile extends Task { /** - * name of property to set + * Name of property to set. */ private String property; /** - * directory to create the file in. can be null + * Directory to create the file in. Can be null. */ private File destDir = null; /** - * prefix for the file + * Prefix for the file. */ private String prefix; /** - * suffix for the file + * Suffix for the file. */ private String suffix = ""; /** - * The property you wish to assign the temporary file to + * Sets the property you wish to assign the temporary file to. * - *@param property The property to set + * @param property The property to set */ public void setProperty(String property) { this.property = property; @@ -111,10 +111,10 @@ public class TempFile extends Task { /** - * destination directory. If null, - the parent directory is used instead + * Sets the destination directory. If null, + * the parent directory is used instead. * - *@param destDir The new destDir value + * @param destDir The new destDir value */ public void setDestDir(File destDir) { this.destDir = destDir; @@ -122,9 +122,9 @@ public class TempFile extends Task { /** - * optional prefix string + * Sets the optional prefix string. * - *@param prefix string to prepend to generated string + * @param prefix string to prepend to generated string */ public void setPrefix(String prefix) { this.prefix = prefix; @@ -132,9 +132,9 @@ public class TempFile extends Task { /** - * Suffix string for the temp file (optional) + * Sets the suffix string for the temp file (optional) * - *@param suffix suffix including any "." , e.g ".xml" + * @param suffix suffix including any "." , e.g ".xml" */ public void setSuffix(String suffix) { this.suffix = suffix; @@ -142,7 +142,7 @@ public class TempFile extends Task { /** - * create the temp file + * Creates the temporary file. * *@exception BuildException if something goes wrong with the build */ diff --git a/src/main/org/apache/tools/ant/taskdefs/XSLTProcess.java b/src/main/org/apache/tools/ant/taskdefs/XSLTProcess.java index eeb6295e6..b43b0f7d3 100644 --- a/src/main/org/apache/tools/ant/taskdefs/XSLTProcess.java +++ b/src/main/org/apache/tools/ant/taskdefs/XSLTProcess.java @@ -734,8 +734,8 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger { } /** - * Specific configuration for the TRaX liaison... support for - * all other has been dropped so this liaison will soon look + * Specific configuration for the TRaX liaison. Support for + * all others has been dropped so this liaison will soon look * like the exact copy of JAXP interface.. * @param liaison the TRaXLiaison to configure. */ 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 699540ce5..5db08e29e 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java @@ -121,10 +121,11 @@ public class XMLValidateTask extends Task { private XMLCatalog xmlCatalog = new XMLCatalog(); /** - * Specify how parser error are to be handled; - * optional, default=true + * Specify how parser error are to be handled. + * Optional, default is true. *

- * If set to true (default), throw a buildException if the parser yields an error. + * If set to true (default), throw a buildException if the + * parser yields an error. */ public void setFailOnError(boolean fail) { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/WsdlToDotnet.java b/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/WsdlToDotnet.java index 6f4e59465..43c301fa8 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/WsdlToDotnet.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/WsdlToDotnet.java @@ -165,7 +165,8 @@ public class WsdlToDotnet extends Task { } /** - * Should failure halt the build? optional, default=true + * Whether or not a failure should halt the build. + * Optional - default is true. * @param failOnError new failure option */ public void setFailOnError(boolean failOnError) { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/JonasDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/JonasDeploymentTool.java index d533804db..212fb81a3 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/JonasDeploymentTool.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/JonasDeploymentTool.java @@ -179,7 +179,7 @@ public class JonasDeploymentTool extends GenericDeploymentTool { private String rmicopts; /** - * true if the RMI Skel. and Stub. must be modified to + * Whether or not the RMI skeleton and stub must be modified to * implement the implicit propagation of the security context (the * transactional context is always provided). The default is * false. @@ -329,7 +329,7 @@ public class JonasDeploymentTool extends GenericDeploymentTool { } /** - * Set the {@link #jarsuffix}. + * Set the {@link #suffix jar suffix}. * * @param aString the string to use as the suffix. */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java index 37389641e..7d196bc39 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java @@ -210,7 +210,8 @@ public class JspC extends MatchingTask { /* ------------------------------------------------------------ */ /** - * should the build halt if compilation fails? default=true + * Whether or not the build should halt if compilation fails. + * Defaults to true. */ public void setFailonerror(boolean fail) { failOnError = fail; diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/net/SetProxy.java b/src/main/org/apache/tools/ant/taskdefs/optional/net/SetProxy.java index d4f98d54b..e7b0b3381 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/net/SetProxy.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/net/SetProxy.java @@ -108,7 +108,7 @@ public class SetProxy extends Task { private String socksProxyHost = null; /** - * socks proxy port. 1080 is the default + * Socks proxy port. Default is 1080. */ private int socksProxyPort = 1080; diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.java index f5e16729d..e07992521 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.java @@ -268,7 +268,8 @@ public class TelnetTask extends Task { } /** - * should the message be echoed to the log? default=true. + * Whether or not the message should be echoed to the log. + * Defaults to true. */ public void setEcho(boolean b) { echoString = b; diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOS.java b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOS.java index e61d80683..12d1b7f12 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOS.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOS.java @@ -202,8 +202,9 @@ public abstract class SOS extends Task { /** - * Set the address and port of SourceOffSite Server, - * eg. 192.168.0.1:8888 ; required. + * Sets the address and port of SourceOffSite Server, + * for example 192.168.0.1:8888. + * This attribute is required. * * @param sosServerPath The new sosServerPath value */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.java b/src/main/org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.java index bf7864631..21668b502 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.java @@ -112,8 +112,8 @@ public class StarTeamCheckout extends TreeBasedTask { } /** - * Should all all local files not in StarTeam be deleted? - * Optional, defaults to "true". + * Whether or not all local files not in StarTeam should be deleted. + * Optional, defaults to true. * @param value the value to set the attribute to. */ public void setDeleteUncontrolled(boolean value) { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java index 4b588a73d..5eebc788b 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java @@ -136,14 +136,16 @@ public class MSVSSADD extends MSVSS { } /** - * Leave added files writable? Default: false. + * Whether or not to leave added files writable. + * Default is false. */ public final void setWritable(boolean argWritable) { m_Writable = argWritable; } /** - * @return the 'make writable' command if the attribute was 'true', otherwise an empty string + * The 'make writable' command if the attribute was true, + * otherwise an empty string. */ public void getWritableCommand(Commandline cmd) { if (!m_Writable) { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKIN.java b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKIN.java index c426f0911..214c236f9 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKIN.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKIN.java @@ -175,14 +175,16 @@ public class MSVSSCHECKIN extends MSVSS { } /** - * Leave checked in files writable? Default: false. + * Whether or not to leave checked in files writable. + * Default is false. */ public final void setWritable(boolean argWritable) { m_Writable = argWritable; } /** - * the 'make writable' command if the attribute was 'true', otherwise an empty string + * The 'make writable' command if the attribute was true, + * otherwise an empty string. */ public void getWritableCommand(Commandline cmd) { if (!m_Writable) { diff --git a/src/main/org/apache/tools/ant/util/CollectionUtils.java b/src/main/org/apache/tools/ant/util/CollectionUtils.java index f8ebc2546..54d97407e 100644 --- a/src/main/org/apache/tools/ant/util/CollectionUtils.java +++ b/src/main/org/apache/tools/ant/util/CollectionUtils.java @@ -100,7 +100,7 @@ public class CollectionUtils { } /** - * Hashtable.equals() doesn't do any good in 1.1 + * Hashtable.equals() doesn't do any good in 1.1. * *

Follows the equals contract of Java 2's Map.

* diff --git a/src/main/org/apache/tools/ant/util/JavaEnvUtils.java b/src/main/org/apache/tools/ant/util/JavaEnvUtils.java index 16883c7a1..343208d56 100644 --- a/src/main/org/apache/tools/ant/util/JavaEnvUtils.java +++ b/src/main/org/apache/tools/ant/util/JavaEnvUtils.java @@ -311,8 +311,7 @@ public class JavaEnvUtils { } /** - * testing helper method; kept here for unification of changes. - * @return + * Testing helper method; kept here for unification of changes. */ public static Vector getJrePackageTestCases() { Vector tests=new Vector();