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 591f798 Javadoc: Close HTML tags. 591f798 is described below commit 591f798ebb097737295a0ed7c7f90a862b331deb Author: Gary Gregory <gardgreg...@gmail.com> AuthorDate: Sun Jan 31 10:20:03 2021 -0500 Javadoc: Close HTML tags. --- .../java/org/apache/commons/io/output/AppendableOutputStream.java | 1 + src/main/java/org/apache/commons/io/output/BrokenOutputStream.java | 1 + src/main/java/org/apache/commons/io/output/BrokenWriter.java | 1 + .../java/org/apache/commons/io/output/CountingOutputStream.java | 1 + .../java/org/apache/commons/io/output/DeferredFileOutputStream.java | 1 + .../java/org/apache/commons/io/output/FileWriterWithEncoding.java | 6 +++--- src/main/java/org/apache/commons/io/output/ProxyOutputStream.java | 1 + src/main/java/org/apache/commons/io/output/StringBuilderWriter.java | 1 + src/main/java/org/apache/commons/io/output/TaggedOutputStream.java | 1 + src/main/java/org/apache/commons/io/output/TaggedWriter.java | 1 + .../java/org/apache/commons/io/output/ThresholdingOutputStream.java | 2 ++ src/main/java/org/apache/commons/io/output/WriterOutputStream.java | 3 ++- 12 files changed, 16 insertions(+), 4 deletions(-) diff --git a/src/main/java/org/apache/commons/io/output/AppendableOutputStream.java b/src/main/java/org/apache/commons/io/output/AppendableOutputStream.java index 25f1ad2..fd818b1 100644 --- a/src/main/java/org/apache/commons/io/output/AppendableOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/AppendableOutputStream.java @@ -25,6 +25,7 @@ import java.io.OutputStream; * <p> * For example, can be used with any {@link java.io.Writer} or a {@link java.lang.StringBuilder} * or {@link java.lang.StringBuffer}. + * </p> * * @since 2.5 * @see java.lang.Appendable diff --git a/src/main/java/org/apache/commons/io/output/BrokenOutputStream.java b/src/main/java/org/apache/commons/io/output/BrokenOutputStream.java index 1bfb7a1..70befe2 100644 --- a/src/main/java/org/apache/commons/io/output/BrokenOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/BrokenOutputStream.java @@ -25,6 +25,7 @@ import java.io.OutputStream; * <p> * This class is mostly useful for testing error handling in code that uses an * output stream. + * </p> * * @since 2.0 */ diff --git a/src/main/java/org/apache/commons/io/output/BrokenWriter.java b/src/main/java/org/apache/commons/io/output/BrokenWriter.java index 15737e1..547de29 100644 --- a/src/main/java/org/apache/commons/io/output/BrokenWriter.java +++ b/src/main/java/org/apache/commons/io/output/BrokenWriter.java @@ -25,6 +25,7 @@ import java.io.Writer; * <p> * This class is mostly useful for testing error handling in code that uses a * writer. + * </p> * * @since 2.0 */ diff --git a/src/main/java/org/apache/commons/io/output/CountingOutputStream.java b/src/main/java/org/apache/commons/io/output/CountingOutputStream.java index f27e7ff..4650a5e 100644 --- a/src/main/java/org/apache/commons/io/output/CountingOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/CountingOutputStream.java @@ -24,6 +24,7 @@ import java.io.OutputStream; * <p> * A typical use case would be during debugging, to ensure that data is being * written as expected. + * </p> * */ public class CountingOutputStream extends ProxyOutputStream { diff --git a/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java b/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java index 8e934f4..25773fc 100644 --- a/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java @@ -32,6 +32,7 @@ import org.apache.commons.io.IOUtils; * This class originated in FileUpload processing. In this use case, you do not know in advance the size of the file * being uploaded. If the file is small you want to store it in memory (for speed), but if the file is large you want to * store it to file (to avoid memory issues). + * </p> */ public class DeferredFileOutputStream extends ThresholdingOutputStream { diff --git a/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java b/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java index 12d5942..50cb2ba 100644 --- a/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java +++ b/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java @@ -35,18 +35,18 @@ import org.apache.commons.io.IOUtils; * This class provides a simple alternative to {@code FileWriter} * that allows an encoding to be set. Unfortunately, it cannot subclass * {@code FileWriter}. + * </p> * <p> * By default, the file will be overwritten, but this may be changed to append. + * </p> * <p> * The encoding must be specified using either the name of the {@link Charset}, * the {@link Charset}, or a {@link CharsetEncoder}. If the default encoding * is required then use the {@link java.io.FileWriter} directly, rather than * this implementation. - * <p> - * + * </p> * * @since 1.4 - * */ public class FileWriterWithEncoding extends Writer { // Cannot extend ProxyWriter, as requires writer to be diff --git a/src/main/java/org/apache/commons/io/output/ProxyOutputStream.java b/src/main/java/org/apache/commons/io/output/ProxyOutputStream.java index f3a1119..1679114 100644 --- a/src/main/java/org/apache/commons/io/output/ProxyOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/ProxyOutputStream.java @@ -30,6 +30,7 @@ import org.apache.commons.io.IOUtils; * <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 class ProxyOutputStream extends FilterOutputStream { diff --git a/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java b/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java index 684c440..261714e 100644 --- a/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java +++ b/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java @@ -27,6 +27,7 @@ import java.io.Writer; * (i.e. for use in a single thread) implementation for better performance. * For safe usage with multiple {@link Thread}s then * {@code java.io.StringWriter} should be used. + * </p> * * @since 2.0 */ diff --git a/src/main/java/org/apache/commons/io/output/TaggedOutputStream.java b/src/main/java/org/apache/commons/io/output/TaggedOutputStream.java index 15a95dd..50f373f 100644 --- a/src/main/java/org/apache/commons/io/output/TaggedOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/TaggedOutputStream.java @@ -48,6 +48,7 @@ import org.apache.commons.io.TaggedIOException; * used to let higher levels of code handle the exception caused by this * stream while other processing errors are being taken care of at this * lower level. + * </p> * <pre> * TaggedOutputStream stream = new TaggedOutputStream(...); * try { diff --git a/src/main/java/org/apache/commons/io/output/TaggedWriter.java b/src/main/java/org/apache/commons/io/output/TaggedWriter.java index 24b7f88..00f9f03 100644 --- a/src/main/java/org/apache/commons/io/output/TaggedWriter.java +++ b/src/main/java/org/apache/commons/io/output/TaggedWriter.java @@ -48,6 +48,7 @@ import org.apache.commons.io.TaggedIOException; * used to let higher levels of code handle the exception caused by this * writer while other processing errors are being taken care of at this * lower level. + * </p> * <pre> * TaggedWriter writer = new TaggedWriter(...); * try { diff --git a/src/main/java/org/apache/commons/io/output/ThresholdingOutputStream.java b/src/main/java/org/apache/commons/io/output/ThresholdingOutputStream.java index 1639412..3c98108 100644 --- a/src/main/java/org/apache/commons/io/output/ThresholdingOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/ThresholdingOutputStream.java @@ -26,9 +26,11 @@ import java.io.OutputStream; * <p> * This class overrides all {@code OutputStream} methods. However, these overrides ultimately call the corresponding * methods in the underlying output stream implementation. + * </p> * <p> * NOTE: This implementation may trigger the event <em>before</em> the threshold is actually reached, since it triggers * when a pending write operation would cause the threshold to be exceeded. + * </p> */ public abstract class ThresholdingOutputStream extends OutputStream { diff --git a/src/main/java/org/apache/commons/io/output/WriterOutputStream.java b/src/main/java/org/apache/commons/io/output/WriterOutputStream.java index 176c489..d216fd4 100644 --- a/src/main/java/org/apache/commons/io/output/WriterOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/WriterOutputStream.java @@ -63,11 +63,12 @@ import java.nio.charset.CodingErrorAction; * in the design of the code. This class is typically used in situations where an existing * API only accepts an {@link OutputStream} object, but where the stream is known to represent * character data that must be decoded for further use. + * </p> * <p> * Instances of {@link WriterOutputStream} are not thread safe. + * </p> * * @see org.apache.commons.io.input.ReaderInputStream - * * @since 2.0 */ public class WriterOutputStream extends OutputStream {