Adding javadoc to explain what 'Canonical' means. We only mention it on the private method

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/lang/trunk@639545 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Henri Yandell 2008-03-21 05:20:17 +00:00
parent d26784c452
commit 687f6952ce
1 changed files with 5 additions and 0 deletions

View File

@ -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