You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-commits@lucene.apache.org by gs...@apache.org on 2009/08/24 15:35:13 UTC

svn commit: r807209 - /lucene/java/trunk/src/java/org/apache/lucene/search/TopFieldCollector.java

Author: gsingers
Date: Mon Aug 24 13:35:13 2009
New Revision: 807209

URL: http://svn.apache.org/viewvc?rev=807209&view=rev
Log:
javadoc addition directing users where to start with this class

Modified:
    lucene/java/trunk/src/java/org/apache/lucene/search/TopFieldCollector.java

Modified: lucene/java/trunk/src/java/org/apache/lucene/search/TopFieldCollector.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/TopFieldCollector.java?rev=807209&r1=807208&r2=807209&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/TopFieldCollector.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/TopFieldCollector.java Mon Aug 24 13:35:13 2009
@@ -26,6 +26,9 @@
 /**
  * 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>