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

[se...@apache.org]

Author: sebb
Date: Mon Nov  9 22:28:33 2015
New Revision: 1713562

URL: http://svn.apache.org/viewvc?rev=1713562&view=rev
Log:
Javadoc

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

Modified: commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/checkdigit/ModulusCheckDigit.java
URL: http://svn.apache.org/viewvc/commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/checkdigit/ModulusCheckDigit.java?rev=1713562&r1=1713561&r2=1713562&view=diff
==============================================================================
--- commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/checkdigit/ModulusCheckDigit.java (original)
+++ commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/checkdigit/ModulusCheckDigit.java Mon Nov  9 22:28:33 2015
@@ -79,12 +79,12 @@ public abstract class ModulusCheckDigit
     }
 
     /**
-     * Calculate a modulus <i>Check Digit</i> for a code.
+     * Calculate a modulus <i>Check Digit</i> for a code which does not yet have one.
      *
-     * @param code The code to calculate the Check Digit for
+     * @param code The code for which to calculate the Check Digit; 
+     * the check digit should not be included
      * @return The calculated Check Digit
-     * @throws CheckDigitException if an error occurs calculating
-     * the check digit for the specified code
+     * @throws CheckDigitException if an error occurs calculating the check digit
      */
     public String calculate(String code) throws CheckDigitException {
         if (code == null || code.length() == 0) {