Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixed @see tags and added reference to HitIterator from Hits.iterator 

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@164704 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Erik Hatcher 2005-04-26 01:29:02 +00:00
parent 6dbb01e8b5
commit 2bb0c8f257
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/java/org/apache/lucene/search/Hit.java
View File

@ -49,7 +49,7 @@ public class Hit implements java.io.Serializable {
/** /**
* Returns document for this hit. * Returns document for this hit.
* *
* @see {@link Hits#doc(int)} * @see Hits#doc(int)
*/ */
public Document getDocument() throws IOException { public Document getDocument() throws IOException {
if (!resolved) fetchTheHit(); if (!resolved) fetchTheHit();
@ -59,7 +59,7 @@ public class Hit implements java.io.Serializable {
/** /**
* Returns score for this hit. * Returns score for this hit.
* *
* @see {@link Hits#score(int)} * @see Hits#score(int)
*/ */
public float getScore() throws IOException { public float getScore() throws IOException {
if (!resolved) fetchTheHit(); if (!resolved) fetchTheHit();
@ -69,7 +69,7 @@ public class Hit implements java.io.Serializable {
/** /**
* Returns id for this hit. * Returns id for this hit.
* *
* @see {@link Hits#id(int)} * @see Hits#id(int)
*/ */
public int getId() throws IOException { public int getId() throws IOException {
if (!resolved) fetchTheHit(); if (!resolved) fetchTheHit();
@ -88,7 +88,7 @@ public class Hit implements java.io.Serializable {
/** /**
* Returns the boost factor for this hit on any field of the underlying document. * Returns the boost factor for this hit on any field of the underlying document.
* *
* @see {@link Document#getBoost()} * @see Document#getBoost()
*/ */
public float getBoost() throws IOException { public float getBoost() throws IOException {
return getDocument().getBoost(); return getDocument().getBoost();
@ -100,7 +100,7 @@ public class Hit implements java.io.Serializable {
* method returns the first value added. If only binary fields with this name * method returns the first value added. If only binary fields with this name
* exist, returns null. * exist, returns null.
* *
* @see {@link Document#get(String)} * @see Document#get(String)
*/ */
public String get(String name) throws IOException { public String get(String name) throws IOException {
return getDocument().get(name); return getDocument().get(name);
@ -111,7 +111,7 @@ public class Hit implements java.io.Serializable {
* <p/> * <p/>
* If an IOException occurs whilst getting the document, returns null * If an IOException occurs whilst getting the document, returns null
* *
* @see {@link Document#toString()} * @see Document#toString()
*/ */
public String toString() { public String toString() {
try { try {

2
src/java/org/apache/lucene/search/Hits.java
View File

@ -116,7 +116,7 @@ public final class Hits {
} }
/** /**
* Returns an {@link Iterator} to navigate the Hits. Each item returned * Returns a {@link HitIterator} to navigate the Hits. Each item returned
* from {@link Iterator#next()} is a {@link Hit}. * from {@link Iterator#next()} is a {@link Hit}.
* <p> * <p>
* <b>Caution:</b> Iterate only over the hits needed. Iterating over all * <b>Caution:</b> Iterate only over the hits needed. Iterating over all