You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-commits@lucene.apache.org by bu...@apache.org on 2007/03/15 09:48:01 UTC
svn commit: r518518 - in /lucene/java/trunk: CHANGES.txt
src/java/org/apache/lucene/search/ScoreDocComparator.java
Author: buschmi
Date: Thu Mar 15 01:48:00 2007
New Revision: 518518
URL: http://svn.apache.org/viewvc?view=rev&rev=518518
Log:
LUCENE-807: Fixed the javadoc for ScoreDocComparator.compare() to be consistent with java.util.Comparator.compare()
Modified:
lucene/java/trunk/CHANGES.txt
lucene/java/trunk/src/java/org/apache/lucene/search/ScoreDocComparator.java
Modified: lucene/java/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/lucene/java/trunk/CHANGES.txt?view=diff&rev=518518&r1=518517&r2=518518
==============================================================================
--- lucene/java/trunk/CHANGES.txt (original)
+++ lucene/java/trunk/CHANGES.txt Thu Mar 15 01:48:00 2007
@@ -98,6 +98,12 @@
Documentation:
1. LUCENE 791 && INFRA-1173: Infrastructure moved the Wiki to http://wiki.apache.org/lucene-java/ Updated the links in the docs and wherever else I found references. (Grant Ingersoll, Joe Schaefer)
+
+ 2. Fixed the javadoc for ScoreDocComparator.compare() to be consistent with
+ java.util.Comparator.compare(): Any integer is allowed to be returned
+ instead of only -1/0/1.
+ (Paul Cowan via Michael Busch)
+
======================= Release 2.1.0 2007-02-14 =======================
Changes in runtime behavior
Modified: lucene/java/trunk/src/java/org/apache/lucene/search/ScoreDocComparator.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/ScoreDocComparator.java?view=diff&rev=518518&r1=518517&r2=518518
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/ScoreDocComparator.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/ScoreDocComparator.java Thu Mar 15 01:48:00 2007
@@ -64,8 +64,8 @@
* sort order.
* @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>
+ * @return a negative integer if <code>i</code> should come before <code>j</code><br>
+ * a positive integer if <code>i</code> should come after <code>j</code><br>
* <code>0</code> if they are equal
* @see java.util.Comparator
*/