From b72f93d1b50ebb49140363868ffc4f06818ed6a2 Mon Sep 17 00:00:00 2001
From: Otis Gospodnetic <otis@apache.org>
Date: Fri, 14 May 2004 12:56:29 +0000
Subject: [PATCH] - Made Javadoc for add method more clear (Leonid Portnoy)

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@150342 13f79535-47bb-0310-9956-ffa450edef68
---
 .../apache/lucene/search/BooleanQuery.java    | 27 ++++++++++---------
 1 file changed, 14 insertions(+), 13 deletions(-)

diff --git a/src/java/org/apache/lucene/search/BooleanQuery.java b/src/java/org/apache/lucene/search/BooleanQuery.java
index 17ee5c53db8..654e5f2e386 100644
--- a/src/java/org/apache/lucene/search/BooleanQuery.java
+++ b/src/java/org/apache/lucene/search/BooleanQuery.java
@@ -53,19 +53,20 @@ public class BooleanQuery extends Query {
   public BooleanQuery() {}
 
   /** Adds a clause to a boolean query.  Clauses may be:
-    <ul>
-    <li><code>required</code> which means that documents which <i>do not</i>
-    match this sub-query will <i>not</i> match the boolean query;
-    <li><code>prohibited</code> which means that documents which <i>do</i>
-    match this sub-query will <i>not</i> match the boolean query; or
-    <li>neither, in which case matched documents are neither prohibited from
-    nor required to match the sub-query.
-    </ul>
-    It is an error to specify a clause as both <code>required</code> and
-    <code>prohibited</code>.
-    *
-    * @see #getMaxClauseCount()
-    */
+   * <ul>
+   * <li><code>required</code> which means that documents which <i>do not</i>
+   * match this sub-query will <i>not</i> match the boolean query;
+   * <li><code>prohibited</code> which means that documents which <i>do</i>
+   * match this sub-query will <i>not</i> match the boolean query; or
+   * <li>neither, in which case matched documents are neither prohibited from
+   * nor required to match the sub-query. However, a document must match at
+   * least 1 sub-query to match the boolean query.
+   * </ul>
+   * It is an error to specify a clause as both <code>required</code> and
+   * <code>prohibited</code>.
+   *
+   * @see #getMaxClauseCount()
+   */
   public void add(Query query, boolean required, boolean prohibited) {
     add(new BooleanClause(query, required, prohibited));
   }