svn commit: r639545 - /commons/proper/lang/trunk/src/java/org/apache/commons/lang/ClassUtils.java

[ba...@apache.org]

Author: bayard
Date: Thu Mar 20 22:20:17 2008
New Revision: 639545

URL: http://svn.apache.org/viewvc?rev=639545&view=rev
Log:
Adding javadoc to explain what 'Canonical' means. We only mention it on the private method

Modified:
    commons/proper/lang/trunk/src/java/org/apache/commons/lang/ClassUtils.java

Modified: commons/proper/lang/trunk/src/java/org/apache/commons/lang/ClassUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/java/org/apache/commons/lang/ClassUtils.java?rev=639545&r1=639544&r2=639545&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/java/org/apache/commons/lang/ClassUtils.java (original)
+++ commons/proper/lang/trunk/src/java/org/apache/commons/lang/ClassUtils.java Thu Mar 20 22:20:17 2008
@@ -31,6 +31,11 @@
  * <p>This class handles invalid <code>null</code> inputs as best it can.
  * Each method documents its behaviour in more detail.</p>
  *
+ * <p>The notion of a <code>canonical name</code> includes the human 
+ * readable name for the type, for example <code>int[]</code>. The 
+ * non-canonical method variants work with the JVM names, such as 
+ * <code>[I</code>. </p>
+ *
  * @author Stephen Colebourne
  * @author Gary Gregory
  * @author Norm Deane