From b908476de5358680a5b72dda83ee4b3c87a5fd54 Mon Sep 17 00:00:00 2001
From: Tim Jones <tjones@apache.org>
Date: Fri, 23 Apr 2004 14:46:34 +0000
Subject: [PATCH] fix javadocs

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@150313 13f79535-47bb-0310-9956-ffa450edef68
---
 src/java/org/apache/lucene/search/ScoreDocComparator.java | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/java/org/apache/lucene/search/ScoreDocComparator.java b/src/java/org/apache/lucene/search/ScoreDocComparator.java
index bab3068dc6d..408f9dea731 100644
--- a/src/java/org/apache/lucene/search/ScoreDocComparator.java
+++ b/src/java/org/apache/lucene/search/ScoreDocComparator.java
@@ -86,7 +86,7 @@ public interface ScoreDocComparator {
 	 * sort order in reverse.
 	 * @param i First ScoreDoc
 	 * @param j Second ScoreDoc
-	 * @return <code>-1</code> if <code>i</code> should come before <code>j</code><br><code>1</code> if <code>i</code> should come after <code>j</code><br><code>0</code> if they are equal
+	 * @return <code>-1</code> if <code>j</code> should come before <code>i</code><br><code>1</code> if <code>j</code> should come after <code>i</code><br><code>0</code> if they are equal
 	 * @see java.util.Comparator
 	 */
 	int compareReverse (ScoreDoc i, ScoreDoc j);
@@ -103,7 +103,8 @@ public interface ScoreDocComparator {
 
 
 	/**
-	 * Returns the type of sort.
+	 * Returns the type of sort.  Should return <code>SortField.SCORE</code>, <code>SortField.DOC</code>, <code>SortField.STRING</code>, <code>SortField.INTEGER</code>, 
+	 * <code>SortField.FLOAT</code> or <code>SortField.CUSTOM</code>.  It is not valid to return <code>SortField.AUTO</code>.
 	 * @return One of the constants in SortField.
 	 * @see SortField
 	 */