From a3f99b1f4367c510ff8d5a69757eeb09cadaf6d4 Mon Sep 17 00:00:00 2001 From: Daniel Naber Date: Sat, 28 May 2005 22:58:17 +0000 Subject: [PATCH] small javadoc improvements git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@178893 13f79535-47bb-0310-9956-ffa450edef68 --- contrib/analyzers/src/java/overview.html | 2 +- src/java/org/apache/lucene/search/CachingWrapperFilter.java | 2 +- src/java/org/apache/lucene/search/PhraseQuery.java | 6 ++++-- src/java/org/apache/lucene/search/PrefixQuery.java | 3 ++- src/java/org/apache/lucene/search/RangeQuery.java | 3 ++- 5 files changed, 10 insertions(+), 6 deletions(-) diff --git a/contrib/analyzers/src/java/overview.html b/contrib/analyzers/src/java/overview.html index 846a64d2ee3..e6a50cd92b2 100644 --- a/contrib/analyzers/src/java/overview.html +++ b/contrib/analyzers/src/java/overview.html @@ -1,6 +1,6 @@ - Jakarta Lucene Sandbox Analyzers + Apache Lucene Analyzers diff --git a/src/java/org/apache/lucene/search/CachingWrapperFilter.java b/src/java/org/apache/lucene/search/CachingWrapperFilter.java index bce027e85ba..9bb797c5b2e 100644 --- a/src/java/org/apache/lucene/search/CachingWrapperFilter.java +++ b/src/java/org/apache/lucene/search/CachingWrapperFilter.java @@ -23,7 +23,7 @@ import java.util.Map; import java.io.IOException; /** - * Wraps another filters result and caches it. The caching + * Wraps another filter's result and caches it. The caching * behavior is like {@link QueryFilter}. The purpose is to allow * filters to simply filter, and then wrap with this class to add * caching, keeping the two concerns decoupled yet composable. diff --git a/src/java/org/apache/lucene/search/PhraseQuery.java b/src/java/org/apache/lucene/search/PhraseQuery.java index 4fa9567222d..dd3fb618ac6 100644 --- a/src/java/org/apache/lucene/search/PhraseQuery.java +++ b/src/java/org/apache/lucene/search/PhraseQuery.java @@ -25,8 +25,10 @@ import org.apache.lucene.index.TermPositions; import org.apache.lucene.index.IndexReader; /** A Query that matches documents containing a particular sequence of terms. - This may be combined with other terms with a {@link BooleanQuery}. - */ + * A PhraseQuery is built by QueryParser for input like "new york". + * + *

This query may be combined with other terms or queries with a {@link BooleanQuery}. + */ public class PhraseQuery extends Query { private String field; private Vector terms = new Vector(); diff --git a/src/java/org/apache/lucene/search/PrefixQuery.java b/src/java/org/apache/lucene/search/PrefixQuery.java index f107abd36c7..cfa5e0bd6db 100644 --- a/src/java/org/apache/lucene/search/PrefixQuery.java +++ b/src/java/org/apache/lucene/search/PrefixQuery.java @@ -22,7 +22,8 @@ import org.apache.lucene.index.Term; import org.apache.lucene.index.TermEnum; import org.apache.lucene.index.IndexReader; -/** A Query that matches documents containing terms with a specified prefix. */ +/** A Query that matches documents containing terms with a specified prefix. A PrefixQuery + * is built by QueryParser for input like app*. */ public class PrefixQuery extends Query { private Term prefix; diff --git a/src/java/org/apache/lucene/search/RangeQuery.java b/src/java/org/apache/lucene/search/RangeQuery.java index bf082e7fe91..ed822af57d2 100644 --- a/src/java/org/apache/lucene/search/RangeQuery.java +++ b/src/java/org/apache/lucene/search/RangeQuery.java @@ -23,7 +23,8 @@ import org.apache.lucene.index.TermEnum; import org.apache.lucene.index.IndexReader; /** - * A Query that matches documents within an exclusive range. + * A Query that matches documents within an exclusive range. A RangeQuery + * is built by QueryParser for input like [010 TO 120]. * * @version $Id$ */