formatting changes and added @since tags

javadoc - at least the Java8 flavor - doesn't like self-closing tags.

closes #34


Project: http://git-wip-us.apache.org/repos/asf/commons-compress/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-compress/commit/fd7b3c16
Tree: http://git-wip-us.apache.org/repos/asf/commons-compress/tree/fd7b3c16
Diff: http://git-wip-us.apache.org/repos/asf/commons-compress/diff/fd7b3c16

Branch: refs/heads/master
Commit: fd7b3c165f903c6c2b680bbbf7624ccea629538b
Parents: 567dc4b
Author: Stefan Bodewig <bode...@apache.org>
Authored: Fri Jun 16 09:33:37 2017 +0200
Committer: Stefan Bodewig <bode...@apache.org>
Committed: Fri Jun 16 09:33:37 2017 +0200

----------------------------------------------------------------------
 .../utils/FixedLengthBlockOutputStream.java     | 31 ++++++++++----------
 1 file changed, 16 insertions(+), 15 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-compress/blob/fd7b3c16/src/main/java/org/apache/commons/compress/utils/FixedLengthBlockOutputStream.java
----------------------------------------------------------------------
diff --git 
a/src/main/java/org/apache/commons/compress/utils/FixedLengthBlockOutputStream.java
 
b/src/main/java/org/apache/commons/compress/utils/FixedLengthBlockOutputStream.java
index 9d59e99..e6fee61 100644
--- 
a/src/main/java/org/apache/commons/compress/utils/FixedLengthBlockOutputStream.java
+++ 
b/src/main/java/org/apache/commons/compress/utils/FixedLengthBlockOutputStream.java
@@ -29,22 +29,23 @@ import java.util.concurrent.atomic.AtomicBoolean;
 
 /**
  * This class supports writing to an Outputstream or WritableByteChannel in 
fixed length blocks.
- * It can be be used to support output to devices such as tape drives that 
require output in this
+ * <p>It can be be used to support output to devices such as tape drives that 
require output in this
  * format. If the final block does not have enough content to fill an entire 
block, the output will
- * be padded to a full block size.
- * <p/>
- * This class can be used to support TAR,PAX, and CPIO blocked output to 
character special devices.
+ * be padded to a full block size.</p>
+ *
+ * <p>This class can be used to support TAR,PAX, and CPIO blocked output to 
character special devices.
  * It is not recommended that this class be used unless writing to such 
devices, as the padding
- * serves no useful purpose in such cases.
- * <p/>
- * This class should normally wrap a FileOutputStream or associated 
WritableByteChannel directly.
+ * serves no useful purpose in such cases.</p>
+ *
+ * <p>This class should normally wrap a FileOutputStream or associated 
WritableByteChannel directly.
  * If there is an intervening filter that modified the output, such as a 
CompressorOutputStream, or
  * performs its own buffering, such as BufferedOutputStream,  output to the 
device may
- * no longer be of the specified size.
- * <p/>
- * Any content written to this stream should be self-delimiting and should 
tolerate any padding
- * added to fill the last block
- * .
+ * no longer be of the specified size.</p>
+ *
+ * <p>Any content written to this stream should be self-delimiting and should 
tolerate any padding
+ * added to fill the last block.</p>
+ *
+ * @since 1.15
  */
 public class FixedLengthBlockOutputStream extends OutputStream implements 
WritableByteChannel,
     AutoCloseable {
@@ -70,11 +71,11 @@ public class FixedLengthBlockOutputStream extends 
OutputStream implements Writab
         }
         this.blockSize = blockSize;
     }
-     /** Create a fixed length block output stream with given destination 
writable byte channel and block size
+     /**
+      * Create a fixed length block output stream with given destination 
writable byte channel and block size
      * @param out   The writable byte channel to wrap.
      * @param blockSize The block size to use.
-        */
-
+     */
     public FixedLengthBlockOutputStream(WritableByteChannel out, int 
blockSize) {
         this.out = out;
         this.blockSize = blockSize;

Reply via email to