From aeb9723407cddf3cb3c1176de038ac65cdc5f10b Mon Sep 17 00:00:00 2001
From: Wolfgang Hoschek <whoschek@apache.org>
Date: Wed, 22 Nov 2006 22:57:59 +0000
Subject: [PATCH] javadoc

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@478361 13f79535-47bb-0310-9956-ffa450edef68
---
 .../java/org/apache/lucene/index/memory/AnalyzerUtil.java   | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/contrib/memory/src/java/org/apache/lucene/index/memory/AnalyzerUtil.java b/contrib/memory/src/java/org/apache/lucene/index/memory/AnalyzerUtil.java
index 8a4e4edc1dd..3f5dec32c33 100644
--- a/contrib/memory/src/java/org/apache/lucene/index/memory/AnalyzerUtil.java
+++ b/contrib/memory/src/java/org/apache/lucene/index/memory/AnalyzerUtil.java
@@ -209,9 +209,11 @@ public class AnalyzerUtil {
    * <p>
    * This can help improve performance in the presence of expensive Analyzer / TokenFilter chains.
    * <p>
-   * Caveats: Caching only works if the methods equals() and hashCode() methods are properly 
+   * Caveats: 
+   * 1) Caching only works if the methods equals() and hashCode() methods are properly 
    * implemented on the Reader passed to <code>tokenStream(String fieldName, Reader reader)</code>.
-   * Further, using caching on large Lucene documents can lead to out of memory exceptions.
+   * 2) Caching the tokens of large Lucene documents can lead to out of memory exceptions. 
+   * 3) The Token instances delivered by the underlying child analyzer must be immutable.
    * 
    * @param child
    *            the underlying child analyzer