Mailing List Archive

otis 02/02/21 12:22:45

Modified: src/java/org/apache/lucene/search MultiTermQuery.java
Log:
- Improved javadoc to make it more readable.

Revision Changes Path
1.4 +13 -6 jakarta-lucene/src/java/org/apache/lucene/search/MultiTermQuery.java

Index: MultiTermQuery.java
===================================================================
RCS file: /home/cvs/jakarta-lucene/src/java/org/apache/lucene/search/MultiTermQuery.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- MultiTermQuery.java 28 Jan 2002 11:35:56 -0000 1.3
+++ MultiTermQuery.java 21 Feb 2002 20:22:45 -0000 1.4
@@ -60,12 +60,19 @@
import org.apache.lucene.index.Term;
import org.apache.lucene.index.TermEnum;

-/** A Query that matches documents containing a subset of terms provided by a
- FilteredTermEnum enumeration. MultiTermQuery is not designed to be used by
- itself. The reason being that it is not intialized with a FilteredTermEnum
- enumeration. A FilteredTermEnum enumeration needs to be provided. For example,
- WildcardQuery and FuzzyQuery extend MultiTermQuery to provide WildcardTermEnum
- and FuzzyTermEnum respectively. */
+/**
+ * A {@link Query} that matches documents containing a subset of terms provided
+ * by a {@link FilteredTermEnum} enumeration.
+ * <P>
+ * <code>MultiTermQuery</code> is not designed to be used by itself.
+ * <BR>
+ * The reason being that it is not intialized with a {@link FilteredTermEnum}
+ * enumeration. A {@link FilteredTermEnum} enumeration needs to be provided.
+ * <P>
+ * For example, {@link WildcardQuery} and {@link FuzzyQuery} extend
+ * <code>MultiTermQuery</code> to provide {@link WildcardTermEnum} and
+ * {@link FuzzyTermEnum}, respectively.
+ */
public class MultiTermQuery extends Query {
private Term term;
private FilteredTermEnum enum;




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