commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject svn commit: r1441399 - /commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/checkdigit/IBANCheckDigit.java
Date Fri, 01 Feb 2013 11:48:59 GMT
Author: sebb
Date: Fri Feb  1 11:48:59 2013
New Revision: 1441399

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

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

Modified: commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/checkdigit/IBANCheckDigit.java
URL: http://svn.apache.org/viewvc/commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/checkdigit/IBANCheckDigit.java?rev=1441399&r1=1441398&r2=1441399&view=diff
==============================================================================
--- commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/checkdigit/IBANCheckDigit.java
(original)
+++ commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/checkdigit/IBANCheckDigit.java
Fri Feb  1 11:48:59 2013
@@ -21,7 +21,7 @@ import java.io.Serializable;
 /**
  * <b>IBAN</b> (International Bank Account Number) Check Digit calculation/validation.
  * <p>
- * This rountine is based on the ISO 7064 Mod 97,10 check digit caluclation routine.
+ * This routine is based on the ISO 7064 Mod 97,10 check digit calculation routine.
  * <p>
  * The two check digit characters in a IBAN number are the third and fourth characters
  * in the code. For <i>check digit</i> calculation/validation the first four
characters are moved
@@ -31,6 +31,8 @@ import java.io.Serializable;
  *  check digit calcualtion the check digit value should be set to zero (i.e.
  *  <code>CC00nnnnnnn</code> in this example.
  * <p>
+ * Note: the class does not check the format of the IBAN number, only the check digits.
+ * <p>
  * For further information see
  *  <a href="http://en.wikipedia.org/wiki/International_Bank_Account_Number">Wikipedia
-
  *  IBAN number</a>.
@@ -56,7 +58,7 @@ public final class IBANCheckDigit implem
     }
 
     /**
-     * Validate the check digit for an the IBAN code.
+     * Validate the check digit of an IBAN code.
      *
      * @param code The code to validate
      * @return <code>true</code> if the check digit is valid, otherwise
@@ -81,7 +83,7 @@ public final class IBANCheckDigit implem
      * characters and and should contain value "<code>00</code>".
      *
      * @param code The code to calculate the Check Digit for
-     * @return The calculated Check Digit
+     * @return The calculated Check Digit as 2 numeric decimal characters, e.g. "42"
      * @throws CheckDigitException if an error occurs calculating
      * the check digit for the specified code
      */



Mime
View raw message