]> source.dussan.org Git - poi.git/commitdiff
javadocs fixes
authorJaven O'Neal <onealj@apache.org>
Tue, 12 Apr 2016 12:19:49 +0000 (12:19 +0000)
committerJaven O'Neal <onealj@apache.org>
Tue, 12 Apr 2016 12:19:49 +0000 (12:19 +0000)
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1738789 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/poi/util/RLEDecompressingInputStream.java

index 77f84d7784d1242b07ef0e91504724448dc22e93..08d9c2f9834a26253e9b8bb163439f951c12fec1 100644 (file)
@@ -150,7 +150,7 @@ public class RLEDecompressingInputStream extends InputStream {
     /**
      * Reads a single chunk from the underlying inputstream.
      * 
-     * @return
+     * @return number of bytes that were read, or -1 if the end of the stream was reached.
      * @throws IOException
      */
     private int readChunk() throws IOException {
@@ -216,7 +216,7 @@ public class RLEDecompressingInputStream extends InputStream {
      * Helper method to determine how many bits in the CopyToken are used for the CopyLength.
      * 
      * @param offset
-     * @return
+     * @return returns the number of bits in the copy token (a value between 4 and 12)
      */
     static int getCopyLenBits(int offset) {
         for (int n = 11; n >= 4; n--) {