added recommendations on using shortcut methods
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/digester/trunk@1300903 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/core/src/main/java/org/apache/commons/digester3/binder/DigesterLoader.java b/core/src/main/java/org/apache/commons/digester3/binder/DigesterLoader.java
index e8f4c5a..7e452e7 100644
--- a/core/src/main/java/org/apache/commons/digester3/binder/DigesterLoader.java
+++ b/core/src/main/java/org/apache/commons/digester3/binder/DigesterLoader.java
@@ -525,6 +525,9 @@
* Creates a new {@link XMLReader} instance that relies on the given {@code XMLReader}
* and the default {@link Rules} implementation.
*
+ * <b>WARNING</b> Input {@link XMLReader} will be linked to built Digester instance so it is recommended
+ * to <b>NOT</b> share same {@link XMLReader} instance to produce the Digester.
+ *
* @param reader The user defined {@code XMLReader}
* @return a new {@link Digester} instance
*/
@@ -537,6 +540,9 @@
* Creates a new {@link XMLReader} instance that relies on the given {@code XMLReader}
* and custom user define {@link Rules} implementation.
*
+ * <b>WARNING</b> Input {@link XMLReader} and {@link Rules} will be linked to built Digester instance,
+ * so it is recommended to <b>NOT</b> share same {@link XMLReader} and {@link Rules} instance to produce the Digester.
+ *
* @param reader The user defined {@code XMLReader}
* @param rules The custom user define {@link Rules} implementation
* @return a new {@link Digester} instance
