Index: BooleanQuery.java
===================================================================
RCS file: /home/cvspublic/jakarta-lucene/src/java/org/apache/lucene/search/BooleanQuery.java,v
retrieving revision 1.25
diff -u -3 -p -r1.25 BooleanQuery.java
--- BooleanQuery.java	27 Aug 2004 20:09:12 -0000	1.25
+++ BooleanQuery.java	18 Oct 2004 20:59:59 -0000
@@ -25,9 +25,15 @@ import org.apache.lucene.index.IndexRead
   */
 public class BooleanQuery extends Query {
   
-  /**
-   * Default value is 1024.  Use <code>org.apache.lucene.maxClauseCount</code>
-   * system property to override.
+  /** The maximum number of clauses permitted.
+   * Default value is 1024.
+   * Use the <code>org.apache.lucene.maxClauseCount</code> system property to override.
+   * <br>TermQuery clauses are generated from for example prefix queries and fuzzy queries.
+   * Each TermQuery needs some buffer space during search, so
+   * this parameter indirectly controls the maximum buffer requirements for query search.
+   * <br>Normally the buffers are allocated by the JVM.
+   * When using for example {@link org.apache.lucene.store.MMapDirectory} the buffering
+   * is left to the operating system.
    */
   public static int maxClauseCount =
     Integer.parseInt(System.getProperty("org.apache.lucene.maxClauseCount",
@@ -39,7 +45,9 @@ public class BooleanQuery extends Query 
 
   /** Return the maximum number of clauses permitted, 1024 by default.
    * Attempts to add more than the permitted number of clauses cause {@link
-   * TooManyClauses} to be thrown.*/
+   * TooManyClauses} to be thrown.
+   * @see #maxClauseCount
+   */
   public static int getMaxClauseCount() { return maxClauseCount; }
 
   /** Set the maximum number of clauses permitted. */