From f1e792a661ff81e88d760d02e61d542c2a8c9409 Mon Sep 17 00:00:00 2001
From: Simon Willnauer <simonw@apache.org>
Date: Sun, 20 Feb 2011 11:59:12 +0000
Subject: [PATCH] LUCENE-2931: Improved javadocs for PriorityQueue#lessThan

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1072567 13f79535-47bb-0310-9956-ffa450edef68
---
 lucene/src/java/org/apache/lucene/util/PriorityQueue.java | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/lucene/src/java/org/apache/lucene/util/PriorityQueue.java b/lucene/src/java/org/apache/lucene/util/PriorityQueue.java
index d7311c5060e..27772052d9e 100644
--- a/lucene/src/java/org/apache/lucene/util/PriorityQueue.java
+++ b/lucene/src/java/org/apache/lucene/util/PriorityQueue.java
@@ -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);
 
   /**