You are viewing a plain text version of this content. The canonical link for it is here.

Posted to java-commits@lucene.apache.org by ma...@apache.org on 2009/08/04 17:38:00 UTC

svn commit: r800849 - /lucene/java/trunk/contrib/highlighter/src/java/org/apache/lucene/search/highlight/Scorer.java

Author: markrmiller
Date: Tue Aug  4 15:38:00 2009
New Revision: 800849

URL: http://svn.apache.org/viewvc?rev=800849&view=rev
Log:
update javadoc for init(TokenStream) return

Modified:
    lucene/java/trunk/contrib/highlighter/src/java/org/apache/lucene/search/highlight/Scorer.java

Modified: lucene/java/trunk/contrib/highlighter/src/java/org/apache/lucene/search/highlight/Scorer.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/contrib/highlighter/src/java/org/apache/lucene/search/highlight/Scorer.java?rev=800849&r1=800848&r2=800849&view=diff
==============================================================================
--- lucene/java/trunk/contrib/highlighter/src/java/org/apache/lucene/search/highlight/Scorer.java (original)
+++ lucene/java/trunk/contrib/highlighter/src/java/org/apache/lucene/search/highlight/Scorer.java Tue Aug  4 15:38:00 2009
@@ -32,7 +32,10 @@
    * getTokenScore().
    * 
    * @param tokenStream
-   * @throws IOException 
+   * @return either a TokenStream that the Highlighter should continue using (eg
+   *         if you read the tokenSream in this method) or null to continue
+   *         using the same TokenStream that was passed in.
+   * @throws IOException
    */
   public TokenStream init(TokenStream tokenStream) throws IOException;