svn commit: r1738789 - /poi/trunk/src/java/org/apache/poi/util/RLEDecompressingInputStream.java

[on...@apache.org]

Author: onealj
Date: Tue Apr 12 12:19:49 2016
New Revision: 1738789

URL: http://svn.apache.org/viewvc?rev=1738789&view=rev
Log:
javadocs fixes

Modified:
    poi/trunk/src/java/org/apache/poi/util/RLEDecompressingInputStream.java

Modified: poi/trunk/src/java/org/apache/poi/util/RLEDecompressingInputStream.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/util/RLEDecompressingInputStream.java?rev=1738789&r1=1738788&r2=1738789&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/util/RLEDecompressingInputStream.java (original)
+++ poi/trunk/src/java/org/apache/poi/util/RLEDecompressingInputStream.java Tue Apr 12 12:19:49 2016
@@ -150,7 +150,7 @@ public class RLEDecompressingInputStream
     /**
      * 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
      * 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--) {



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org