You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by tj...@apache.org on 2004/04/23 16:46:34 UTC
cvs commit: jakarta-lucene/src/java/org/apache/lucene/search ScoreDocComparator.java
tjones 2004/04/23 07:46:34
Modified: src/java/org/apache/lucene/search ScoreDocComparator.java
Log:
fix javadocs
Revision Changes Path
1.4 +3 -2 jakarta-lucene/src/java/org/apache/lucene/search/ScoreDocComparator.java
Index: ScoreDocComparator.java
===================================================================
RCS file: /home/cvs/jakarta-lucene/src/java/org/apache/lucene/search/ScoreDocComparator.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ScoreDocComparator.java 22 Apr 2004 22:23:14 -0000 1.3
+++ ScoreDocComparator.java 23 Apr 2004 14:46:34 -0000 1.4
@@ -86,7 +86,7 @@
* 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 @@
/**
- * 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
*/
---------------------------------------------------------------------
To unsubscribe, e-mail: lucene-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: lucene-dev-help@jakarta.apache.org