From 90ba4496efd470dc91454b788cb0613fa218069d Mon Sep 17 00:00:00 2001
From: Grant Ingersoll <gsingers@apache.org>
Date: Mon, 24 Aug 2009 13:35:13 +0000
Subject: [PATCH] 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
---
 src/java/org/apache/lucene/search/TopFieldCollector.java | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/java/org/apache/lucene/search/TopFieldCollector.java b/src/java/org/apache/lucene/search/TopFieldCollector.java
index 82f870359d3..eb1839fcbdd 100644
--- a/src/java/org/apache/lucene/search/TopFieldCollector.java
+++ b/src/java/org/apache/lucene/search/TopFieldCollector.java
@@ -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>