commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject svn commit: r1612026 - in /commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2: BZip2CompressorInputStream.java BZip2CompressorOutputStream.java
Date Sun, 20 Jul 2014 06:18:29 GMT
Author: ggregory
Date: Sun Jul 20 06:18:28 2014
New Revision: 1612026

URL: http://svn.apache.org/r1612026
Log:
Use the more modern, compact, and flexible Javadoc "{@code ...}" instead of the HTML "<tt>...</tt>".

Modified:
    commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.java
    commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java

Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.java?rev=1612026&r1=1612025&r2=1612026&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.java
(original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.java
Sun Jul 20 06:18:28 2014
@@ -103,7 +103,7 @@ public class BZip2CompressorInputStream 
      * @throws IOException
      *             if the stream content is malformed or an I/O error occurs.
      * @throws NullPointerException
-     *             if <tt>in == null</tt>
+     *             if {@code in == null}
      */
     public BZip2CompressorInputStream(final InputStream in) throws IOException {
         this(in, false);
@@ -123,7 +123,7 @@ public class BZip2CompressorInputStream 
      * @throws IOException
      *             if the stream content is malformed or an I/O error occurs.
      * @throws NullPointerException
-     *             if <tt>in == null</tt>
+     *             if {@code in == null}
      */
     public BZip2CompressorInputStream(final InputStream in, final boolean decompressConcatenated)
throws IOException {
         this.in = in;

Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java?rev=1612026&r1=1612025&r2=1612026&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java
(original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java
Sun Jul 20 06:18:28 2014
@@ -29,7 +29,7 @@ import org.apache.commons.compress.compr
  * <p>
  * The compression requires large amounts of memory. Thus you should call the
  * {@link #close() close()} method as soon as possible, to force
- * <tt>BZip2CompressorOutputStream</tt> to release the allocated memory.
+ * {@code BZip2CompressorOutputStream} to release the allocated memory.
  * </p>
  *
  * <p> You can shrink the amount of allocated memory and maybe raise
@@ -109,7 +109,7 @@ import org.apache.commons.compress.compr
  * </table>
  *
  * <p>
- * For decompression <tt>BZip2CompressorInputStream</tt> allocates less memory
if the
+ * For decompression {@code BZip2CompressorInputStream} allocates less memory if the
  * bzipped input is smaller than one block.
  * </p>
  *
@@ -126,12 +126,12 @@ public class BZip2CompressorOutputStream
     implements BZip2Constants {
 
     /**
-     * The minimum supported blocksize <tt> == 1</tt>.
+     * The minimum supported blocksize {@code  == 1}.
      */
     public static final int MIN_BLOCKSIZE = 1;
 
     /**
-     * The maximum supported blocksize <tt> == 9</tt>.
+     * The maximum supported blocksize {@code  == 9}.
      */
     public static final int MAX_BLOCKSIZE = 9;
 
@@ -328,12 +328,12 @@ public class BZip2CompressorOutputStream
      *
      * @return The blocksize, between {@link #MIN_BLOCKSIZE} and
      *         {@link #MAX_BLOCKSIZE} both inclusive. For a negative
-     *         <tt>inputLength</tt> this method returns <tt>MAX_BLOCKSIZE</tt>
+     *         {@code inputLength} this method returns {@code MAX_BLOCKSIZE}
      *         always.
      *
      * @param inputLength
      *            The length of the data which will be compressed by
-     *            <tt>BZip2CompressorOutputStream</tt>.
+     *            {@code BZip2CompressorOutputStream}.
      */
     public static int chooseBlockSize(long inputLength) {
         return (inputLength > 0) ? (int) Math
@@ -341,7 +341,7 @@ public class BZip2CompressorOutputStream
     }
 
     /**
-     * Constructs a new <tt>BZip2CompressorOutputStream</tt> with a blocksize
of 900k.
+     * Constructs a new {@code BZip2CompressorOutputStream} with a blocksize of 900k.
      *
      * @param out 
      *            the destination stream.
@@ -357,7 +357,7 @@ public class BZip2CompressorOutputStream
     }
 
     /**
-     * Constructs a new <tt>BZip2CompressorOutputStream</tt> with specified blocksize.
+     * Constructs a new {@code BZip2CompressorOutputStream} with specified blocksize.
      *
      * @param out
      *            the destination stream.



Mime
View raw message