diff --git a/src/java/org/apache/lucene/search/ScoreDocComparator.java b/src/java/org/apache/lucene/search/ScoreDocComparator.java index 12dc2e27c83..c7fd4332dbf 100644 --- a/src/java/org/apache/lucene/search/ScoreDocComparator.java +++ b/src/java/org/apache/lucene/search/ScoreDocComparator.java @@ -44,7 +44,6 @@ public interface ScoreDocComparator { } }; - /** Special comparator for sorting hits according to index order (document number). */ static final ScoreDocComparator INDEXORDER = new ScoreDocComparator() { public int compare (ScoreDoc i, ScoreDoc j) { @@ -60,35 +59,39 @@ public interface ScoreDocComparator { } }; - /** * Compares two ScoreDoc objects and returns a result indicating their * sort order. * @param i First ScoreDoc * @param j Second ScoreDoc - * @return -1 if i should come before j
1 if i should come after j
0 if they are equal + * @return -1 if i should come before j
+ * 1 if i should come after j
+ * 0 if they are equal * @see java.util.Comparator */ int compare (ScoreDoc i, ScoreDoc j); - /** * Returns the value used to sort the given document. The * object returned must implement the java.io.Serializable - * interface. This is used by multisearchers to determine how to collate results from their searchers. + * interface. This is used by multisearchers to determine how + * to collate results from their searchers. * @see FieldDoc * @param i Document * @return Serializable object */ Comparable sortValue (ScoreDoc i); - /** - * Returns the type of sort. Should return SortField.SCORE, SortField.DOC, SortField.STRING, SortField.INTEGER, - * SortField.FLOAT or SortField.CUSTOM. It is not valid to return SortField.AUTO. - * This is used by multisearchers to determine how to collate results from their searchers. + * Returns the type of sort. Should return SortField.SCORE, + * SortField.DOC, SortField.STRING, + * SortField.INTEGER, SortField.FLOAT or + * SortField.CUSTOM. It is not valid to return + * SortField.AUTO. + * This is used by multisearchers to determine how to collate results + * from their searchers. * @return One of the constants in SortField. * @see SortField */ int sortType(); -} \ No newline at end of file +}