lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From o...@apache.org
Subject cvs commit: jakarta-lucene/src/java/org/apache/lucene/search BooleanQuery.java
Date Fri, 14 May 2004 12:56:29 GMT
otis        2004/05/14 05:56:29

  Modified:    src/java/org/apache/lucene/search BooleanQuery.java
  Log:
  - Made Javadoc for add method more clear (Leonid Portnoy)
  
  Revision  Changes    Path
  1.24      +14 -13    jakarta-lucene/src/java/org/apache/lucene/search/BooleanQuery.java
  
  Index: BooleanQuery.java
  ===================================================================
  RCS file: /home/cvs/jakarta-lucene/src/java/org/apache/lucene/search/BooleanQuery.java,v
  retrieving revision 1.23
  retrieving revision 1.24
  diff -u -r1.23 -r1.24
  --- BooleanQuery.java	11 May 2004 17:18:03 -0000	1.23
  +++ BooleanQuery.java	14 May 2004 12:56:29 -0000	1.24
  @@ -53,19 +53,20 @@
     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));
     }
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: lucene-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: lucene-dev-help@jakarta.apache.org


Mime
View raw message