svn commit: r295101 - in /lucene/java/trunk/src/java/org/apache/lucene/search: IndexSearcher.java Searcher.java

[dn...@apache.org]

Author: dnaber
Date: Wed Oct  5 13:14:56 2005
New Revision: 295101

URL: http://svn.apache.org/viewcvs?rev=295101&view=rev
Log:
small javadoc improvements

Modified:
    lucene/java/trunk/src/java/org/apache/lucene/search/IndexSearcher.java
    lucene/java/trunk/src/java/org/apache/lucene/search/Searcher.java

Modified: lucene/java/trunk/src/java/org/apache/lucene/search/IndexSearcher.java
URL: http://svn.apache.org/viewcvs/lucene/java/trunk/src/java/org/apache/lucene/search/IndexSearcher.java?rev=295101&r1=295100&r2=295101&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/IndexSearcher.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/IndexSearcher.java Wed Oct  5 13:14:56 2005
@@ -29,6 +29,9 @@
  * <p>Applications usually need only call the inherited {@link #search(Query)}
  * or {@link #search(Query,Filter)} methods. For performance reasons it is 
  * recommended to open only one IndexSearcher and use it for all of your searches.
+ * 
+ * <p>Note that you can only access Hits from an IndexSearcher as long as it is
+ * not yet closed, otherwise an IOException will be thrown. 
  */
 public class IndexSearcher extends Searcher {
   IndexReader reader;

Modified: lucene/java/trunk/src/java/org/apache/lucene/search/Searcher.java
URL: http://svn.apache.org/viewcvs/lucene/java/trunk/src/java/org/apache/lucene/search/Searcher.java?rev=295101&r1=295100&r2=295101&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/Searcher.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/Searcher.java Wed Oct  5 13:14:56 2005
@@ -21,7 +21,10 @@
 import org.apache.lucene.index.Term;
 
 /** An abstract base class for search implementations.
- * Implements some common utility methods.
+ * Implements the main search methods.
+ * 
+ * <p>Note that you can only access Hits from a Searcher as long as it is
+ * not yet closed, otherwise an IOException will be thrown. 
  */
 public abstract class Searcher implements Searchable {