This is an automated email from the ASF dual-hosted git repository. jaikiran pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/ant.git
commit f109d2f31d06357211e03e7343adb788bed3d50e Author: twogee <g.grigelio...@gmail.com> AuthorDate: Tue Mar 19 23:47:29 2019 +0100 HTML5-compliant javadoc This closes #88 pull request at github/apache/ant repo --- src/main/org/apache/tools/ant/Diagnostics.java | 6 +- .../apache/tools/ant/TaskConfigurationChecker.java | 4 +- .../apache/tools/ant/taskdefs/ExecuteWatchdog.java | 10 +-- .../apache/tools/ant/taskdefs/ManifestTask.java | 2 +- .../org/apache/tools/ant/taskdefs/Property.java | 2 +- src/main/org/apache/tools/ant/taskdefs/Rmic.java | 2 +- .../org/apache/tools/ant/taskdefs/SignJar.java | 2 +- .../org/apache/tools/ant/taskdefs/Transform.java | 2 +- src/main/org/apache/tools/ant/taskdefs/War.java | 4 +- .../org/apache/tools/ant/taskdefs/XSLTLiaison.java | 2 +- .../org/apache/tools/ant/taskdefs/XSLTProcess.java | 6 +- .../apache/tools/ant/taskdefs/condition/Xor.java | 2 +- .../ant/taskdefs/optional/EchoProperties.java | 14 ++-- .../apache/tools/ant/taskdefs/optional/Rpm.java | 4 +- .../tools/ant/taskdefs/optional/javacc/JJTree.java | 2 +- .../ant/taskdefs/optional/jdepend/JDependTask.java | 14 ++-- .../optional/junit/AggregateTransformer.java | 4 +- .../ant/taskdefs/optional/junit/BaseTest.java | 2 +- .../ant/taskdefs/optional/junit/BatchTest.java | 34 ++++----- .../junit/CustomJUnit4TestAdapterCache.java | 2 +- .../tools/ant/taskdefs/optional/junit/DOMUtil.java | 34 ++++----- .../ant/taskdefs/optional/junit/Enumerations.java | 2 +- .../ant/taskdefs/optional/junit/JUnitTask.java | 34 ++++----- .../ant/taskdefs/optional/junit/XMLConstants.java | 4 +- .../optional/junit/XMLResultAggregator.java | 16 ++--- .../tools/ant/taskdefs/optional/net/FTP.java | 2 +- .../tools/ant/taskdefs/optional/net/FTPTask.java | 2 +- .../tools/ant/taskdefs/optional/net/MimeMail.java | 2 +- .../tools/ant/taskdefs/optional/net/RExecTask.java | 4 +- .../tools/ant/taskdefs/optional/net/SetProxy.java | 4 +- .../ant/taskdefs/optional/net/TelnetTask.java | 4 +- .../ant/taskdefs/optional/splash/SplashTask.java | 2 +- .../apache/tools/ant/types/CommandlineJava.java | 8 +-- .../tools/ant/types/EnumeratedAttribute.java | 2 +- .../org/apache/tools/ant/types/XMLCatalog.java | 4 +- .../modifiedselector/ModifiedSelector.java | 2 +- src/main/org/apache/tools/ant/util/DateUtils.java | 6 +- .../tools/ant/util/KeepAliveInputStream.java | 2 +- .../tools/ant/util/KeepAliveOutputStream.java | 2 +- .../org/apache/tools/ant/util/StringUtils.java | 2 +- .../org/apache/tools/bzip2/CBZip2InputStream.java | 12 ++-- .../org/apache/tools/bzip2/CBZip2OutputStream.java | 82 +++++++++++----------- .../org/apache/tools/zip/GeneralPurposeBit.java | 2 +- src/main/org/apache/tools/zip/ZipLong.java | 2 +- src/main/org/apache/tools/zip/ZipShort.java | 2 +- src/main/org/apache/tools/zip/ZipUtil.java | 2 +- .../junit/org/apache/tools/ant/AntAssert.java | 2 +- .../junit/org/apache/tools/ant/BuildFileRule.java | 2 +- .../junit/org/apache/tools/ant/BuildFileTest.java | 4 +- .../junit/org/apache/tools/ant/FileUtilities.java | 2 +- 50 files changed, 185 insertions(+), 185 deletions(-) diff --git a/src/main/org/apache/tools/ant/Diagnostics.java b/src/main/org/apache/tools/ant/Diagnostics.java index 7434433..6717ae8 100644 --- a/src/main/org/apache/tools/ant/Diagnostics.java +++ b/src/main/org/apache/tools/ant/Diagnostics.java @@ -84,7 +84,7 @@ public final class Diagnostics { /** * Doesn't do anything. * @deprecated Obsolete since Ant 1.8.2 - * @return <tt>true</tt> + * @return <code>true</code> */ @Deprecated public static boolean isOptionalAvailable() { @@ -103,7 +103,7 @@ public final class Diagnostics { * return the list of jar files existing in ANT_HOME/lib * and that must have been picked up by Ant script. * @return the list of jar files existing in ant.home/lib or - * <tt>null</tt> if an error occurs. + * <code>null</code> if an error occurs. */ public static File[] listLibraries() { String home = System.getProperty(MagicNames.ANT_HOME); @@ -467,7 +467,7 @@ public final class Diagnostics { * because Ant requires multiple libraries to compile and one of them * was missing when compiling Ant. * @param out the stream to print the tasks report to - * <tt>null</tt> for a missing stream (ie mapping). + * <code>null</code> for a missing stream (ie mapping). */ private static void doReportTasksAvailability(PrintStream out) { InputStream is = Main.class.getResourceAsStream( diff --git a/src/main/org/apache/tools/ant/TaskConfigurationChecker.java b/src/main/org/apache/tools/ant/TaskConfigurationChecker.java index ce6bcf6..862a8a9 100644 --- a/src/main/org/apache/tools/ant/TaskConfigurationChecker.java +++ b/src/main/org/apache/tools/ant/TaskConfigurationChecker.java @@ -23,8 +23,8 @@ import java.util.List; /** * <p>Helper class for the check of the configuration of a given task. * This class provides methods for making assumptions about the task configuration. - * After collecting all violations with <tt>assert*</tt> and <tt>fail</tt> - * methods the <tt>checkErrors</tt> will throw a BuildException with all collected + * After collecting all violations with <code>assert*</code> and <code>fail</code> + * methods the <code>checkErrors</code> will throw a BuildException with all collected * messages or does nothing if there wasn't any error.</p> * * <p>Example:</p> diff --git a/src/main/org/apache/tools/ant/taskdefs/ExecuteWatchdog.java b/src/main/org/apache/tools/ant/taskdefs/ExecuteWatchdog.java index 4925f54..aecc38c 100644 --- a/src/main/org/apache/tools/ant/taskdefs/ExecuteWatchdog.java +++ b/src/main/org/apache/tools/ant/taskdefs/ExecuteWatchdog.java @@ -82,7 +82,7 @@ public class ExecuteWatchdog implements TimeoutObserver { /** * Watches the given process and terminates it, if it runs for too long. * All information from the previous run are reset. - * @param process the process to monitor. It cannot be <tt>null</tt> + * @param process the process to monitor. It cannot be <code>null</code> * @throws IllegalStateException if a process is still being monitored. */ public synchronized void start(Process process) { @@ -160,8 +160,8 @@ public class ExecuteWatchdog implements TimeoutObserver { /** * Indicates whether or not the watchdog is still monitoring the process. - * @return <tt>true</tt> if the process is still running, otherwise - * <tt>false</tt>. + * @return <code>true</code> if the process is still running, otherwise + * <code>false</code>. */ public boolean isWatching() { return watch; @@ -169,8 +169,8 @@ public class ExecuteWatchdog implements TimeoutObserver { /** * Indicates whether the last process run was killed on timeout or not. - * @return <tt>true</tt> if the process was killed otherwise - * <tt>false</tt>. + * @return <code>true</code> if the process was killed otherwise + * <code>false</code>. */ public boolean killedProcess() { return killedProcess; diff --git a/src/main/org/apache/tools/ant/taskdefs/ManifestTask.java b/src/main/org/apache/tools/ant/taskdefs/ManifestTask.java index a96a84d..94a192a 100644 --- a/src/main/org/apache/tools/ant/taskdefs/ManifestTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/ManifestTask.java @@ -138,7 +138,7 @@ public class ManifestTask extends Task { * alphanum: {A-Z} | {a-z} | {0-9} * headerchar: alphanum | - | _ * </pre> - * So the resulting regexp would be <tt>[A-Za-z0-9][A-Za-z0-9-_]*</tt>. + * So the resulting regexp would be <code>[A-Za-z0-9][A-Za-z0-9-_]*</code>. * * Because of JDK 1.2 compliance and the possible absence of a * regexp matcher we can not use regexps here. Instead we have to diff --git a/src/main/org/apache/tools/ant/taskdefs/Property.java b/src/main/org/apache/tools/ant/taskdefs/Property.java index 34455a0..9cf6c67 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Property.java +++ b/src/main/org/apache/tools/ant/taskdefs/Property.java @@ -601,7 +601,7 @@ public class Property extends Task { * definition. * @param props The property object to load into * @param is The input stream from where to load - * @param isXml <tt>true</tt> if we should try to load from xml + * @param isXml <code>true</code> if we should try to load from xml * @throws IOException if something goes wrong * @since 1.8.0 * @see "http://java.sun.com/dtd/properties.dtd" diff --git a/src/main/org/apache/tools/ant/taskdefs/Rmic.java b/src/main/org/apache/tools/ant/taskdefs/Rmic.java index 55cb8bc..8b31992 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Rmic.java +++ b/src/main/org/apache/tools/ant/taskdefs/Rmic.java @@ -68,7 +68,7 @@ import org.apache.tools.ant.util.facade.FacadeTaskHelper; * * <p>It is possible to use different compilers. This can be selected * with the "build.rmic" property or the <code>compiler</code> - * attribute. <a name="compilervalues">There are three choices</a>:</p> + * attribute. <span id="compilervalues">There are three choices</span>:</p> * * <ul> * <li>sun (the standard compiler of the JDK)</li> diff --git a/src/main/org/apache/tools/ant/taskdefs/SignJar.java b/src/main/org/apache/tools/ant/taskdefs/SignJar.java index 16d6993..4c4d4fb 100644 --- a/src/main/org/apache/tools/ant/taskdefs/SignJar.java +++ b/src/main/org/apache/tools/ant/taskdefs/SignJar.java @@ -36,7 +36,7 @@ import org.apache.tools.ant.util.ResourceUtils; /** * Signs JAR or ZIP files with the javasign command line tool. The tool detailed * dependency checking: files are only signed if they are not signed. The - * <tt>signjar</tt> attribute can point to the file to generate; if this file + * <code>signjar</code> attribute can point to the file to generate; if this file * exists then its modification date is used as a cue as to whether to resign * any JAR file. * diff --git a/src/main/org/apache/tools/ant/taskdefs/Transform.java b/src/main/org/apache/tools/ant/taskdefs/Transform.java index 9fd15d1..44b7e78 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Transform.java +++ b/src/main/org/apache/tools/ant/taskdefs/Transform.java @@ -22,7 +22,7 @@ package org.apache.tools.ant.taskdefs; * Has been merged into ExecuteOn, empty class for backwards compatibility. * We leave that in case that external programs access this class directly, * for example via - * <tt> Transform tr = (Transform) getProject().createTask("apply") </tt> + * <code> Transform tr = (Transform) getProject().createTask("apply") </code> * * @ant.task ignore="true" */ diff --git a/src/main/org/apache/tools/ant/taskdefs/War.java b/src/main/org/apache/tools/ant/taskdefs/War.java index 146d325..5c55798 100644 --- a/src/main/org/apache/tools/ant/taskdefs/War.java +++ b/src/main/org/apache/tools/ant/taskdefs/War.java @@ -72,7 +72,7 @@ public class War extends Jar { /** * <i>Deprecated</i> name of the file to create - * -use <tt>destfile</tt> instead. + * -use <code>destfile</code> instead. * @param warFile the destination file * @deprecated since 1.5.x. * Use setDestFile(File) instead @@ -85,7 +85,7 @@ public class War extends Jar { /** * set the deployment descriptor to use (WEB-INF/web.xml); - * required unless <tt>update=true</tt> + * required unless <code>update=true</code> * @param descr the deployment descriptor file */ public void setWebxml(File descr) { diff --git a/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison.java b/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison.java index 617790a..a3dcfdd 100644 --- a/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison.java +++ b/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison.java @@ -31,7 +31,7 @@ public interface XSLTLiaison { /** * the file protocol prefix for systemid. * This file protocol must be appended to an absolute path. - * Typically: <tt>FILE_PROTOCOL_PREFIX + file.getAbsolutePath()</tt> + * Typically: <code>FILE_PROTOCOL_PREFIX + file.getAbsolutePath()</code> * Note that on Windows, an extra '/' must be appended to the * protocol prefix so that there is always 3 consecutive slashes. * @since Ant 1.4 diff --git a/src/main/org/apache/tools/ant/taskdefs/XSLTProcess.java b/src/main/org/apache/tools/ant/taskdefs/XSLTProcess.java index 4ad419b..fb8baad 100644 --- a/src/main/org/apache/tools/ant/taskdefs/XSLTProcess.java +++ b/src/main/org/apache/tools/ant/taskdefs/XSLTProcess.java @@ -480,7 +480,7 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger { /** * Set the destination directory into which the XSL result * files should be copied to; - * required, unless <tt>in</tt> and <tt>out</tt> are + * required, unless <code>in</code> and <code>out</code> are * specified. * @param dir the name of the destination directory **/ @@ -736,7 +736,7 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger { /** * Specifies the output name for the styled result from the - * <tt>in</tt> attribute; required if <tt>in</tt> is set + * <code>in</code> attribute; required if <code>in</code> is set * * @param outFile the output File instance. */ @@ -746,7 +746,7 @@ public class XSLTProcess extends MatchingTask implements XSLTLogger { /** * specifies a single XML document to be styled. Should be used - * with the <tt>out</tt> attribute; required if <tt>out</tt> is set + * with the <code>out</code> attribute; required if <code>out</code> is set * * @param inFile the input file */ diff --git a/src/main/org/apache/tools/ant/taskdefs/condition/Xor.java b/src/main/org/apache/tools/ant/taskdefs/condition/Xor.java index ec3e213..44bf8c3 100644 --- a/src/main/org/apache/tools/ant/taskdefs/condition/Xor.java +++ b/src/main/org/apache/tools/ant/taskdefs/condition/Xor.java @@ -21,7 +21,7 @@ import org.apache.tools.ant.BuildException; import org.apache.tools.ant.util.StreamUtils; /** - * The <tt>Xor</tt> condition type to exclusive or operations. + * The <code>Xor</code> condition type to exclusive or operations. * This does not shortcut stuff. * @since Ant 1.7 */ 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 256e4db..db60451 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/EchoProperties.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/EchoProperties.java @@ -164,8 +164,8 @@ 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 - * exceptions, or <tt>false</tt> if IO exceptions are ignored. + * @param failonerror <code>true</code> if IO exceptions are reported as build + * exceptions, or <code>false</code> if IO exceptions are ignored. */ public void setFailOnError(boolean failonerror) { this.failonerror = failonerror; @@ -174,7 +174,7 @@ 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>, + * is never set, or it is set to an empty string or <code>null</code>, * then all properties will be recorded. * * <p>For example, if the attribute is set as:</p> @@ -197,7 +197,7 @@ 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 + * or it is set to an empty string or <code>null</code>, then all * properties will be recorded. * * <p>For example, if the attribute is set as:</p> @@ -333,7 +333,7 @@ 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 + * Only those properties matching the <code>prefix</code> constraint will be * sent to the output stream. * The output stream will be closed when this method returns. * @@ -464,8 +464,8 @@ 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. + * <code>Properties.store(OutputStream, String)</code>, which throws an + * <code>IOException</code> on an output error. * * @param props the properties to record * @param os record the properties to this output stream 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 65a934b..a3e4c73 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/Rpm.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/Rpm.java @@ -205,7 +205,7 @@ public class Rpm extends Task { * The directory which will have the expected * subdirectories, SPECS, SOURCES, BUILD, SRPMS; optional. * If this isn't specified, - * the <tt>baseDir</tt> value is used + * the <code>baseDir</code> value is used * * @param td the directory containing the normal RPM directories. */ @@ -253,7 +253,7 @@ public class Rpm extends Task { /** * Flag (optional, default=false) * to remove the sources after the build. - * See the <tt>--rmsource</tt> option of rpmbuild. + * See the <code>--rmsource</code> option of rpmbuild. * @param rs a <code>boolean</code> value. */ public void setRemoveSource(boolean rs) { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.java b/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.java index 1b85f28..9c15afb 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.java @@ -340,7 +340,7 @@ public class JJTree extends Task { * * @param destFile String * @param outputDir String - * @return validation file, relative if possible; <tt>null</tt> if not set + * @return validation file, relative if possible; <code>null</code> if not set * @throws BuildException if something goes wrong */ private String validateOutputFile(String destFile, diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/jdepend/JDependTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/jdepend/JDependTask.java index 09e13f2..54cc3b9 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/jdepend/JDependTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/jdepend/JDependTask.java @@ -162,8 +162,8 @@ public class JDependTask extends Task { /** * If true, forks into a new JVM. Default: false. * - * @param value <tt>true</tt> if a JVM should be forked, - * otherwise <tt>false</tt> + * @param value <code>true</code> if a JVM should be forked, + * otherwise <code>false</code> */ public void setFork(boolean value) { fork = value; @@ -179,8 +179,8 @@ public class JDependTask extends Task { /** * The command used to invoke a forked Java Virtual Machine. * - * Default is <tt>java</tt>. Ignored if no JVM is forked. - * @param value the new VM to use instead of <tt>java</tt> + * Default is <code>java</code>. Ignored if no JVM is forked. + * @param value the new VM to use instead of <code>java</code> * @see #setFork(boolean) */ public void setJvm(String value) { @@ -537,10 +537,10 @@ public class JDependTask extends Task { /** * Execute the task by forking a new JVM. The command will block until * it finishes. To know if the process was destroyed or not, use the - * <tt>killedProcess()</tt> method of the watchdog class. + * <code>killedProcess()</code> method of the watchdog class. * @param commandline the commandline for forked jvm * @param watchdog the watchdog in charge of cancelling the test if it - * exceeds a certain amount of time. Can be <tt>null</tt>. + * exceeds a certain amount of time. Can be <code>null</code>. * @return the result of running the jdepend * @throws BuildException in case of error */ @@ -616,7 +616,7 @@ public class JDependTask extends Task { } /** - * @return <tt>null</tt> if there is a timeout value, otherwise the + * @return <code>null</code> if there is a timeout value, otherwise the * watchdog instance. * @throws BuildException in case of error */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/AggregateTransformer.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/AggregateTransformer.java index c195683..e6e93b3 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/AggregateTransformer.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/AggregateTransformer.java @@ -128,7 +128,7 @@ public class AggregateTransformer { */ private static volatile int counter = 0; - /** the format to use for the report. Must be <tt>FRAMES</tt> or <tt>NOFRAMES</tt> */ + /** the format to use for the report. Must be <code>FRAMES</code> or <code>NOFRAMES</code> */ protected String format = FRAMES; // CheckStyle:VisibilityModifier ON @@ -154,7 +154,7 @@ public class AggregateTransformer { /** * sets the format. - * @param format Must be <tt>FRAMES</tt> or <tt>NOFRAMES</tt> + * @param format Must be <code>FRAMES</code> or <code>NOFRAMES</code> */ public void setFormat(Format format) { this.format = format.getValue(); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/BaseTest.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/BaseTest.java index 6e120c4..5392b07 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/BaseTest.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/BaseTest.java @@ -191,7 +191,7 @@ public abstract class BaseTest { /** * Get the destination directory. * @return the destination directory as an absolute path if it exists - * otherwise return <tt>null</tt> + * otherwise return <code>null</code> */ public String getTodir() { if (destDir != null) { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/BatchTest.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/BatchTest.java index 51ad7d1..b3ef206 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/BatchTest.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/BatchTest.java @@ -61,7 +61,7 @@ public final class BatchTest extends BaseTest { /** * Add a new fileset instance to this batchtest. Whatever the fileset is, - * only filename that are <tt>.java</tt> or <tt>.class</tt> will be + * only filename that are <code>.java</code> or <code>.class</code> will be * considered as 'candidates'. * @param fs the new fileset containing the rules to get the testcases. */ @@ -84,7 +84,7 @@ public final class BatchTest extends BaseTest { /** * Add a new ResourceCollection instance to this * batchtest. Whatever the collection is, only names that are - * <tt>.java</tt> or <tt>.class</tt> will be considered as + * <code>.java</code> or <code>.class</code> will be considered as * 'candidates'. * @param rc the new ResourceCollection containing the rules to * get the testcases. @@ -95,17 +95,17 @@ public final class BatchTest extends BaseTest { } /** - * Return all <tt>JUnitTest</tt> instances obtain by applying the fileset rules. + * Return all <code>JUnitTest</code> instances obtain by applying the fileset rules. * @return an enumeration of all elements of this batchtest that are - * a <tt>JUnitTest</tt> instance. + * a <code>JUnitTest</code> instance. */ public Enumeration<JUnitTest> elements() { return Collections.enumeration(Arrays.asList(createAllJUnitTest())); } /** - * Convenient method to merge the <tt>JUnitTest</tt>s of this batchtest - * to a <tt>Vector</tt>. + * Convenient method to merge the <code>JUnitTest</code>s of this batchtest + * to a <code>Vector</code>. * @param v the vector to which should be added all individual tests of this * batch test. */ @@ -118,9 +118,9 @@ public final class BatchTest extends BaseTest { } /** - * Create all <tt>JUnitTest</tt>s based on the filesets. Each instance + * Create all <code>JUnitTest</code>s based on the filesets. Each instance * is configured to match this instance properties. - * @return the array of all <tt>JUnitTest</tt>s that belongs to this batch. + * @return the array of all <code>JUnitTest</code>s that belongs to this batch. */ private JUnitTest[] createAllJUnitTest() { return Stream.of(getFilenames()).map(BatchTest::javaToClass) @@ -129,13 +129,13 @@ public final class BatchTest extends BaseTest { /** * Iterate over all filesets and return the filename of all files - * that end with <tt>.java</tt> or <tt>.class</tt>. This is to avoid - * wrapping a <tt>JUnitTest</tt> over an xml file for example. A Testcase + * that end with <code>.java</code> or <code>.class</code>. This is to avoid + * wrapping a <code>JUnitTest</code> over an xml file for example. A Testcase * is obviously a java file (compiled or not). * @return an array of filenames without their extension. As they should * normally be taken from their root, filenames should match their fully * qualified class name (If it is not the case it will fail when running the test). - * For the class <tt>org/apache/Whatever.class</tt> it will return <tt>org/apache/Whatever</tt>. + * For the class <code>org/apache/Whatever.class</code> it will return <code>org/apache/Whatever</code>. */ private String[] getFilenames() { return resources.stream().filter(Resource::isExists) @@ -147,8 +147,8 @@ public final class BatchTest extends BaseTest { /** * Convenient method to convert a pathname without extension to a - * fully qualified classname. For example <tt>org/apache/Whatever</tt> will - * be converted to <tt>org.apache.Whatever</tt> + * fully qualified classname. For example <code>org/apache/Whatever</code> will + * be converted to <code>org.apache.Whatever</code> * @param filename the filename to "convert" to a classname. * @return the classname matching the filename. */ @@ -158,11 +158,11 @@ public final class BatchTest extends BaseTest { } /** - * Create a <tt>JUnitTest</tt> that has the same property as this - * <tt>BatchTest</tt> instance. + * Create a <code>JUnitTest</code> that has the same property as this + * <code>BatchTest</code> instance. * @param classname the name of the class that should be run as a - * <tt>JUnitTest</tt>. It must be a fully qualified name. - * @return the <tt>JUnitTest</tt> over the given classname. + * <code>JUnitTest</code>. It must be a fully qualified name. + * @return the <code>JUnitTest</code> over the given classname. */ private JUnitTest createJUnitTest(String classname) { JUnitTest test = new JUnitTest(); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/CustomJUnit4TestAdapterCache.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/CustomJUnit4TestAdapterCache.java index 5b04c37..7097a41 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/CustomJUnit4TestAdapterCache.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/CustomJUnit4TestAdapterCache.java @@ -30,7 +30,7 @@ import org.junit.runner.notification.RunNotifier; /** * Provides a custom implementation of the notifier for a JUnit4TestAdapter * so that skipped and ignored tests can be reported to the existing - * <tt>TestListener</tt>s. + * <code>TestListener</code>s. * */ public class CustomJUnit4TestAdapterCache extends JUnit4TestAdapterCache { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/DOMUtil.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/DOMUtil.java index cb9ab81..c11d26d 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/DOMUtil.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/DOMUtil.java @@ -43,13 +43,13 @@ public final class DOMUtil { /** * Filter interface to be applied when iterating over a DOM tree. - * Just think of it like a <tt>FileFilter</tt> clone. + * Just think of it like a <code>FileFilter</code> clone. */ public interface NodeFilter { /** * @param node the node to check for acceptance. - * @return <tt>true</tt> if the node is accepted by this filter, - * otherwise <tt>false</tt> + * @return <code>true</code> if the node is accepted by this filter, + * otherwise <code>false</code> */ boolean accept(Node node); } @@ -59,8 +59,8 @@ public final class DOMUtil { * recursively or not. * @param parent the parent node to search from * @param filter the filter that children should match. - * @param recurse <tt>true</tt> if you want the list to be made recursively - * otherwise <tt>false</tt>. + * @param recurse <code>true</code> if you want the list to be made recursively + * otherwise <code>false</code>. * @return the node list that matches the filter. */ public static NodeList listChildNodes(Node parent, NodeFilter filter, boolean recurse) { @@ -116,8 +116,8 @@ public final class DOMUtil { * return the attribute value of an element. * @param node the node to get the attribute from. * @param name the name of the attribute we are looking for the value. - * @return the value of the requested attribute or <tt>null</tt> if the - * attribute was not found or if <tt>node</tt> is not an <tt>Element</tt>. + * @return the value of the requested attribute or <code>null</code> if the + * attribute was not found or if <code>node</code> is not an <code>Element</code>. */ public static String getNodeAttribute(Node node, String name) { if (node instanceof Element) { @@ -131,10 +131,10 @@ public final class DOMUtil { /** * Iterate over the children of a given node and return the first node * that has a specific name. - * @param parent the node to search child from. Can be <tt>null</tt>. - * @param tagname the child name we are looking for. Cannot be <tt>null</tt>. - * @return the first child that matches the given name or <tt>null</tt> if - * the parent is <tt>null</tt> or if a child does not match the + * @param parent the node to search child from. Can be <code>null</code>. + * @param tagname the child name we are looking for. Cannot be <code>null</code>. + * @return the first child that matches the given name or <code>null</code> if + * the parent is <code>null</code> or if a child does not match the * given name. */ public static Element getChildByTagName(Node parent, String tagname) { @@ -155,15 +155,15 @@ public final class DOMUtil { /** * Simple tree walker that will clone recursively a node. This is to - * avoid using parser-specific API such as Sun's <tt>changeNodeOwner</tt> - * when we are dealing with DOM L1 implementations since <tt>cloneNode(boolean)</tt> + * avoid using parser-specific API such as Sun's <code>changeNodeOwner</code> + * when we are dealing with DOM L1 implementations since <code>cloneNode(boolean)</code> * will not change the owner document. - * <tt>changeNodeOwner</tt> is much faster and avoid the costly cloning process. - * <tt>importNode</tt> is in the DOM L2 interface. + * <code>changeNodeOwner</code> is much faster and avoid the costly cloning process. + * <code>importNode</code> is in the DOM L2 interface. * @param parent the node parent to which we should do the import to. * @param child the node to clone recursively. Its clone will be - * appended to <tt>parent</tt>. - * @return the cloned node that is appended to <tt>parent</tt> + * appended to <code>parent</code>. + * @return the cloned node that is appended to <code>parent</code> */ public static Node importNode(Node parent, Node child) { final Document doc = parent.getOwnerDocument(); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/Enumerations.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/Enumerations.java index 649754b..51c8a0c 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/Enumerations.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/Enumerations.java @@ -50,7 +50,7 @@ public final class Enumerations { /** * creates an enumeration from an array of enumeration. The created enumeration * will sequentially enumerate over all elements of each enumeration and skip - * <tt>null</tt> enumeration elements in the array. + * <code>null</code> enumeration elements in the array. * @param <T> object type * @param enums the array of enumerations. * @return the enumeration over the array of enumerations. diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.java index 70c6198..2796ac4 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.java @@ -219,8 +219,8 @@ public class JUnitTask extends Task { * <p>This property is applied on all BatchTest (batchtest) and * JUnitTest (test) however it can possibly be overridden by their * own properties.</p> - * @param value <tt>false</tt> if it should not filter, otherwise - * <tt>true</tt> + * @param value <code>false</code> if it should not filter, otherwise + * <code>true</code> * * @since Ant 1.5 */ @@ -233,8 +233,8 @@ public class JUnitTask extends Task { * This property is applied on all BatchTest (batchtest) and JUnitTest * (test) however it can possibly be overridden by their own * properties. - * @param value <tt>true</tt> if it should halt, otherwise - * <tt>false</tt> + * @param value <code>true</code> if it should halt, otherwise + * <code>false</code> * * @since Ant 1.2 */ @@ -263,8 +263,8 @@ public class JUnitTask extends Task { * This property is applied on all BatchTest (batchtest) and * JUnitTest (test) however it can possibly be overridden by their * own properties. - * @param value <tt>true</tt> if it should halt, otherwise - * <tt>false</tt> + * @param value <code>true</code> if it should halt, otherwise + * <code>false</code> * * @since Ant 1.2 */ @@ -294,8 +294,8 @@ public class JUnitTask extends Task { * hanging the build. this property is applied on all BatchTest * (batchtest) and JUnitTest (test) however it can possibly be * overridden by their own properties.</p> - * @param value <tt>true</tt> if a JVM should be forked, otherwise - * <tt>false</tt> + * @param value <code>true</code> if a JVM should be forked, otherwise + * <code>false</code> * @see #setTimeout * * @since Ant 1.2 @@ -350,9 +350,9 @@ public class JUnitTask extends Task { * * Can take the values on, off, and withOutAndErr. * - * @param value <tt>true</tt> to print a summary, - * <tt>withOutAndErr</tt> to include the test's output as - * well, <tt>false</tt> otherwise. + * @param value <code>true</code> to print a summary, + * <code>withOutAndErr</code> to include the test's output as + * well, <code>false</code> otherwise. * @see SummaryJUnitResultFormatter * @since Ant 1.2 */ @@ -405,7 +405,7 @@ public class JUnitTask extends Task { /** * Set the maximum memory to be used by all forked JVMs. * - * @param max the value as defined by <tt>-mx</tt> or <tt>-Xmx</tt> + * @param max the value as defined by <code>-mx</code> or <code>-Xmx</code> * in the java command line options. * @since Ant 1.2 */ @@ -418,7 +418,7 @@ public class JUnitTask extends Task { * default is 'java'. The command is resolved by * java.lang.Runtime.exec(). Ignored if fork is disabled. * - * @param value the new VM to use instead of <tt>java</tt> + * @param value the new VM to use instead of <code>java</code> * @see #setFork(boolean) * * @since Ant 1.2 @@ -1139,9 +1139,9 @@ public class JUnitTask extends Task { * attributes of the returned holder object. * @param test the testcase to execute. * @param watchdog the watchdog in charge of cancelling the test if it - * exceeds a certain amount of time. Can be <tt>null</tt>, in this case + * exceeds a certain amount of time. Can be <code>null</code>, in this case * the test could probably hang forever. - * @param casesFile list of test cases to execute. Can be <tt>null</tt>, + * @param casesFile list of test cases to execute. Can be <code>null</code>, * in this case only one test is executed. * @return the test results from the JVM itself. * @throws BuildException in case of error creating a temporary property file, @@ -1629,7 +1629,7 @@ public class JUnitTask extends Task { } /** - * @return <tt>null</tt> if there is a timeout value, otherwise the + * @return <code>null</code> if there is a timeout value, otherwise the * watchdog instance. * * @throws BuildException under unspecified circumstances @@ -1654,7 +1654,7 @@ public class JUnitTask extends Task { /** * Merge all individual tests from the batchtest with all individual tests - * and return an enumeration over all <tt>JUnitTest</tt>. + * and return an enumeration over all <code>JUnitTest</code>. * * @return enumeration over individual tests * @since Ant 1.3 diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLConstants.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLConstants.java index c29271d..79ee06f 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLConstants.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLConstants.java @@ -19,8 +19,8 @@ package org.apache.tools.ant.taskdefs.optional.junit; /** * <p>Interface groups XML constants. - * Interface that groups all constants used throughout the <tt>XML</tt> - * documents that are generated by the <tt>XMLJUnitResultFormatter</tt>. + * Interface that groups all constants used throughout the <code>XML</code> + * documents that are generated by the <code>XMLJUnitResultFormatter</code>. * </p> * As of now the DTD is: * <pre> diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLResultAggregator.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLResultAggregator.java index c188ad9..993d471 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLResultAggregator.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLResultAggregator.java @@ -70,10 +70,10 @@ public class XMLResultAggregator extends Task implements XMLConstants { protected Vector<AggregateTransformer> transformers = new Vector<>(); - /** The default directory: <tt>.</tt>. It is resolved from the project directory */ + /** The default directory: <code>.</code>. It is resolved from the project directory */ public static final String DEFAULT_DIR = "."; - /** the default file name: <tt>TESTS-TestSuites.xml</tt> */ + /** the default file name: <code>TESTS-TestSuites.xml</code> */ public static final String DEFAULT_FILENAME = "TESTS-TestSuites.xml"; /** the current generated id */ @@ -108,7 +108,7 @@ public class XMLResultAggregator extends Task implements XMLConstants { /** * Set the name of the aggregated results file. It must be relative - * from the <tt>todir</tt> attribute. If not set it will use {@link #DEFAULT_FILENAME} + * from the <code>todir</code> attribute. If not set it will use {@link #DEFAULT_FILENAME} * @param value the name of the file. * @see #setTodir(File) */ @@ -160,7 +160,7 @@ public class XMLResultAggregator extends Task implements XMLConstants { /** * Get the full destination file where to write the result. It is made of - * the <tt>todir</tt> and <tt>tofile</tt> attributes. + * the <code>todir</code> and <code>tofile</code> attributes. * @return the destination file where should be written the result file. */ public File getDestinationFile() { @@ -270,10 +270,10 @@ public class XMLResultAggregator extends Task implements XMLConstants { * <p>Add a new testsuite node to the document. * The main difference is that it * split the previous fully qualified name into a package and a name.</p> - * <p>For example: <tt>org.apache.Whatever</tt> will be split into - * <tt>org.apache</tt> and <tt>Whatever</tt>.</p> + * <p>For example: <code>org.apache.Whatever</code> will be split into + * <code>org.apache</code> and <code>Whatever</code>.</p> * - * @param root the root element to which the <tt>testsuite</tt> node should + * @param root the root element to which the <code>testsuite</code> node should * be appended. * @param testsuite the element to append to the given root. It will slightly * modify the original node to change the name attribute and add @@ -295,7 +295,7 @@ public class XMLResultAggregator extends Task implements XMLConstants { } /** - * Create a new document builder. Will issue an <tt>ExceptionInitializerError</tt> + * Create a new document builder. Will issue an <code>ExceptionInitializerError</code> * if something is going wrong. It is fatal anyway. * @todo factorize this somewhere else. It is duplicated code. * @return a new document builder to create a DOM diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/net/FTP.java b/src/main/org/apache/tools/ant/taskdefs/optional/net/FTP.java index 901ff06..fe757e2 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/net/FTP.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/net/FTP.java @@ -1286,7 +1286,7 @@ public class FTP extends Task implements FTPTaskConfig { /** - * A synonym for <tt>depends</tt>. Set to true to transmit only new + * A synonym for <code>depends</code>. Set to true to transmit only new * or changed files. * * See the related attributes timediffmillis and timediffauto. diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/net/FTPTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/net/FTPTask.java index 44eb02e..c8e9930 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/net/FTPTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/net/FTPTask.java @@ -265,7 +265,7 @@ public class FTPTask extends Task implements FTPTaskConfig { } /** - * A synonym for <tt>depends</tt>. Set to true to transmit only new + * A synonym for <code>depends</code>. Set to true to transmit only new * or changed files. * * See the related attributes timediffmillis and timediffauto. diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/net/MimeMail.java b/src/main/org/apache/tools/ant/taskdefs/optional/net/MimeMail.java index 01db77a..8e4ec39 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/net/MimeMail.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/net/MimeMail.java @@ -21,7 +21,7 @@ import org.apache.tools.ant.BuildException; import org.apache.tools.ant.taskdefs.email.EmailTask; /** - * A task to send SMTP email; Use <tt>mail</tt> instead + * A task to send SMTP email; Use <code>mail</code> instead * * @deprecated since 1.6.x. * Use {@link EmailTask} instead. diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/net/RExecTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/net/RExecTask.java index d416060..649cb70 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/net/RExecTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/net/RExecTask.java @@ -430,7 +430,7 @@ public class RExecTask extends Task { /** * Set the the login password to use - * required if <tt>userid</tt> is set. + * required if <code>userid</code> is set. * @param p a <code>String</code> value */ public void setPassword(String p) { @@ -464,7 +464,7 @@ public class RExecTask extends Task { /** * Set the the login id to use on the server; - * required if <tt>password</tt> is set. + * required if <code>password</code> is set. * @param u a <code>String</code> value */ public void setUserid(String u) { 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 d347a75..3afcdef 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 @@ -47,8 +47,8 @@ import org.apache.tools.ant.util.ProxySetup; * <pre><setproxy socksproxyhost=""/></pre> * stop using the socks server. * <p> - * You can set a username and password for http with the <tt>proxyHost</tt> - * and <tt>proxyPassword</tt> attributes. These can also be + * You can set a username and password for http with the <code>proxyHost</code> + * and <code>proxyPassword</code> attributes. These can also be * used against SOCKS5 servers. * </p> * @see <a href="http://java.sun.com/j2se/1.5.0/docs/guide/net/properties.html"> 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 37802bf..04c99e0 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 @@ -150,7 +150,7 @@ public class TelnetTask extends Task { /** * Set the the login id to use on the server; - * required if <tt>password</tt> is set. + * required if <code>password</code> is set. * @param u a <code>String</code> value */ public void setUserid(String u) { @@ -159,7 +159,7 @@ public class TelnetTask extends Task { /** * Set the the login password to use - * required if <tt>userid</tt> is set. + * required if <code>userid</code> is set. * @param p a <code>String</code> value */ public void setPassword(String p) { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/splash/SplashTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/splash/SplashTask.java index e265bbe..1ca8d83 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/splash/SplashTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/splash/SplashTask.java @@ -110,7 +110,7 @@ public class SplashTask extends Task { } /** - * Proxy password; required if <tt>user</tt> is set. + * Proxy password; required if <code>user</code> is set. * @param password the proxy password * @deprecated since 1.5.x. * Use org.apache.tools.ant.taskdefs.optional.net.SetProxy diff --git a/src/main/org/apache/tools/ant/types/CommandlineJava.java b/src/main/org/apache/tools/ant/types/CommandlineJava.java index 8ddebc9..8766753 100644 --- a/src/main/org/apache/tools/ant/types/CommandlineJava.java +++ b/src/main/org/apache/tools/ant/types/CommandlineJava.java @@ -30,7 +30,7 @@ import org.apache.tools.ant.util.JavaEnvUtils; /** * A representation of a Java command line that is - * a composite of 2 <tt>Commandline</tt>s. One is used for the + * a composite of 2 <code>Commandline</code>s. One is used for the * vm/options and one for the classname/arguments. It provides * specific methods for a Java command line. * @@ -325,7 +325,7 @@ public class CommandlineJava implements Cloneable { /** * Get the name of the jar to be run. * @return the pathname of the jar file to run via -jar option - * or <tt>null</tt> if there is no jar to run. + * or <code>null</code> if there is no jar to run. * @see #getClassname() */ public String getJar() { @@ -352,7 +352,7 @@ public class CommandlineJava implements Cloneable { /** * Get the name of the class to be run. - * @return the name of the class to run or <tt>null</tt> if there is no class. + * @return the name of the class to run or <code>null</code> if there is no class. * @see #getJar() */ public String getClassname() { @@ -419,7 +419,7 @@ public class CommandlineJava implements Cloneable { /** * Get the name of the module to be run. - * @return the name of the module to run or <tt>null</tt> if there is no module. + * @return the name of the module to run or <code>null</code> if there is no module. * @see #getJar() * @see #getClassname() * @since 1.9.7 diff --git a/src/main/org/apache/tools/ant/types/EnumeratedAttribute.java b/src/main/org/apache/tools/ant/types/EnumeratedAttribute.java index 80884c3..09867d3 100644 --- a/src/main/org/apache/tools/ant/types/EnumeratedAttribute.java +++ b/src/main/org/apache/tools/ant/types/EnumeratedAttribute.java @@ -46,7 +46,7 @@ public abstract class EnumeratedAttribute { * This is the only method a subclass needs to implement. * * @return an array holding all possible values of the enumeration. - * The order of elements must be fixed so that <tt>indexOfValue(String)</tt> + * The order of elements must be fixed so that <code>indexOfValue(String)</code> * always return the same index for the same value. */ public abstract String[] getValues(); diff --git a/src/main/org/apache/tools/ant/types/XMLCatalog.java b/src/main/org/apache/tools/ant/types/XMLCatalog.java index 5922120..1149ff8 100644 --- a/src/main/org/apache/tools/ant/types/XMLCatalog.java +++ b/src/main/org/apache/tools/ant/types/XMLCatalog.java @@ -555,10 +555,10 @@ public class XMLCatalog extends DataType * inherit the EntityResolver of the original (although arguably * it should). See below:</p> * - * <tt>"If an application wants to set the ErrorHandler or + * <code>"If an application wants to set the ErrorHandler or * EntityResolver for an XMLReader used during a transformation, * it should use a URIResolver to return the SAXSource which - * provides (with getXMLReader) a reference to the XMLReader"</tt> + * provides (with getXMLReader) a reference to the XMLReader"</code> * * <p>...quoted from page 118 of the Java API for XML * Processing 1.1 specification</p> diff --git a/src/main/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.java b/src/main/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.java index 181642c..78cc09a 100644 --- a/src/main/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.java +++ b/src/main/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.java @@ -488,7 +488,7 @@ public class ModifiedSelector extends BaseExtendSelector * @param basedir as described in BaseExtendSelector * @param filename as described in BaseExtendSelector * @param cacheKey the name for the key for storing the hashvalue - * @return <tt>true</tt> if the file is selected otherwise <tt>false</tt> + * @return <code>true</code> if the file is selected otherwise <code>false</code> */ private boolean isSelected(File basedir, String filename, String cacheKey) { validate(); diff --git a/src/main/org/apache/tools/ant/util/DateUtils.java b/src/main/org/apache/tools/ant/util/DateUtils.java index 7436fc6..1d5bee0 100644 --- a/src/main/org/apache/tools/ant/util/DateUtils.java +++ b/src/main/org/apache/tools/ant/util/DateUtils.java @@ -45,19 +45,19 @@ public final class DateUtils { private static final int TEN = 10; /** * ISO8601-like pattern for date-time. It does not support timezone. - * <tt>yyyy-MM-ddTHH:mm:ss</tt> + * <code>yyyy-MM-ddTHH:mm:ss</code> */ public static final String ISO8601_DATETIME_PATTERN = "yyyy-MM-dd'T'HH:mm:ss"; /** - * ISO8601-like pattern for date. <tt>yyyy-MM-dd</tt> + * ISO8601-like pattern for date. <code>yyyy-MM-dd</code> */ public static final String ISO8601_DATE_PATTERN = "yyyy-MM-dd"; /** - * ISO8601-like pattern for time. <tt>HH:mm:ss</tt> + * ISO8601-like pattern for time. <code>HH:mm:ss</code> */ public static final String ISO8601_TIME_PATTERN = "HH:mm:ss"; diff --git a/src/main/org/apache/tools/ant/util/KeepAliveInputStream.java b/src/main/org/apache/tools/ant/util/KeepAliveInputStream.java index 58332b5..447dd86 100644 --- a/src/main/org/apache/tools/ant/util/KeepAliveInputStream.java +++ b/src/main/org/apache/tools/ant/util/KeepAliveInputStream.java @@ -22,7 +22,7 @@ import java.io.IOException; import java.io.InputStream; /** - * Class that can be used to wrap <tt>System.in</tt> + * Class that can be used to wrap <code>System.in</code> * without getting anxious about any client closing the stream. * * <p> diff --git a/src/main/org/apache/tools/ant/util/KeepAliveOutputStream.java b/src/main/org/apache/tools/ant/util/KeepAliveOutputStream.java index 352b0ba..1ddcccc 100644 --- a/src/main/org/apache/tools/ant/util/KeepAliveOutputStream.java +++ b/src/main/org/apache/tools/ant/util/KeepAliveOutputStream.java @@ -23,7 +23,7 @@ import java.io.OutputStream; import java.io.PrintStream; /** - * Class that can be used to wrap <tt>System.out</tt> and <tt>System.err</tt> + * Class that can be used to wrap <code>System.out</code> and <code>System.err</code> * without getting anxious about any client closing the stream. * * <p> diff --git a/src/main/org/apache/tools/ant/util/StringUtils.java b/src/main/org/apache/tools/ant/util/StringUtils.java index 3f71ef8..d715115 100644 --- a/src/main/org/apache/tools/ant/util/StringUtils.java +++ b/src/main/org/apache/tools/ant/util/StringUtils.java @@ -50,7 +50,7 @@ public final class StringUtils { /** * Splits up a string into a list of lines. It is equivalent - * to <tt>split(data, '\n')</tt>. + * to <code>split(data, '\n')</code>. * @param data the string to split up into lines. * @return the list of lines available in the string. */ diff --git a/src/main/org/apache/tools/bzip2/CBZip2InputStream.java b/src/main/org/apache/tools/bzip2/CBZip2InputStream.java index 2f982de..c1e2f97 100644 --- a/src/main/org/apache/tools/bzip2/CBZip2InputStream.java +++ b/src/main/org/apache/tools/bzip2/CBZip2InputStream.java @@ -32,11 +32,11 @@ import java.io.InputStream; * * <p>The decompression requires large amounts of memory. Thus you * should call the {@link #close() close()} method as soon as - * possible, to force <tt>CBZip2InputStream</tt> to release the + * possible, to force <code>CBZip2InputStream</code> to release the * allocated memory. See {@link CBZip2OutputStream * CBZip2OutputStream} for information about memory usage.</p> * - * <p><tt>CBZip2InputStream</tt> reads bytes from the compressed + * <p><code>CBZip2InputStream</code> reads bytes from the compressed * source stream via the single byte {@link java.io.InputStream#read() * read()} method exclusively. Thus you should consider to use a * buffered source stream.</p> @@ -114,7 +114,7 @@ public class CBZip2InputStream extends InputStream implements BZip2Constants { * concatenated .bz2 files. * * <p>Although BZip2 headers are marked with the magic - * <tt>"Bz"</tt> this constructor expects the next byte in the + * <code>"Bz"</code> this constructor expects the next byte in the * stream to be the first one after the magic. Thus callers have * to skip the first two bytes. Otherwise this constructor will * throw an exception. </p> @@ -123,7 +123,7 @@ public class CBZip2InputStream extends InputStream implements BZip2Constants { * @throws IOException * if the stream content is malformed or an I/O error occurs. * @throws NullPointerException - * if <tt>in == null</tt> + * if <code>in == null</code> */ public CBZip2InputStream(final InputStream in) throws IOException { this(in, false); @@ -134,7 +134,7 @@ public class CBZip2InputStream extends InputStream implements BZip2Constants { * read from the specified stream. * * <p>Although BZip2 headers are marked with the magic - * <tt>"Bz"</tt> this constructor expects the next byte in the + * <code>"Bz"</code> this constructor expects the next byte in the * stream to be the first one after the magic. Thus callers have * to skip the first two bytes. Otherwise this constructor will * throw an exception. </p> @@ -149,7 +149,7 @@ public class CBZip2InputStream extends InputStream implements BZip2Constants { * @throws IOException * if the stream content is malformed or an I/O error occurs. * @throws NullPointerException - * if <tt>in == null</tt> + * if <code>in == null</code> */ public CBZip2InputStream(final InputStream in, final boolean decompressConcatenated) diff --git a/src/main/org/apache/tools/bzip2/CBZip2OutputStream.java b/src/main/org/apache/tools/bzip2/CBZip2OutputStream.java index ec438be..f386adf 100644 --- a/src/main/org/apache/tools/bzip2/CBZip2OutputStream.java +++ b/src/main/org/apache/tools/bzip2/CBZip2OutputStream.java @@ -34,7 +34,7 @@ import java.io.OutputStream; * <p> * The compression requires large amounts of memory. Thus you should call the * {@link #close() close()} method as soon as possible, to force - * <tt>CBZip2OutputStream</tt> to release the allocated memory. + * <code>CBZip2OutputStream</code> to release the allocated memory. * </p> * * <p>You can shrink the amount of allocated memory and maybe raise @@ -57,62 +57,62 @@ import java.io.OutputStream; * <code>65k + (5 * blocksize)</code>. * </pre> * - * <table border="1"> + * <table style="border:1px solid black"> * <caption>Memory usage by blocksize</caption> * <tr> - * <th align="right">Blocksize</th> - * <th align="right">Compression<br>memory usage</th> - * <th align="right">Decompression<br>memory usage</th> + * <th style="text-align:right">Blocksize</th> + * <th style="text-align:right">Compression<br>memory usage</th> + * <th style="text-align:right">Decompression<br>memory usage</th> * </tr> * <tr> - * <td align="right">100k</td> - * <td align="right">1300k</td> - * <td align="right">565k</td> + * <td style="text-align:right">100k</td> + * <td style="text-align:right">1300k</td> + * <td style="text-align:right">565k</td> * </tr> * <tr> - * <td align="right">200k</td> - * <td align="right">2200k</td> - * <td align="right">1065k</td> + * <td style="text-align:right">200k</td> + * <td style="text-align:right">2200k</td> + * <td style="text-align:right">1065k</td> * </tr> * <tr> - * <td align="right">300k</td> - * <td align="right">3100k</td> - * <td align="right">1565k</td> + * <td style="text-align:right">300k</td> + * <td style="text-align:right">3100k</td> + * <td style="text-align:right">1565k</td> * </tr> * <tr> - * <td align="right">400k</td> - * <td align="right">4000k</td> - * <td align="right">2065k</td> + * <td style="text-align:right">400k</td> + * <td style="text-align:right">4000k</td> + * <td style="text-align:right">2065k</td> * </tr> * <tr> - * <td align="right">500k</td> - * <td align="right">4900k</td> - * <td align="right">2565k</td> + * <td style="text-align:right">500k</td> + * <td style="text-align:right">4900k</td> + * <td style="text-align:right">2565k</td> * </tr> * <tr> - * <td align="right">600k</td> - * <td align="right">5800k</td> - * <td align="right">3065k</td> + * <td style="text-align:right">600k</td> + * <td style="text-align:right">5800k</td> + * <td style="text-align:right">3065k</td> * </tr> * <tr> - * <td align="right">700k</td> - * <td align="right">6700k</td> - * <td align="right">3565k</td> + * <td style="text-align:right">700k</td> + * <td style="text-align:right">6700k</td> + * <td style="text-align:right">3565k</td> * </tr> * <tr> - * <td align="right">800k</td> - * <td align="right">7600k</td> - * <td align="right">4065k</td> + * <td style="text-align:right">800k</td> + * <td style="text-align:right">7600k</td> + * <td style="text-align:right">4065k</td> * </tr> * <tr> - * <td align="right">900k</td> - * <td align="right">8500k</td> - * <td align="right">4565k</td> + * <td style="text-align:right">900k</td> + * <td style="text-align:right">8500k</td> + * <td style="text-align:right">4565k</td> * </tr> * </table> * * <p> - * For decompression <tt>CBZip2InputStream</tt> allocates less memory if the + * For decompression <code>CBZip2InputStream</code> allocates less memory if the * bzipped input is smaller than one block. * </p> * @@ -129,12 +129,12 @@ public class CBZip2OutputStream extends OutputStream implements BZip2Constants { /** - * The minimum supported blocksize <tt> == 1</tt>. + * The minimum supported blocksize <code> == 1</code>. */ public static final int MIN_BLOCKSIZE = 1; /** - * The maximum supported blocksize <tt> == 9</tt>. + * The maximum supported blocksize <code> == 9</code>. */ public static final int MAX_BLOCKSIZE = 9; @@ -564,10 +564,10 @@ public class CBZip2OutputStream extends OutputStream * * @param inputLength * The length of the data which will be compressed by - * <tt>CBZip2OutputStream</tt>. + * <code>CBZip2OutputStream</code>. * @return The blocksize, between {@link #MIN_BLOCKSIZE} and * {@link #MAX_BLOCKSIZE} both inclusive. For a negative - * <tt>inputLength</tt> this method returns <tt>MAX_BLOCKSIZE</tt> + * <code>inputLength</code> this method returns <code>MAX_BLOCKSIZE</code> * always. */ public static int chooseBlockSize(long inputLength) { @@ -576,11 +576,11 @@ public class CBZip2OutputStream extends OutputStream } /** - * Constructs a new <tt>CBZip2OutputStream</tt> with a blocksize of 900k. + * Constructs a new <code>CBZip2OutputStream</code> with a blocksize of 900k. * * <p> * <b>Attention: </b>The caller is responsible to write the two BZip2 magic - * bytes <tt>"BZ"</tt> to the specified stream prior to calling this + * bytes <code>"BZ"</code> to the specified stream prior to calling this * constructor. * </p> * @@ -597,11 +597,11 @@ public class CBZip2OutputStream extends OutputStream } /** - * Constructs a new <tt>CBZip2OutputStream</tt> with specified blocksize. + * Constructs a new <code>CBZip2OutputStream</code> with specified blocksize. * * <p> * <b>Attention: </b>The caller is responsible to write the two BZip2 magic - * bytes <tt>"BZ"</tt> to the specified stream prior to calling this + * bytes <code>"BZ"</code> to the specified stream prior to calling this * constructor. * </p> * diff --git a/src/main/org/apache/tools/zip/GeneralPurposeBit.java b/src/main/org/apache/tools/zip/GeneralPurposeBit.java index 99a2cd4..2825f08 100644 --- a/src/main/org/apache/tools/zip/GeneralPurposeBit.java +++ b/src/main/org/apache/tools/zip/GeneralPurposeBit.java @@ -151,7 +151,7 @@ public final class GeneralPurposeBit implements Cloneable { * @param buf the output buffer * @param offset * The offset within the output buffer of the first byte to be written. - * must be non-negative and no larger than <tt>buf.length-2</tt> + * must be non-negative and no larger than <code>buf.length-2</code> */ public void encode(byte[] buf, int offset) { ZipShort.putShort((dataDescriptorFlag ? DATA_DESCRIPTOR_FLAG : 0) diff --git a/src/main/org/apache/tools/zip/ZipLong.java b/src/main/org/apache/tools/zip/ZipLong.java index 69d6ca4..04e8b98 100644 --- a/src/main/org/apache/tools/zip/ZipLong.java +++ b/src/main/org/apache/tools/zip/ZipLong.java @@ -124,7 +124,7 @@ public final class ZipLong implements Cloneable { * @param buf the output buffer * @param offset * The offset within the output buffer of the first byte to be written. - * must be non-negative and no larger than <tt>buf.length-4</tt> + * must be non-negative and no larger than <code>buf.length-4</code> */ public static void putLong(long value, byte[] buf, int offset) { buf[offset++] = (byte) ((value & BYTE_MASK)); diff --git a/src/main/org/apache/tools/zip/ZipShort.java b/src/main/org/apache/tools/zip/ZipShort.java index 3dbe2cb..7171fe6 100644 --- a/src/main/org/apache/tools/zip/ZipShort.java +++ b/src/main/org/apache/tools/zip/ZipShort.java @@ -76,7 +76,7 @@ public final class ZipShort implements Cloneable { * @param buf the output buffer * @param offset * The offset within the output buffer of the first byte to be written. - * must be non-negative and no larger than <tt>buf.length-2</tt> + * must be non-negative and no larger than <code>buf.length-2</code> */ public static void putShort(int value, byte[] buf, int offset) { buf[offset] = (byte) (value & BYTE_MASK); diff --git a/src/main/org/apache/tools/zip/ZipUtil.java b/src/main/org/apache/tools/zip/ZipUtil.java index ff35ca4..f130335 100644 --- a/src/main/org/apache/tools/zip/ZipUtil.java +++ b/src/main/org/apache/tools/zip/ZipUtil.java @@ -65,7 +65,7 @@ public abstract class ZipUtil { * @param buf the output buffer * @param offset * The offset within the output buffer of the first byte to be written. - * must be non-negative and no larger than <tt>buf.length-4</tt> + * must be non-negative and no larger than <code>buf.length-4</code> */ public static void toDosTime(long t, byte[] buf, int offset) { toDosTime(Calendar.getInstance(), t, buf, offset); diff --git a/src/tests/junit/org/apache/tools/ant/AntAssert.java b/src/tests/junit/org/apache/tools/ant/AntAssert.java index 93a1562..ee04fbc 100644 --- a/src/tests/junit/org/apache/tools/ant/AntAssert.java +++ b/src/tests/junit/org/apache/tools/ant/AntAssert.java @@ -21,7 +21,7 @@ import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertTrue; /** - * Provides common assert functions for use across multiple tests, similar to the <tt>Assert</tt>s + * Provides common assert functions for use across multiple tests, similar to the <code>Assert</code>s * within JUnit. * * @deprecated use assertThat() in JUnit 4.4+ in combination with containsString() matcher; diff --git a/src/tests/junit/org/apache/tools/ant/BuildFileRule.java b/src/tests/junit/org/apache/tools/ant/BuildFileRule.java index bb77b74..8caa187 100644 --- a/src/tests/junit/org/apache/tools/ant/BuildFileRule.java +++ b/src/tests/junit/org/apache/tools/ant/BuildFileRule.java @@ -70,7 +70,7 @@ public class BuildFileRule extends ExternalResource { /** * Tidies up following a test execution. If the currently configured - * project has a <tt>tearDown</tt> target then this will automatically + * project has a <code>tearDown</code> target then this will automatically * be called, otherwise this method will not perform any actions. */ @Override diff --git a/src/tests/junit/org/apache/tools/ant/BuildFileTest.java b/src/tests/junit/org/apache/tools/ant/BuildFileTest.java index cdb45f4..101e213 100644 --- a/src/tests/junit/org/apache/tools/ant/BuildFileTest.java +++ b/src/tests/junit/org/apache/tools/ant/BuildFileTest.java @@ -155,7 +155,7 @@ public abstract class BuildFileTest extends TestCase { * Assert that the given substring is in the output messages. * * @param message Print this message if the test fails. Defaults to - * a meaningful text if <tt>null</tt> is passed. + * a meaningful text if <code>null</code> is passed. * @param substring String * @since Ant1.7 */ @@ -171,7 +171,7 @@ public abstract class BuildFileTest extends TestCase { * Assert that the given substring is not in the output messages. * * @param message Print this message if the test fails. Defaults to - * a meaningful text if <tt>null</tt> is passed. + * a meaningful text if <code>null</code> is passed. * @param substring String * @since Ant1.7 */ diff --git a/src/tests/junit/org/apache/tools/ant/FileUtilities.java b/src/tests/junit/org/apache/tools/ant/FileUtilities.java index 3f0eff2..0653fb0 100644 --- a/src/tests/junit/org/apache/tools/ant/FileUtilities.java +++ b/src/tests/junit/org/apache/tools/ant/FileUtilities.java @@ -53,7 +53,7 @@ public class FileUtilities { } /** - * Modified the timestamp on a file so it's <tt>seconds</tt> earlier than it was before. Where <tt>file</tt> + * Modified the timestamp on a file so it's <code>seconds</code> earlier than it was before. Where <code>file</code> * is a directory, this function recurses into all child files (and directories) and reduces their modified * timestamps by the same range, rather than set all timestamps to the same time. * @param file the file to change, or the directory to change then recurse into