Clear up Hit javadoc

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@164728 13f79535-47bb-0310-9956-ffa450edef68
2005-04-26 03:23:44 +00:00 · 2005-04-26 03:23:44 +00:00 · f7023a936d
parent cfd5d55b7e
commit f7023a936d
1 changed files with 2 additions and 1 deletions
--- a/src/java/org/apache/lucene/search/Hit.java
+++ b/src/java/org/apache/lucene/search/Hit.java
@ -21,7 +21,8 @@ import java.io.IOException;
 import org.apache.lucene.document.Document;

 /**
- * a lazy future for a hit, useful for iterators over instances of Hits
+ * Wrapper used by {@link HitIterator} to provide a lazily loaded hit
+ * from {@link Hits}.
 *
 * @author Jeremy Rayner
 */