You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by mi...@apache.org on 2011/05/14 18:17:59 UTC
svn commit: r1103150 - in /lucene/dev/trunk/modules/grouping/src/java: ./
org/apache/lucene/search/grouping/
Author: mikemccand
Date: Sat May 14 16:17:58 2011
New Revision: 1103150
URL: http://svn.apache.org/viewvc?rev=1103150&view=rev
Log:
LUCENE-1421: fixup javadocs
Added:
lucene/dev/trunk/modules/grouping/src/java/org/apache/lucene/search/grouping/package.html
- copied unchanged from r1103134, lucene/dev/trunk/modules/grouping/src/java/overview.html
lucene/dev/trunk/modules/grouping/src/java/overview.html (with props)
Modified:
lucene/dev/trunk/modules/grouping/src/java/org/apache/lucene/search/grouping/CachingCollector.java
lucene/dev/trunk/modules/grouping/src/java/org/apache/lucene/search/grouping/FirstPassGroupingCollector.java
lucene/dev/trunk/modules/grouping/src/java/org/apache/lucene/search/grouping/SecondPassGroupingCollector.java
Modified: lucene/dev/trunk/modules/grouping/src/java/org/apache/lucene/search/grouping/CachingCollector.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/grouping/src/java/org/apache/lucene/search/grouping/CachingCollector.java?rev=1103150&r1=1103149&r2=1103150&view=diff
==============================================================================
--- lucene/dev/trunk/modules/grouping/src/java/org/apache/lucene/search/grouping/CachingCollector.java (original)
+++ lucene/dev/trunk/modules/grouping/src/java/org/apache/lucene/search/grouping/CachingCollector.java Sat May 14 16:17:58 2011
@@ -41,6 +41,9 @@ import org.apache.lucene.util.RamUsageEs
* set is large this can easily be a very substantial amount
* of RAM!
*
+ * <p>See {@link org.apache.lucene.search.grouping} for more
+ * details including a full code example.</p>
+ *
* @lucene.experimental
*/
public class CachingCollector extends Collector {
Modified: lucene/dev/trunk/modules/grouping/src/java/org/apache/lucene/search/grouping/FirstPassGroupingCollector.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/grouping/src/java/org/apache/lucene/search/grouping/FirstPassGroupingCollector.java?rev=1103150&r1=1103149&r2=1103150&view=diff
==============================================================================
--- lucene/dev/trunk/modules/grouping/src/java/org/apache/lucene/search/grouping/FirstPassGroupingCollector.java (original)
+++ lucene/dev/trunk/modules/grouping/src/java/org/apache/lucene/search/grouping/FirstPassGroupingCollector.java Sat May 14 16:17:58 2011
@@ -34,9 +34,12 @@ import org.apache.lucene.search.SortFiel
import org.apache.lucene.util.BytesRef;
/** FirstPassGroupingCollector is the first of two passes necessary
- * to collected grouped hits. This pass gathers the top N sorted
+ * to collect grouped hits. This pass gathers the top N sorted
* groups.
*
+ * <p>See {@link org.apache.lucene.search.grouping} for more
+ * details including a full code example.</p>
+ *
* @lucene.experimental
*/
Modified: lucene/dev/trunk/modules/grouping/src/java/org/apache/lucene/search/grouping/SecondPassGroupingCollector.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/grouping/src/java/org/apache/lucene/search/grouping/SecondPassGroupingCollector.java?rev=1103150&r1=1103149&r2=1103150&view=diff
==============================================================================
--- lucene/dev/trunk/modules/grouping/src/java/org/apache/lucene/search/grouping/SecondPassGroupingCollector.java (original)
+++ lucene/dev/trunk/modules/grouping/src/java/org/apache/lucene/search/grouping/SecondPassGroupingCollector.java Sat May 14 16:17:58 2011
@@ -33,7 +33,14 @@ import org.apache.lucene.search.TopScore
import org.apache.lucene.util.BytesRef;
/**
- * See {@link FirstPassGroupingCollector}.
+ * SecondPassGroupingCollector is the second of two passes
+ * necessary to collect grouped docs. This pass gathers the
+ * top N documents per top group computed from the
+ * first pass.
+ *
+ * <p>See {@link org.apache.lucene.search.grouping} for more
+ * details including a full code example.</p>
+ *
* @lucene.experimental
*/
public class SecondPassGroupingCollector extends Collector {
Added: lucene/dev/trunk/modules/grouping/src/java/overview.html
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/grouping/src/java/overview.html?rev=1103150&view=auto
==============================================================================
--- lucene/dev/trunk/modules/grouping/src/java/overview.html (added)
+++ lucene/dev/trunk/modules/grouping/src/java/overview.html Sat May 14 16:17:58 2011
@@ -0,0 +1,5 @@
+<html>
+<body>
+Lucene's grouping module
+</body>
+</html>