From 8a597546b88bbde571884f302546211236d3e82e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ville=20Skytt=C3=A4?= Date: Sun, 20 Jul 2014 11:12:46 +0300 Subject: [PATCH] =?UTF-8?q?PR=2056749=20Javadoc=201.8=20fixes,=20submitted?= =?UTF-8?q?=20by=20Ville=20Skytt=C3=A4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../org/apache/tools/ant/launch/Locator.java | 18 +++++++++--------- .../ant/taskdefs/optional/testing/Funtest.java | 2 +- .../ant/types/resources/selectors/Date.java | 6 +++--- .../org/apache/tools/ant/util/DOMUtils.java | 9 ++------- .../org/apache/tools/ant/util/FileUtils.java | 12 ++++++------ .../tools/ant/util/GlobPatternMapper.java | 2 +- .../tools/ant/util/KeepAliveInputStream.java | 1 - .../tools/ant/util/KeepAliveOutputStream.java | 3 +-- .../ant/util/LayoutPreservingProperties.java | 4 ++-- .../tools/ant/util/LeadPipeInputStream.java | 2 +- .../org/apache/tools/ant/util/ProxySetup.java | 1 - .../tools/ant/util/ScriptFixBSFPath.java | 2 +- .../org/apache/tools/ant/util/StringUtils.java | 2 +- .../org/apache/tools/ant/util/Watchdog.java | 2 +- .../org/apache/tools/ant/util/WorkerAnt.java | 8 ++++---- .../apache/tools/bzip2/CBZip2OutputStream.java | 2 +- 16 files changed, 34 insertions(+), 42 deletions(-) diff --git a/src/main/org/apache/tools/ant/launch/Locator.java b/src/main/org/apache/tools/ant/launch/Locator.java index 035b8b277..4640e700f 100644 --- a/src/main/org/apache/tools/ant/launch/Locator.java +++ b/src/main/org/apache/tools/ant/launch/Locator.java @@ -31,16 +31,16 @@ import java.util.Locale; /** * The Locator is a utility class which is used to find certain items * in the environment. - * + *

* It is used at boot time in the launcher, and cannot make use of any of Ant's other classes. - * - * This is a surprisingly brittle piece of code, and has had lots of bugs filed against it. - * {@link running ant off a network share can cause Ant to fail} - * {@link use File.toURI().toURL().toExternalForm()} - * {@link Locator implementation not encoding URI strings properly: spaces in paths} - * It also breaks Eclipse 3.3 Betas - * {@link Exception if installation path has spaces} - * + *

+ * This is a surprisingly brittle piece of code, and has had lots of bugs filed against it: + * running ant off a network share can cause Ant to fail, + * use File.toURI().toURL().toExternalForm(), + * Locator implementation not encoding URI strings properly: spaces in paths. + * It also breaks Eclipse 3.3 Betas: + * Exception if installation path has spaces. + *

* Be very careful when making changes to this class, as a break will upset a lot of people. * @since Ant 1.6 */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/testing/Funtest.java b/src/main/org/apache/tools/ant/taskdefs/optional/testing/Funtest.java index 9b3c93c8a..2eb357a39 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/testing/Funtest.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/testing/Funtest.java @@ -385,7 +385,7 @@ public class Funtest extends Task { /** * Run the functional test sequence. - *

+ *

* This is a fairly complex workflow -what is going on is that we try to clean up * no matter how the run ended, and to retain the innermost exception that got thrown * during cleanup. That is, if teardown fails after the tests themselves failed, it is the diff --git a/src/main/org/apache/tools/ant/types/resources/selectors/Date.java b/src/main/org/apache/tools/ant/types/resources/selectors/Date.java index c48e4bc5a..8541e8580 100644 --- a/src/main/org/apache/tools/ant/types/resources/selectors/Date.java +++ b/src/main/org/apache/tools/ant/types/resources/selectors/Date.java @@ -64,7 +64,7 @@ public class Date implements ResourceSelector { /** * Set the date and time as a String. - * @param s the date & time to use. + * @param s the date and time to use. */ public synchronized void setDateTime(String s) { dateTime = s; @@ -72,8 +72,8 @@ public class Date implements ResourceSelector { } /** - * Get the date & time in String format. - * @return a String representing a date & time. + * Get the date and time in String format. + * @return a String representing a date and time. */ public synchronized String getDatetime() { return dateTime; diff --git a/src/main/org/apache/tools/ant/util/DOMUtils.java b/src/main/org/apache/tools/ant/util/DOMUtils.java index 4c3fabe9a..db00213d5 100644 --- a/src/main/org/apache/tools/ant/util/DOMUtils.java +++ b/src/main/org/apache/tools/ant/util/DOMUtils.java @@ -56,7 +56,7 @@ public class DOMUtils { * <b/> * </a> * - * and returns <b>.

+ * and returns <b>. * * @param parent element that will receive the new element as child. * @param name name of the new element. @@ -80,7 +80,6 @@ public class DOMUtils { * 
      * <a>b</a>
      *
- *

* * @param parent element that will receive the new element as child. * @param content text content. @@ -102,7 +101,6 @@ public class DOMUtils { * 
      * <a><[!CDATA[b]]></a>
      *
- *

* * @param parent element that will receive the new element as child. * @param content text content. @@ -126,7 +124,6 @@ public class DOMUtils { * <b>c</b> * </a> * - *

* * @param parent element that will receive the new element as child. * @param name of the child element. @@ -148,11 +145,9 @@ public class DOMUtils { * creates * 
      * <a>
-     *   <b><![CDATA[c]]></b>
+     *   <b><![CDATA[c]]></b>
      * </a>
      *
- * - *

* * @param parent element that will receive the new element as child. * @param name of the child element. diff --git a/src/main/org/apache/tools/ant/util/FileUtils.java b/src/main/org/apache/tools/ant/util/FileUtils.java index c963f49f1..bcef5ecf2 100644 --- a/src/main/org/apache/tools/ant/util/FileUtils.java +++ b/src/main/org/apache/tools/ant/util/FileUtils.java @@ -1346,21 +1346,21 @@ public class FileUtils { * test whether a file or directory exists, with an error in the * upper/lower case spelling of the name. * Using this method is only interesting on case insensitive file systems - * (Windows).
+ * (Windows).
* It will return true only if 3 conditions are met : - *
+ *
* - *
+ *
* the purpose is to identify files or directories on case-insensitive - * filesystems whose case is not what is expected.
+ * filesystems whose case is not what is expected.
* Possibly to rename them afterwards to the desired upper/lowercase * combination. - *
+ * * @param localFile file to test * @return true if the file exists and the case of the actual file * is not the case of the parameter @@ -1591,7 +1591,7 @@ public class FileUtils { /** * Calculates the relative path between two files. *

- * Implementation note:
This function may throw an IOException if an I/O error occurs + * Implementation note:
This function may throw an IOException if an I/O error occurs * because its use of the canonical pathname may require filesystem queries. *

* diff --git a/src/main/org/apache/tools/ant/util/GlobPatternMapper.java b/src/main/org/apache/tools/ant/util/GlobPatternMapper.java index 1ba41285c..da2a0f16e 100644 --- a/src/main/org/apache/tools/ant/util/GlobPatternMapper.java +++ b/src/main/org/apache/tools/ant/util/GlobPatternMapper.java @@ -24,7 +24,7 @@ import org.apache.tools.ant.BuildException; * Implementation of FileNameMapper that does simple wildcard pattern * replacements. * - *

This does simple translations like *.foo -> *.bar where the + *

This does simple translations like *.foo -> *.bar where the * prefix to .foo will be left unchanged. It only handles a single * * character, use regular expressions for more complicated * situations.

diff --git a/src/main/org/apache/tools/ant/util/KeepAliveInputStream.java b/src/main/org/apache/tools/ant/util/KeepAliveInputStream.java index fe5e32fd7..debde59ab 100644 --- a/src/main/org/apache/tools/ant/util/KeepAliveInputStream.java +++ b/src/main/org/apache/tools/ant/util/KeepAliveInputStream.java @@ -32,7 +32,6 @@ import java.io.InputStream; * in.close(); * } * - *

* * @since Ant 1.6 */ diff --git a/src/main/org/apache/tools/ant/util/KeepAliveOutputStream.java b/src/main/org/apache/tools/ant/util/KeepAliveOutputStream.java index 9f5c06b96..27f3d7e42 100644 --- a/src/main/org/apache/tools/ant/util/KeepAliveOutputStream.java +++ b/src/main/org/apache/tools/ant/util/KeepAliveOutputStream.java @@ -29,11 +29,10 @@ import java.io.PrintStream; *

* In code-language it means that it is not necessary to do: * 

- * if (out != System.out && out!= System.err) {
+ * if (out != System.out && out != System.err) {
  *   out.close();
  * }
  *
- *

* */ public class KeepAliveOutputStream extends FilterOutputStream { diff --git a/src/main/org/apache/tools/ant/util/LayoutPreservingProperties.java b/src/main/org/apache/tools/ant/util/LayoutPreservingProperties.java index ea0ea9354..aed6f3717 100644 --- a/src/main/org/apache/tools/ant/util/LayoutPreservingProperties.java +++ b/src/main/org/apache/tools/ant/util/LayoutPreservingProperties.java @@ -40,7 +40,7 @@ import java.util.Properties; * class to there, but it also keeps track of the contents of the * input stream from which it was loaded (if applicable), so that it can * write out the properties in as close a form as possible to the input.

- * If no changes occur to property values, the output should be the same + *

If no changes occur to property values, the output should be the same * as the input, except for the leading date stamp, as normal for a * properties file. Properties added are appended to the file. Properties * whose values are changed are changed in place. Properties that are @@ -63,7 +63,7 @@ import java.util.Properties; * * # and finally * gamma=rays - *

The resulting collection sequence of logical lines depends on whether + *

The resulting collection sequence of logical lines depends on whether * or not removeComments was set at the time the second stream * is loaded. If it is set, then the resulting list of lines is

* 
 # the first line
diff --git a/src/main/org/apache/tools/ant/util/LeadPipeInputStream.java b/src/main/org/apache/tools/ant/util/LeadPipeInputStream.java
index 37650cc69..00819128e 100644
--- a/src/main/org/apache/tools/ant/util/LeadPipeInputStream.java
+++ b/src/main/org/apache/tools/ant/util/LeadPipeInputStream.java
@@ -103,7 +103,7 @@ public class LeadPipeInputStream extends PipedInputStream {
 
     /**
      * Set the size of the buffer.
-     * @param size   the new buffer size.  Ignored if <= current size.
+     * @param size   the new buffer size.  Ignored if <= current size.
      */
     public synchronized void setBufferSize(int size) {
         if (size > buffer.length) {
diff --git a/src/main/org/apache/tools/ant/util/ProxySetup.java b/src/main/org/apache/tools/ant/util/ProxySetup.java
index 5be1e27bd..f077f87c7 100644
--- a/src/main/org/apache/tools/ant/util/ProxySetup.java
+++ b/src/main/org/apache/tools/ant/util/ProxySetup.java
@@ -34,7 +34,6 @@ public class ProxySetup {
 
     /**
      * Java1.5 property that enables use of system proxies.
-     * @value
      */
     public static final String USE_SYSTEM_PROXIES = "java.net.useSystemProxies";
     /** the http proxyhost property */
diff --git a/src/main/org/apache/tools/ant/util/ScriptFixBSFPath.java b/src/main/org/apache/tools/ant/util/ScriptFixBSFPath.java
index 0b8bf98e3..ca76e56b7 100644
--- a/src/main/org/apache/tools/ant/util/ScriptFixBSFPath.java
+++ b/src/main/org/apache/tools/ant/util/ScriptFixBSFPath.java
@@ -86,7 +86,7 @@ public class ScriptFixBSFPath {
      * 
      *
      * Assume a simple model for the loader:
-     *  thisloader<-customloader
+     *  thisloader<-customloader
      *  or
      *  thisloader
      *
diff --git a/src/main/org/apache/tools/ant/util/StringUtils.java b/src/main/org/apache/tools/ant/util/StringUtils.java
index b11f92ae3..626fb224b 100644
--- a/src/main/org/apache/tools/ant/util/StringUtils.java
+++ b/src/main/org/apache/tools/ant/util/StringUtils.java
@@ -140,7 +140,7 @@ public final class StringUtils {
      * xml does not do "c" like interpretation of strings.
      * i.e. \n\r\t etc.
      * this method processes \n, \r, \t, \f, \\
-     * also subs \s -> " \n\r\t\f"
+     * also subs \s -> " \n\r\t\f"
      * a trailing '\' will be ignored
      *
      * @param input raw string with possible embedded '\'s
diff --git a/src/main/org/apache/tools/ant/util/Watchdog.java b/src/main/org/apache/tools/ant/util/Watchdog.java
index 393bc7b67..318b52643 100644
--- a/src/main/org/apache/tools/ant/util/Watchdog.java
+++ b/src/main/org/apache/tools/ant/util/Watchdog.java
@@ -46,7 +46,7 @@ public class Watchdog implements Runnable {
 
     /**
      * Constructor for Watchdog.
-     * @param timeout the timeout to use in milliseconds (must be >= 1).
+     * @param timeout the timeout to use in milliseconds (must be >= 1).
      */
     public Watchdog(long timeout) {
         if (timeout < 1) {
diff --git a/src/main/org/apache/tools/ant/util/WorkerAnt.java b/src/main/org/apache/tools/ant/util/WorkerAnt.java
index a30427882..288d74dd5 100644
--- a/src/main/org/apache/tools/ant/util/WorkerAnt.java
+++ b/src/main/org/apache/tools/ant/util/WorkerAnt.java
@@ -26,7 +26,7 @@ import org.apache.tools.ant.Task;
  * After the run, any exception thrown is turned into a buildexception, which can be
  * rethrown, the finished attribute is set, then notifyAll() is called,
  * so that anyone waiting on the same notify object gets woken up.
- * 

+ * 

  * This class is effectively a superset of
  * {@link org.apache.tools.ant.taskdefs.Parallel.TaskRunnable}
  *
@@ -49,7 +49,7 @@ public class WorkerAnt extends Thread {
 
     /**
      * Create the worker.
-     * 

+     * 

      * This does not start the thread, merely configures it.
      * @param task the task
      * @param notify what to notify
@@ -61,7 +61,7 @@ public class WorkerAnt extends Thread {
 
     /**
      * Create the worker, using the worker as the notification point.
-     * 

+     * 

      * This does not start the thread, merely configures it.
      * @param task the task
      */
@@ -83,7 +83,7 @@ public class WorkerAnt extends Thread {
 
     /**
      * Get whatever was thrown, which may or may not be a buildException.
-     * Assertion: getException() instanceof BuildException <=> getBuildException()==getException()
+     * Assertion: getException() instanceof BuildException <=> getBuildException()==getException()
      * @return the exception.
      */
     public synchronized Throwable getException() {
diff --git a/src/main/org/apache/tools/bzip2/CBZip2OutputStream.java b/src/main/org/apache/tools/bzip2/CBZip2OutputStream.java
index 965b7a2a6..01e23424d 100644
--- a/src/main/org/apache/tools/bzip2/CBZip2OutputStream.java
+++ b/src/main/org/apache/tools/bzip2/CBZip2OutputStream.java
@@ -613,7 +613,7 @@ public class CBZip2OutputStream extends OutputStream
      * @throws IOException
      *             if an I/O error occurs in the specified stream.
      * @throws IllegalArgumentException
-     *             if (blockSize < 1) || (blockSize > 9).
+     *             if (blockSize < 1) || (blockSize > 9).
      * @throws NullPointerException
      *             if out == null.
      *