[
https://issues.apache.org/jira/browse/LUCENE-2931?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12996943#comment-12996943
]
Karl Wettin edited comment on LUCENE-2931 at 2/20/11 1:04 AM:
--------------------------------------------------------------
{code}
Index: src/java/org/apache/lucene/util/PriorityQueue.java
===================================================================
--- src/java/org/apache/lucene/util/PriorityQueue.java (revision 1072471)
+++ src/java/org/apache/lucene/util/PriorityQueue.java (working copy)
@@ -31,8 +31,11 @@
private int maxSize;
protected T[] heap;
- /** Determines the ordering of objects in this priority queue. Subclasses
- must define this one method. */
+ /**
+ * Determines the ordering of objects in this priority queue. Subclasses
+ * must define this one method.
+ * @return true if parameter a is less than parameter b.
+ */
protected abstract boolean lessThan(T a, T b);
/**
{code}
was (Author: karl.wettin):
Index: src/java/org/apache/lucene/util/PriorityQueue.java
===================================================================
--- src/java/org/apache/lucene/util/PriorityQueue.java (revision 1072471)
+++ src/java/org/apache/lucene/util/PriorityQueue.java (working copy)
@@ -31,8 +31,11 @@
private int maxSize;
protected T[] heap;
- /** Determines the ordering of objects in this priority queue. Subclasses
- must define this one method. */
+ /**
+ * Determines the ordering of objects in this priority queue. Subclasses
+ * must define this one method.
+ * @return true if parameter a is less than parameter b.
+ */
protected abstract boolean lessThan(T a, T b);
/**
> Improved javadocs for PriorityQueue#lessThan
> --------------------------------------------
>
> Key: LUCENE-2931
> URL: https://issues.apache.org/jira/browse/LUCENE-2931
> Project: Lucene - Java
> Issue Type: Improvement
> Affects Versions: 3.0.3
> Reporter: Karl Wettin
> Priority: Trivial
>
> It kills me that I have to inspect the code every time I implement a
> PriorityQueue. :)
--
This message is automatically generated by JIRA.
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
