You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by si...@apache.org on 2011/02/20 13:03:29 UTC
svn commit: r1072569 - in /lucene/dev/branches/branch_3x: ./ lucene/
lucene/src/java/org/apache/lucene/util/PriorityQueue.java solr/
Author: simonw
Date: Sun Feb 20 12:03:29 2011
New Revision: 1072569
URL: http://svn.apache.org/viewvc?rev=1072569&view=rev
Log:
LUCENE-2931: Improved javadocs for PriorityQueue#lessThan
Modified:
lucene/dev/branches/branch_3x/ (props changed)
lucene/dev/branches/branch_3x/lucene/ (props changed)
lucene/dev/branches/branch_3x/lucene/src/java/org/apache/lucene/util/PriorityQueue.java
lucene/dev/branches/branch_3x/solr/ (props changed)
Modified: lucene/dev/branches/branch_3x/lucene/src/java/org/apache/lucene/util/PriorityQueue.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/lucene/src/java/org/apache/lucene/util/PriorityQueue.java?rev=1072569&r1=1072568&r2=1072569&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/lucene/src/java/org/apache/lucene/util/PriorityQueue.java (original)
+++ lucene/dev/branches/branch_3x/lucene/src/java/org/apache/lucene/util/PriorityQueue.java Sun Feb 20 12:03:29 2011
@@ -32,7 +32,9 @@ public abstract class PriorityQueue<T> {
protected T[] heap;
/** Determines the ordering of objects in this priority queue. Subclasses
- must define this one method. */
+ * must define this one method.
+ * @return <code>true</code> iff parameter <tt>a</tt> is less than parameter <tt>b</tt>.
+ */
protected abstract boolean lessThan(T a, T b);
/**