svn commit: r552613 - /velocity/tools/branches/2.x/src/main/java/org/apache/velocity/tools/config/ToolConfiguration.java

[nb...@apache.org]

Author: nbubna
Date: Mon Jul  2 15:35:01 2007
New Revision: 552613

URL: http://svn.apache.org/viewvc?view=rev&rev=552613
Log:
update javadoc to reflect r552611

Modified:
    velocity/tools/branches/2.x/src/main/java/org/apache/velocity/tools/config/ToolConfiguration.java

Modified: velocity/tools/branches/2.x/src/main/java/org/apache/velocity/tools/config/ToolConfiguration.java
URL: http://svn.apache.org/viewvc/velocity/tools/branches/2.x/src/main/java/org/apache/velocity/tools/config/ToolConfiguration.java?view=diff&rev=552613&r1=552612&r2=552613
==============================================================================
--- velocity/tools/branches/2.x/src/main/java/org/apache/velocity/tools/config/ToolConfiguration.java (original)
+++ velocity/tools/branches/2.x/src/main/java/org/apache/velocity/tools/config/ToolConfiguration.java Mon Jul  2 15:35:01 2007
@@ -71,9 +71,10 @@
     /**
      * Returns the key set for this tool, if not {@link null}.  Otherwise,
      * looks for a {@link DefaultKey} annotation on the tool class.  Finally,
-     * if there is no default key, the {@link Class#getSimpleName()} is used
-     * as the key.  This should only return {@link null} if there is no key
-     * and no classname set for this tool.
+     * if there is no default key set, the {@link Class#getSimpleName()} is 
+     * transformed into the key by removing any 'Tool' suffix and lowercasing
+     * the first character.  This will only return {@link null} if there is
+     * both no key and no classname set for this tool.
      */
     public String getKey()
     {