svn commit: r1536473 - /commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/translate/OctalUnescaper.java

[br...@apache.org]

Author: britter
Date: Mon Oct 28 18:33:13 2013
New Revision: 1536473

URL: http://svn.apache.org/r1536473
Log:
Add missing JavaDoc

Modified:
    commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/translate/OctalUnescaper.java

Modified: commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/translate/OctalUnescaper.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/translate/OctalUnescaper.java?rev=1536473&r1=1536472&r2=1536473&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/translate/OctalUnescaper.java (original)
+++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/translate/OctalUnescaper.java Mon Oct 28 18:33:13 2013
@@ -62,10 +62,20 @@ public class OctalUnescaper extends Char
         return 0;
     }
 
+    /**
+     * Checks if the given char is an octal digit. Octal digits are the character representations of the digits 0 to 7.
+     * @param ch the char to check
+     * @return true if the given char is the character representation of one of the digits from 0 to 7
+     */
     private boolean isOctalDigit(char ch) {
         return ch >= '0' && ch <= '7';
     }
 
+    /**
+     * Checks if the given char is the character representation of one of the digit from 0 to 3.
+     * @param ch the char to check
+     * @return true if the given char is the character representation of one of the digits from 0 to 3
+     */
     private boolean isZeroToThree(char ch) {
         return ch >= '0' && ch <= '3';
     }