LUCENE-807: Fixed the javadoc for ScoreDocComparator.compare() to be consistent with java.util.Comparator.compare()

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@518518 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael Busch 2007-03-15 08:48:00 +00:00
parent eb20c06a62
commit cb88961792
2 changed files with 8 additions and 2 deletions

View File

@ -98,6 +98,12 @@ Optimizations
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

View File

@ -64,8 +64,8 @@ public interface ScoreDocComparator {
* 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
*/