javadoc addition directing users where to start with this class

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@807209 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Grant Ingersoll 2009-08-24 13:35:13 +00:00
parent 52eea1618e
commit 90ba4496ef
1 changed files with 3 additions and 0 deletions

View File

@ -26,6 +26,9 @@ import org.apache.lucene.util.PriorityQueue;
/**
* A {@link Collector} that sorts by {@link SortField} using
* {@link FieldComparator}s.
* <p/>
* See the {@link #create(org.apache.lucene.search.Sort, int, boolean, boolean, boolean, boolean)} method
* for instantiating a TopFieldCollector.
*
* <p><b>NOTE:</b> This API is experimental and might change in
* incompatible ways in the next release.</p>