You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ant.apache.org by bo...@apache.org on 2014/07/21 07:04:20 UTC
[3/3] git commit: PR 56749 Javadoc 1.8 fixes, submitted by Ville Skyttä
PR 56749 Javadoc 1.8 fixes, submitted by Ville Skyttä
Project: http://git-wip-us.apache.org/repos/asf/ant/repo
Commit: http://git-wip-us.apache.org/repos/asf/ant/commit/8a597546
Tree: http://git-wip-us.apache.org/repos/asf/ant/tree/8a597546
Diff: http://git-wip-us.apache.org/repos/asf/ant/diff/8a597546
Branch: refs/heads/master
Commit: 8a597546b88bbde571884f302546211236d3e82e
Parents: 43844a7
Author: Ville Skyttä <vi...@iki.fi>
Authored: Sun Jul 20 11:12:46 2014 +0300
Committer: Stefan Bodewig <bo...@apache.org>
Committed: Mon Jul 21 07:03:55 2014 +0200
----------------------------------------------------------------------
src/main/org/apache/tools/ant/launch/Locator.java | 18 +++++++++---------
.../ant/taskdefs/optional/testing/Funtest.java | 2 +-
.../tools/ant/types/resources/selectors/Date.java | 6 +++---
src/main/org/apache/tools/ant/util/DOMUtils.java | 9 ++-------
src/main/org/apache/tools/ant/util/FileUtils.java | 12 ++++++------
.../apache/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 -
.../apache/tools/ant/util/ScriptFixBSFPath.java | 2 +-
.../org/apache/tools/ant/util/StringUtils.java | 2 +-
src/main/org/apache/tools/ant/util/Watchdog.java | 2 +-
src/main/org/apache/tools/ant/util/WorkerAnt.java | 8 ++++----
.../apache/tools/bzip2/CBZip2OutputStream.java | 2 +-
16 files changed, 34 insertions(+), 42 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/ant/blob/8a597546/src/main/org/apache/tools/ant/launch/Locator.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/launch/Locator.java b/src/main/org/apache/tools/ant/launch/Locator.java
index 035b8b2..4640e70 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.
- *
+ * <p>
* 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 <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=42275">running ant off a network share can cause Ant to fail</a>}
- * {@link <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=8031">use File.toURI().toURL().toExternalForm()</a>}
- * {@link <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=42222">Locator implementation not encoding URI strings properly: spaces in paths</a>}
- * It also breaks Eclipse 3.3 Betas
- * {@link <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=183283">Exception if installation path has spaces</a>}
- *
+ * <p>
+ * This is a surprisingly brittle piece of code, and has had lots of bugs filed against it:
+ * <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=42275">running ant off a network share can cause Ant to fail</a>,
+ * <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=8031">use File.toURI().toURL().toExternalForm()</a>,
+ * <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=42222">Locator implementation not encoding URI strings properly: spaces in paths</a>.
+ * It also breaks Eclipse 3.3 Betas:
+ * <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=183283">Exception if installation path has spaces</a>.
+ * <p>
* Be very careful when making changes to this class, as a break will upset a lot of people.
* @since Ant 1.6
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/8a597546/src/main/org/apache/tools/ant/taskdefs/optional/testing/Funtest.java
----------------------------------------------------------------------
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 9b3c93c..2eb357a 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.
- * <p/>
+ * <p>
* 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
http://git-wip-us.apache.org/repos/asf/ant/blob/8a597546/src/main/org/apache/tools/ant/types/resources/selectors/Date.java
----------------------------------------------------------------------
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 c48e4bc..8541e85 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;
http://git-wip-us.apache.org/repos/asf/ant/blob/8a597546/src/main/org/apache/tools/ant/util/DOMUtils.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/util/DOMUtils.java b/src/main/org/apache/tools/ant/util/DOMUtils.java
index 4c3fabe..db00213 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>
* </pre>
- * and returns <code><b></code>.</p>
+ * and returns <code><b></code>.
*
* @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 {
* <pre>
* <a>b</a>
* </pre>
- * </p>
*
* @param parent element that will receive the new element as child.
* @param content text content.
@@ -102,7 +101,6 @@ public class DOMUtils {
* <pre>
* <a><[!CDATA[b]]></a>
* </pre>
- * </p>
*
* @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>
* </pre>
- * </p>
*
* @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
* <pre>
* <a>
- * <b><![CDATA[c]]></b>
+ * <b><![CDATA[c]]></b>
* </a>
* </pre>
- * </pre>
- * </p>
*
* @param parent element that will receive the new element as child.
* @param name of the child element.
http://git-wip-us.apache.org/repos/asf/ant/blob/8a597546/src/main/org/apache/tools/ant/util/FileUtils.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/util/FileUtils.java b/src/main/org/apache/tools/ant/util/FileUtils.java
index c963f49..bcef5ec 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).<br/>
+ * (Windows).<br>
* It will return true only if 3 conditions are met :
- * <br/>
+ * <br>
* <ul>
* <li>operating system is case insensitive</li>
* <li>file exists</li>
* <li>actual name from directory reading is different from the
* supplied argument</li>
* </ul>
- * <br/>
+ * <br>
* the purpose is to identify files or directories on case-insensitive
- * filesystems whose case is not what is expected.<br/>
+ * filesystems whose case is not what is expected.<br>
* Possibly to rename them afterwards to the desired upper/lowercase
* combination.
- * <br/>
+ *
* @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.
* <p>
- * Implementation note:<br/> This function may throw an IOException if an I/O error occurs
+ * Implementation note:<br>This function may throw an IOException if an I/O error occurs
* because its use of the canonical pathname may require filesystem queries.
* </p>
*
http://git-wip-us.apache.org/repos/asf/ant/blob/8a597546/src/main/org/apache/tools/ant/util/GlobPatternMapper.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/util/GlobPatternMapper.java b/src/main/org/apache/tools/ant/util/GlobPatternMapper.java
index 1ba4128..da2a0f1 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.
*
- * <p>This does simple translations like *.foo -> *.bar where the
+ * <p>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.</p>
http://git-wip-us.apache.org/repos/asf/ant/blob/8a597546/src/main/org/apache/tools/ant/util/KeepAliveInputStream.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/util/KeepAliveInputStream.java b/src/main/org/apache/tools/ant/util/KeepAliveInputStream.java
index fe5e32f..debde59 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();
* }
* </pre>
- * </p>
*
* @since Ant 1.6
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/8a597546/src/main/org/apache/tools/ant/util/KeepAliveOutputStream.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/util/KeepAliveOutputStream.java b/src/main/org/apache/tools/ant/util/KeepAliveOutputStream.java
index 9f5c06b..27f3d7e 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;
* <p>
* In code-language it means that it is not necessary to do:
* <pre>
- * if (out != System.out && out!= System.err) {
+ * if (out != System.out && out != System.err) {
* out.close();
* }
* </pre>
- * </p>
*
*/
public class KeepAliveOutputStream extends FilterOutputStream {
http://git-wip-us.apache.org/repos/asf/ant/blob/8a597546/src/main/org/apache/tools/ant/util/LayoutPreservingProperties.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/util/LayoutPreservingProperties.java b/src/main/org/apache/tools/ant/util/LayoutPreservingProperties.java
index ea0ea93..aed6f37 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.</p>
- * If no changes occur to property values, the output should be the same
+ * <p>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</pre>
- * </p>The resulting collection sequence of logical lines depends on whether
+ * <p>The resulting collection sequence of logical lines depends on whether
* or not <code>removeComments</code> was set at the time the second stream
* is loaded. If it is set, then the resulting list of lines is</p>
* <pre> # the first line
http://git-wip-us.apache.org/repos/asf/ant/blob/8a597546/src/main/org/apache/tools/ant/util/LeadPipeInputStream.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/util/LeadPipeInputStream.java b/src/main/org/apache/tools/ant/util/LeadPipeInputStream.java
index 37650cc..0081912 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) {
http://git-wip-us.apache.org/repos/asf/ant/blob/8a597546/src/main/org/apache/tools/ant/util/ProxySetup.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/util/ProxySetup.java b/src/main/org/apache/tools/ant/util/ProxySetup.java
index 5be1e27..f077f87 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 */
http://git-wip-us.apache.org/repos/asf/ant/blob/8a597546/src/main/org/apache/tools/ant/util/ScriptFixBSFPath.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/util/ScriptFixBSFPath.java b/src/main/org/apache/tools/ant/util/ScriptFixBSFPath.java
index 0b8bf98..ca76e56 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 {
* </ol>
*
* Assume a simple model for the loader:
- * thisloader<-customloader
+ * thisloader<-customloader
* or
* thisloader
*
http://git-wip-us.apache.org/repos/asf/ant/blob/8a597546/src/main/org/apache/tools/ant/util/StringUtils.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/util/StringUtils.java b/src/main/org/apache/tools/ant/util/StringUtils.java
index b11f92a..626fb22 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
http://git-wip-us.apache.org/repos/asf/ant/blob/8a597546/src/main/org/apache/tools/ant/util/Watchdog.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/util/Watchdog.java b/src/main/org/apache/tools/ant/util/Watchdog.java
index 393bc7b..318b526 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) {
http://git-wip-us.apache.org/repos/asf/ant/blob/8a597546/src/main/org/apache/tools/ant/util/WorkerAnt.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/ant/util/WorkerAnt.java b/src/main/org/apache/tools/ant/util/WorkerAnt.java
index a304278..288d74d 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.
- * </p>
+ * <p>
* 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.
- * <p/>
+ * <p>
* 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.
- * <p/>
+ * <p>
* 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() {
http://git-wip-us.apache.org/repos/asf/ant/blob/8a597546/src/main/org/apache/tools/bzip2/CBZip2OutputStream.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/bzip2/CBZip2OutputStream.java b/src/main/org/apache/tools/bzip2/CBZip2OutputStream.java
index 965b7a2..01e2342 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 <code>(blockSize < 1) || (blockSize > 9)</code>.
+ * if <code>(blockSize < 1) || (blockSize > 9)</code>.
* @throws NullPointerException
* if <code>out == null</code>.
*