svn commit: r812963 - in /lucene/java/trunk: CHANGES.txt src/java/org/apache/lucene/search/Searchable.java

[ma...@apache.org]

Author: markrmiller
Date: Wed Sep  9 13:53:20 2009
New Revision: 812963

URL: http://svn.apache.org/viewvc?rev=812963&view=rev
Log:
LUCENE-1900: Improve Searchable Javadoc

Modified:
    lucene/java/trunk/CHANGES.txt
    lucene/java/trunk/src/java/org/apache/lucene/search/Searchable.java

Modified: lucene/java/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/lucene/java/trunk/CHANGES.txt?rev=812963&r1=812962&r2=812963&view=diff
==============================================================================
--- lucene/java/trunk/CHANGES.txt (original)
+++ lucene/java/trunk/CHANGES.txt Wed Sep  9 13:53:20 2009
@@ -851,6 +851,9 @@
  * LUCENE-1898: Switch changes to use bullets rather than numbers and 
     update changes-to-html script to handle the new format. 
     (Steven Rowe, Mark Miller)
+    
+ * LUCENE-1900: Improve Searchable Javadoc.
+    (Nadav Har'El, Doron Cohen, Marvin Humphrey, Mark Miller)
 
 Build
 

Modified: lucene/java/trunk/src/java/org/apache/lucene/search/Searchable.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/Searchable.java?rev=812963&r1=812962&r2=812963&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/Searchable.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/Searchable.java Wed Sep  9 13:53:20 2009
@@ -92,7 +92,7 @@
   void close() throws IOException;
 
   /** Expert: Returns the number of documents containing <code>term</code>.
-   * Called by search code to compute term weights.
+   * 
    * @see org.apache.lucene.index.IndexReader#docFreq(Term)
    */
   int docFreq(Term term) throws IOException;
@@ -104,7 +104,7 @@
   int[] docFreqs(Term[] terms) throws IOException;
 
   /** Expert: Returns one greater than the largest possible document number.
-   * Called by search code to compute term weights.
+   * 
    * @see org.apache.lucene.index.IndexReader#maxDoc()
    */
   int maxDoc() throws IOException;
@@ -112,8 +112,6 @@
   /** Expert: Low-level search implementation.  Finds the top <code>n</code>
    * hits for <code>query</code>, applying <code>filter</code> if non-null.
    *
-   * <p>Called by {@link Hits}.
-   *
    * <p>Applications should usually call {@link Searcher#search(Query)} or
    * {@link Searcher#search(Query,Filter)} instead.
    * @throws BooleanQuery.TooManyClauses
@@ -121,8 +119,9 @@
    */
   TopDocs search(Weight weight, Filter filter, int n) throws IOException;
 
-  /** Expert: Returns the stored fields of document <code>i</code>.
-   * Called by {@link HitCollector} implementations.
+  /**
+   * Returns the stored fields of document <code>i</code>.
+   * 
    * @see org.apache.lucene.index.IndexReader#document(int)
    * @throws CorruptIndexException if the index is corrupt
    * @throws IOException if there is a low-level IO error