You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2020/09/02 15:18:08 UTC
[commons-io] branch master updated: Javadoc: Close paragraph tags.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-io.git
The following commit(s) were added to refs/heads/master by this push:
new 269edfd Javadoc: Close paragraph tags.
269edfd is described below
commit 269edfd2ed6fbb86ef81b77dd5fafcab7583209d
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Wed Sep 2 11:17:59 2020 -0400
Javadoc: Close paragraph tags.
---
.../java/org/apache/commons/io/input/CloseShieldReader.java | 2 +-
.../java/org/apache/commons/io/input/ClosedInputStream.java | 1 +
.../org/apache/commons/io/input/CountingInputStream.java | 2 +-
.../java/org/apache/commons/io/input/DemuxInputStream.java | 1 -
.../java/org/apache/commons/io/input/ProxyInputStream.java | 3 ++-
src/main/java/org/apache/commons/io/input/ProxyReader.java | 2 +-
.../java/org/apache/commons/io/input/ReaderInputStream.java | 2 ++
.../org/apache/commons/io/input/SwappedDataInputStream.java | 1 +
src/main/java/org/apache/commons/io/input/Tailer.java | 13 ++++++++-----
.../java/org/apache/commons/io/input/XmlStreamReader.java | 5 +++++
.../apache/commons/io/input/XmlStreamReaderException.java | 3 +++
11 files changed, 25 insertions(+), 10 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/input/CloseShieldReader.java b/src/main/java/org/apache/commons/io/input/CloseShieldReader.java
index ca8f1bc..612feb5 100644
--- a/src/main/java/org/apache/commons/io/input/CloseShieldReader.java
+++ b/src/main/java/org/apache/commons/io/input/CloseShieldReader.java
@@ -24,7 +24,7 @@ import java.io.Reader;
* This class is typically used in cases where a reader needs to be
* passed to a component that wants to explicitly close the reader even if
* more input would still be available to other components.
- * <p>
+ * </p>
*
* @since 2.7
*/
diff --git a/src/main/java/org/apache/commons/io/input/ClosedInputStream.java b/src/main/java/org/apache/commons/io/input/ClosedInputStream.java
index 078fd02..492743c 100644
--- a/src/main/java/org/apache/commons/io/input/ClosedInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ClosedInputStream.java
@@ -27,6 +27,7 @@ import java.io.InputStream;
* Typically uses of this class include testing for corner cases in methods
* that accept input streams and acting as a sentinel value instead of a
* {@code null} input stream.
+ * </p>
*
* @since 1.4
*/
diff --git a/src/main/java/org/apache/commons/io/input/CountingInputStream.java b/src/main/java/org/apache/commons/io/input/CountingInputStream.java
index 2374da9..7791670 100644
--- a/src/main/java/org/apache/commons/io/input/CountingInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/CountingInputStream.java
@@ -27,7 +27,7 @@ import java.io.InputStream;
* <p>
* A typical use case would be during debugging, to ensure that data is being
* read as expected.
- *
+ * </p>
*/
public class CountingInputStream extends ProxyInputStream {
diff --git a/src/main/java/org/apache/commons/io/input/DemuxInputStream.java b/src/main/java/org/apache/commons/io/input/DemuxInputStream.java
index 61457ba..775478e 100644
--- a/src/main/java/org/apache/commons/io/input/DemuxInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/DemuxInputStream.java
@@ -25,7 +25,6 @@ import org.apache.commons.io.IOUtils;
/**
* Data written to this stream is forwarded to a stream that has been associated with this thread.
- *
*/
public class DemuxInputStream extends InputStream {
private final InheritableThreadLocal<InputStream> inputStream = new InheritableThreadLocal<>();
diff --git a/src/main/java/org/apache/commons/io/input/ProxyInputStream.java b/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
index 418305c..2e5a1af 100644
--- a/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
@@ -32,10 +32,11 @@ import org.apache.commons.io.IOUtils;
* It is an alternative base class to FilterInputStream
* to increase reusability, because FilterInputStream changes the
* methods being called, such as read(byte[]) to read(byte[], int, int).
+ * </p>
* <p>
* See the protected methods for ways in which a subclass can easily decorate
* a stream with custom pre-, post- or error processing functionality.
- *
+ * </p>
*/
public abstract class ProxyInputStream extends FilterInputStream {
diff --git a/src/main/java/org/apache/commons/io/input/ProxyReader.java b/src/main/java/org/apache/commons/io/input/ProxyReader.java
index bb0ef90..6bc9c64 100644
--- a/src/main/java/org/apache/commons/io/input/ProxyReader.java
+++ b/src/main/java/org/apache/commons/io/input/ProxyReader.java
@@ -33,7 +33,7 @@ import org.apache.commons.io.IOUtils;
* It is an alternative base class to FilterReader
* to increase reusability, because FilterReader changes the
* methods being called, such as read(char[]) to read(char[], int, int).
- *
+ * </p>
*/
public abstract class ProxyReader extends FilterReader {
diff --git a/src/main/java/org/apache/commons/io/input/ReaderInputStream.java b/src/main/java/org/apache/commons/io/input/ReaderInputStream.java
index 64a3aed..79bc9fe 100644
--- a/src/main/java/org/apache/commons/io/input/ReaderInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ReaderInputStream.java
@@ -70,8 +70,10 @@ import java.util.Objects;
* read operation will block or not, it is not possible to provide a meaningful
* implementation of the {@link InputStream#available()} method. A call to this method
* will always return 0. Also, this class doesn't support {@link InputStream#mark(int)}.
+ * </p>
* <p>
* Instances of {@link ReaderInputStream} are not thread safe.
+ * </p>
*
* @see org.apache.commons.io.output.WriterOutputStream
*
diff --git a/src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java b/src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java
index 3c12a20..7993f32 100644
--- a/src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java
@@ -31,6 +31,7 @@ import org.apache.commons.io.EndianUtils;
* endian formats for internal usage.
* <p>
* <b>Origin of code: </b>Avalon Excalibur (IO)
+ * </p>
*
*/
public class SwappedDataInputStream extends ProxyInputStream
diff --git a/src/main/java/org/apache/commons/io/input/Tailer.java b/src/main/java/org/apache/commons/io/input/Tailer.java
index 389a3e9..6d2ac52 100644
--- a/src/main/java/org/apache/commons/io/input/Tailer.java
+++ b/src/main/java/org/apache/commons/io/input/Tailer.java
@@ -105,16 +105,19 @@ import org.apache.commons.io.IOUtils;
* </pre>
*
* <h2>4. Interrupting a Tailer</h2>
- * <p>You can interrupt the thread a tailer is running on by calling {@link Thread#interrupt()}.</p>
+ * <p>You can interrupt the thread a tailer is running on by calling {@link Thread#interrupt()}.
+ * </p>
* <pre>
* thread.interrupt();
* </pre>
- * <p>If you interrupt a tailer, the tailer listener is called with the {@link InterruptedException}.</p>
- *
- * <p>The file is read using the default charset; this can be overridden if necessary</p>
+ * <p>
+ * If you interrupt a tailer, the tailer listener is called with the {@link InterruptedException}.
+ * </p>
+ * <p>
+ * The file is read using the default charset; this can be overridden if necessary.
+ * </p>
* @see TailerListener
* @see TailerListenerAdapter
- *
* @since 2.0
* @since 2.5 Updated behavior and documentation for {@link Thread#interrupt()}
*/
diff --git a/src/main/java/org/apache/commons/io/input/XmlStreamReader.java b/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
index 2bf918f..495b315 100644
--- a/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
+++ b/src/main/java/org/apache/commons/io/input/XmlStreamReader.java
@@ -43,23 +43,28 @@ import org.apache.commons.io.IOUtils;
* <p>
* IMPORTANT: This class is not related in any way to the org.xml.sax.XMLReader.
* This one IS a character stream.
+ * </p>
* <p>
* All this has to be done without consuming characters from the stream, if not
* the XML parser will not recognized the document as a valid XML. This is not
* 100% true, but it's close enough (UTF-8 BOM is not handled by all parsers
* right now, XmlStreamReader handles it and things work in all parsers).
+ * </p>
* <p>
* The XmlStreamReader class handles the charset encoding of XML documents in
* Files, raw streams and HTTP streams by offering a wide set of constructors.
+ * </p>
* <p>
* By default the charset encoding detection is lenient, the constructor with
* the lenient flag can be used for a script (following HTTP MIME and XML
* specifications). All this is nicely explained by Mark Pilgrim in his blog, <a
* href="http://diveintomark.org/archives/2004/02/13/xml-media-types">
* Determining the character encoding of a feed</a>.
+ * </p>
* <p>
* Originally developed for <a href="http://rome.dev.java.net">ROME</a> under
* Apache License 2.0.
+ * </p>
*
* @see org.apache.commons.io.output.XmlStreamWriter
* @since 2.0
diff --git a/src/main/java/org/apache/commons/io/input/XmlStreamReaderException.java b/src/main/java/org/apache/commons/io/input/XmlStreamReaderException.java
index 0508f04..ca61be7 100644
--- a/src/main/java/org/apache/commons/io/input/XmlStreamReaderException.java
+++ b/src/main/java/org/apache/commons/io/input/XmlStreamReaderException.java
@@ -27,6 +27,7 @@ import java.io.IOException;
* do an alternate processing with the stream. Note that the original
* InputStream given to the XmlStreamReader cannot be used as that one has been
* already read.
+ * </p>
*
* @since 2.0
*/
@@ -49,6 +50,7 @@ public class XmlStreamReaderException extends IOException {
* determined.
* <p>
* Instances of this exception are thrown by the XmlStreamReader.
+ * </p>
*
* @param msg message describing the reason for the exception.
* @param bomEnc BOM encoding.
@@ -65,6 +67,7 @@ public class XmlStreamReaderException extends IOException {
* determined.
* <p>
* Instances of this exception are thrown by the XmlStreamReader.
+ * </p>
*
* @param msg message describing the reason for the exception.
* @param ctMime MIME type in the content-type.