svn commit: r540460 - /lucene/java/trunk/src/java/org/apache/lucene/search/BooleanClause.java

[ho...@apache.org]

Author: hossman
Date: Tue May 22 00:51:41 2007
New Revision: 540460

URL: http://svn.apache.org/viewvc?view=rev&rev=540460
Log:
clarifing javadocs for BooleanClause.SHOULD - two is not a magic number, the real issue is a lack of MUST clauses

Modified:
    lucene/java/trunk/src/java/org/apache/lucene/search/BooleanClause.java

Modified: lucene/java/trunk/src/java/org/apache/lucene/search/BooleanClause.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/BooleanClause.java?view=diff&rev=540460&r1=540459&r2=540460
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/BooleanClause.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/BooleanClause.java Tue May 22 00:51:41 2007
@@ -39,8 +39,11 @@
     /** Use this operator for clauses that <i>must</i> appear in the matching documents. */
     public static final Occur MUST = new Occur("MUST");
     /** Use this operator for clauses that <i>should</i> appear in the 
-     * matching documents. For a BooleanQuery with two <code>SHOULD</code> 
-     * subqueries, at least one of the clauses must appear in the matching documents. */
+     * matching documents. For a BooleanQuery with no <code>MUST</code> 
+     * clauses one or more <code>SHOULD</code> clauses must match a document 
+     * for the BooleanQuery to match.
+     * @see BooleanQuery#setMinimumNumberShouldMatch
+     */
     public static final Occur SHOULD = new Occur("SHOULD");
     /** Use this operator for clauses that <i>must not</i> appear in the matching documents.
      * Note that it is not possible to search for queries that only consist