svn commit: r1374045 - in /lucene/dev/trunk/lucene: ./ core/src/java/org/apache/lucene/search/ grouping/src/java/org/apache/lucene/search/grouping/

[rm...@apache.org]

Author: rmuir
Date: Thu Aug 16 20:41:17 2012
New Revision: 1374045

URL: http://svn.apache.org/viewvc?rev=1374045&view=rev
Log:
javadocs

Modified:
    lucene/dev/trunk/lucene/build.xml
    lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/SortField.java
    lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/TimeLimitingCollector.java
    lucene/dev/trunk/lucene/grouping/src/java/org/apache/lucene/search/grouping/AbstractDistinctValuesCollector.java
    lucene/dev/trunk/lucene/grouping/src/java/org/apache/lucene/search/grouping/CollectedSearchGroup.java

Modified: lucene/dev/trunk/lucene/build.xml
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/build.xml?rev=1374045&r1=1374044&r2=1374045&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/build.xml (original)
+++ lucene/dev/trunk/lucene/build.xml Thu Aug 16 20:41:17 2012
@@ -237,7 +237,7 @@
       <!-- core: problems -->
       <check-missing-javadocs dir="build/docs/demo" level="class"/>
       <check-missing-javadocs dir="build/docs/facet" level="class"/>
-      <!-- grouping: problems -->
+      <check-missing-javadocs dir="build/docs/grouping" level="class"/>
       <!-- highlighter: problems -->
       <check-missing-javadocs dir="build/docs/join" level="class"/>
       <check-missing-javadocs dir="build/docs/memory" level="class"/>

Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/SortField.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/SortField.java?rev=1374045&r1=1374044&r2=1374045&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/SortField.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/SortField.java Thu Aug 16 20:41:17 2012
@@ -38,6 +38,9 @@ import org.apache.lucene.util.StringHelp
  */
 public class SortField {
 
+  /**
+   * Specifies the type of the terms to be sorted, or special types such as CUSTOM
+   */
   public static enum Type {
 
     /** Sort by document score (relevance).  Sort values are Float and higher

Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/TimeLimitingCollector.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/TimeLimitingCollector.java?rev=1374045&r1=1374044&r2=1374045&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/TimeLimitingCollector.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/TimeLimitingCollector.java Thu Aug 16 20:41:17 2012
@@ -225,6 +225,8 @@ public class TimeLimitingCollector exten
   }
 
   /**
+   * Thread used to timeout search requests.
+   * Can be stopped completely with {@link TimerThread#stopTimer()}
    * @lucene.experimental
    */
   public static final class TimerThread extends Thread  {

Modified: lucene/dev/trunk/lucene/grouping/src/java/org/apache/lucene/search/grouping/AbstractDistinctValuesCollector.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/grouping/src/java/org/apache/lucene/search/grouping/AbstractDistinctValuesCollector.java?rev=1374045&r1=1374044&r2=1374045&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/grouping/src/java/org/apache/lucene/search/grouping/AbstractDistinctValuesCollector.java (original)
+++ lucene/dev/trunk/lucene/grouping/src/java/org/apache/lucene/search/grouping/AbstractDistinctValuesCollector.java Thu Aug 16 20:41:17 2012
@@ -44,6 +44,10 @@ public abstract class AbstractDistinctVa
   public void setScorer(Scorer scorer) throws IOException {
   }
 
+  /**
+   * Returned by {@link AbstractDistinctValuesCollector#getGroups()},
+   * representing the value and set of distinct values for the group.
+   */
   public abstract static class GroupCount<GROUP_VALUE_TYPE> {
 
     public final GROUP_VALUE_TYPE groupValue;

Modified: lucene/dev/trunk/lucene/grouping/src/java/org/apache/lucene/search/grouping/CollectedSearchGroup.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/grouping/src/java/org/apache/lucene/search/grouping/CollectedSearchGroup.java?rev=1374045&r1=1374044&r2=1374045&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/grouping/src/java/org/apache/lucene/search/grouping/CollectedSearchGroup.java (original)
+++ lucene/dev/trunk/lucene/grouping/src/java/org/apache/lucene/search/grouping/CollectedSearchGroup.java Thu Aug 16 20:41:17 2012
@@ -17,7 +17,12 @@
 
 package org.apache.lucene.search.grouping;
 
-/** @lucene.internal */
+import org.apache.lucene.search.FieldComparator; // javadocs
+
+/** 
+ * Expert: representation of a group in {@link AbstractFirstPassGroupingCollector},
+ * tracking the top doc and {@link FieldComparator} slot.
+ * @lucene.internal */
 public class CollectedSearchGroup<T> extends SearchGroup<T> {
   int topDoc;
   int comparatorSlot;