svn commit: r1510052 - /commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/Converters.java

[adrianc]

Author: adrianc
Date: Sat Aug  3 18:35:26 2013
New Revision: 1510052

URL: http://svn.apache.org/r1510052
Log:
Added "How to convert" info to JavaDocs.

Modified:
    
commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/Converters.java

Modified: 
commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/Converters.java
URL: 
http://svn.apache.org/viewvc/commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/Converters.java?rev=1510052&r1=1510051&r2=1510052&view=diff
==============================================================================
--- 
commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/Converters.java
 (original)
+++ 
commons/sandbox/convert/trunk/src/main/java/org/apache/commons/convert/Converters.java
 Sat Aug  3 18:35:26 2013
@@ -39,6 +39,10 @@ import javax.imageio.spi.ServiceRegistry
  * <li>Create a 
<code>META-INF/services/org.apache.commons.convert.ConverterLoader</code>
  * file that contains the {@link org.apache.commons.convert.ConverterLoader} 
class name(s)</li>
  * </ul></p>
+ * <p>To convert an object, call the static {@link #getConverter(Class, 
Class)} method to
+ * get a {@link org.apache.commons.convert.Converter} instance, then call the 
converter's
+ * {@link org.apache.commons.convert.Converter#convert(Object)} method.
+ * </p>
  */
 public class Converters {
     protected static final String DELIMITER = "->";