svn commit: r1649287 - /commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/checkdigit/CheckDigit.java

[se...@apache.org]

Author: sebb
Date: Sun Jan  4 03:22:50 2015
New Revision: 1649287

URL: http://svn.apache.org/r1649287
Log:
Javadoc

Modified:
    commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/checkdigit/CheckDigit.java

Modified: commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/checkdigit/CheckDigit.java
URL: http://svn.apache.org/viewvc/commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/checkdigit/CheckDigit.java?rev=1649287&r1=1649286&r2=1649287&view=diff
==============================================================================
--- commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/checkdigit/CheckDigit.java (original)
+++ commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/checkdigit/CheckDigit.java Sun Jan  4 03:22:50 2015
@@ -53,6 +53,7 @@ public interface CheckDigit {
      * Calculates the <i>Check Digit</i> for a code.
      *
      * @param code The code to calculate the Check Digit for.
+     * The string must not include the check digit
      * @return The calculated Check Digit
      * @throws CheckDigitException if an error occurs.
      */
@@ -61,7 +62,7 @@ public interface CheckDigit {
     /**
      * Validates the check digit for the code.
      *
-     * @param code The code to validate.
+     * @param code The code to validate, the string must include the check digit.
      * @return <code>true</code> if the check digit is valid, otherwise
      * <code>false</code>.
      */