Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

LUCENE-1864: fix javadocs for FieldValueHitQueue.fillFields 

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@808538 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael McCandless 2009-08-27 17:10:00 +00:00
parent 710572d798
commit d2e4a19bd3
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/java/org/apache/lucene/search/FieldValueHitQueue.java
View File

@ -207,14 +207,14 @@ public abstract class FieldValueHitQueue extends PriorityQueue {
protected abstract boolean lessThan (final Object a, final Object b); protected abstract boolean lessThan (final Object a, final Object b);
/** /**
* Given a FieldDoc object, stores the values used to sort the given document. * Given a queue Entry, creates a corresponding FieldDoc
* that contains the values used to sort the given document.
* These values are not the raw values out of the index, but the internal * These values are not the raw values out of the index, but the internal
* representation of them. This is so the given search hit can be collated by * representation of them. This is so the given search hit can be collated by
* a MultiSearcher with other search hits. * a MultiSearcher with other search hits.
* *
* @param doc * @param entry The Entry used to create a FieldDoc
* The FieldDoc to store sort values into. * @return The newly created FieldDoc
* @return The same FieldDoc passed in.
* @see Searchable#search(Weight,Filter,int,Sort) * @see Searchable#search(Weight,Filter,int,Sort)
*/ */
FieldDoc fillFields(final Entry entry) { FieldDoc fillFields(final Entry entry) {