From f109d2f31d06357211e03e7343adb788bed3d50e Mon Sep 17 00:00:00 2001 From: twogee Date: Tue, 19 Mar 2019 23:47:29 +0100 Subject: [PATCH] HTML5-compliant javadoc This closes #88 pull request at github/apache/ant repo --- .../org/apache/tools/ant/Diagnostics.java | 6 +- .../tools/ant/TaskConfigurationChecker.java | 4 +- .../tools/ant/taskdefs/ExecuteWatchdog.java | 10 +-- .../tools/ant/taskdefs/ManifestTask.java | 2 +- .../apache/tools/ant/taskdefs/Property.java | 2 +- .../org/apache/tools/ant/taskdefs/Rmic.java | 2 +- .../apache/tools/ant/taskdefs/SignJar.java | 2 +- .../apache/tools/ant/taskdefs/Transform.java | 2 +- .../org/apache/tools/ant/taskdefs/War.java | 4 +- .../tools/ant/taskdefs/XSLTLiaison.java | 2 +- .../tools/ant/taskdefs/XSLTProcess.java | 6 +- .../tools/ant/taskdefs/condition/Xor.java | 2 +- .../ant/taskdefs/optional/EchoProperties.java | 14 ++-- .../tools/ant/taskdefs/optional/Rpm.java | 4 +- .../ant/taskdefs/optional/javacc/JJTree.java | 2 +- .../optional/jdepend/JDependTask.java | 14 ++-- .../optional/junit/AggregateTransformer.java | 4 +- .../ant/taskdefs/optional/junit/BaseTest.java | 2 +- .../taskdefs/optional/junit/BatchTest.java | 34 ++++---- .../junit/CustomJUnit4TestAdapterCache.java | 2 +- .../ant/taskdefs/optional/junit/DOMUtil.java | 34 ++++---- .../taskdefs/optional/junit/Enumerations.java | 2 +- .../taskdefs/optional/junit/JUnitTask.java | 34 ++++---- .../taskdefs/optional/junit/XMLConstants.java | 4 +- .../optional/junit/XMLResultAggregator.java | 16 ++-- .../tools/ant/taskdefs/optional/net/FTP.java | 2 +- .../ant/taskdefs/optional/net/FTPTask.java | 2 +- .../ant/taskdefs/optional/net/MimeMail.java | 2 +- .../ant/taskdefs/optional/net/RExecTask.java | 4 +- .../ant/taskdefs/optional/net/SetProxy.java | 4 +- .../ant/taskdefs/optional/net/TelnetTask.java | 4 +- .../taskdefs/optional/splash/SplashTask.java | 2 +- .../tools/ant/types/CommandlineJava.java | 8 +- .../tools/ant/types/EnumeratedAttribute.java | 2 +- .../apache/tools/ant/types/XMLCatalog.java | 4 +- .../modifiedselector/ModifiedSelector.java | 2 +- .../org/apache/tools/ant/util/DateUtils.java | 6 +- .../tools/ant/util/KeepAliveInputStream.java | 2 +- .../tools/ant/util/KeepAliveOutputStream.java | 2 +- .../apache/tools/ant/util/StringUtils.java | 2 +- .../apache/tools/bzip2/CBZip2InputStream.java | 12 +-- .../tools/bzip2/CBZip2OutputStream.java | 82 +++++++++---------- .../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 +- .../org/apache/tools/ant/BuildFileRule.java | 2 +- .../org/apache/tools/ant/BuildFileTest.java | 4 +- .../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 7434433cf..6717ae818 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 true + * @return true */ @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 - * null if an error occurs. + * null 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 - * null for a missing stream (ie mapping). + * null 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 ce6bcf653..862a8a9c0 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; /** *

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 assert* and fail - * methods the checkErrors will throw a BuildException with all collected + * After collecting all violations with assert* and fail + * methods the checkErrors will throw a BuildException with all collected * messages or does nothing if there wasn't any error.

* *

Example:

diff --git a/src/main/org/apache/tools/ant/taskdefs/ExecuteWatchdog.java b/src/main/org/apache/tools/ant/taskdefs/ExecuteWatchdog.java index 4925f5413..aecc38cfa 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 null + * @param process the process to monitor. It cannot be null * @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 true if the process is still running, otherwise - * false. + * @return true if the process is still running, otherwise + * false. */ 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 true if the process was killed otherwise - * false. + * @return true if the process was killed otherwise + * false. */ 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 a96a84d8f..94a192ac5 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 | - | _ * - * So the resulting regexp would be [A-Za-z0-9][A-Za-z0-9-_]*. + * So the resulting regexp would be [A-Za-z0-9][A-Za-z0-9-_]*. * * 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 34455a066..9cf6c674b 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 true if we should try to load from xml + * @param isXml true 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 55cb8bce9..8b31992ab 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; * *

It is possible to use different compilers. This can be selected * with the "build.rmic" property or the compiler - * attribute. There are three choices:

+ * attribute. There are three choices:

* *