Title: [2101] trunk/xstream/src/java/com/thoughtworks/xstream/XStream.java: Improve javadoc.
Revision
2101
Author
joehni
Date
2013-07-20 09:36:38 -0500 (Sat, 20 Jul 2013)

Log Message

Improve javadoc.

Modified Paths


Diff

Modified: trunk/xstream/src/java/com/thoughtworks/xstream/XStream.java (2100 => 2101)


--- trunk/xstream/src/java/com/thoughtworks/xstream/XStream.java	2013-07-18 22:23:36 UTC (rev 2100)
+++ trunk/xstream/src/java/com/thoughtworks/xstream/XStream.java	2013-07-20 14:36:38 UTC (rev 2101)
@@ -519,7 +519,9 @@
      * {@link ClassLoaderReference} and an own {@link ConverterLookup} and
      * {@link ConverterRegistry}.
      * <p>
-     * The {@link ClassLoaderReference} should also be used for the {@link Mapper} chain.
+     * The ClassLoaderReference should also be used for the Mapper chain. The ConverterLookup
+     * should access the ConverterRegistry if you intent to register {@link Converter} instances
+     * with XStream facade or you are using annotations.
      * </p>
      * 
      * @param reflectionProvider the reflection provider to use or <em>null</em> for best
@@ -529,7 +531,8 @@
      * @param mapper the instance with the {@link Mapper} chain or <em>null</em> for the default
      *            chain
      * @param converterLookup the instance that is used to lookup the converters
-     * @param converterRegistry an instance to manage the converter instances
+     * @param converterRegistry an instance to manage the converter instances or <em>null</em>
+     *            to prevent any further registry (including annotations)
      * @throws InitializationException in case of an initialization problem
      * @since upcoming
      */

To unsubscribe from this list please visit:

http://xircles.codehaus.org/manage_email

Reply via email to