jdoc improvement

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@939746 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael McCandless 2010-04-30 17:23:14 +00:00
parent 9f2cd93b93
commit a7659e55ef
1 changed files with 3 additions and 1 deletions

View File

@ -24,7 +24,9 @@ import org.apache.lucene.util.AttributeSource;
import org.apache.lucene.util.IntsRef;
/** Iterates through the documents, term freq and positions.
* NOTE: you must first call {@link #nextDoc}.
* NOTE: you must first call {@link #nextDoc} before using
* any of the per-doc methods (this does not apply to the
* bulk read {@link #read} method).
*
* @lucene.experimental */
public abstract class DocsEnum extends DocIdSetIterator {