You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by mi...@apache.org on 2012/05/18 17:45:41 UTC
svn commit: r1340138 -
/lucene/dev/branches/lucene_solr_3_6/lucene/core/src/java/org/apache/lucene/index/TermDocs.java
Author: mikemccand
Date: Fri May 18 15:45:40 2012
New Revision: 1340138
URL: http://svn.apache.org/viewvc?rev=1340138&view=rev
Log:
improve javadocs
Modified:
lucene/dev/branches/lucene_solr_3_6/lucene/core/src/java/org/apache/lucene/index/TermDocs.java
Modified: lucene/dev/branches/lucene_solr_3_6/lucene/core/src/java/org/apache/lucene/index/TermDocs.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene_solr_3_6/lucene/core/src/java/org/apache/lucene/index/TermDocs.java?rev=1340138&r1=1340137&r2=1340138&view=diff
==============================================================================
--- lucene/dev/branches/lucene_solr_3_6/lucene/core/src/java/org/apache/lucene/index/TermDocs.java (original)
+++ lucene/dev/branches/lucene_solr_3_6/lucene/core/src/java/org/apache/lucene/index/TermDocs.java Fri May 18 15:45:40 2012
@@ -49,7 +49,8 @@ public interface TermDocs extends Closea
int freq();
/** Moves to the next pair in the enumeration. <p> Returns true iff there is
- such a next pair in the enumeration. */
+ such a next pair in the enumeration. Once this returns
+ false you should not call any of the other methods. */
boolean next() throws IOException;
/** Attempts to read multiple entries from the enumeration, up to length of