svn commit: r1124230 - in /lucene/dev/branches/branch_3x/lucene: contrib/grouping/src/java/org/apache/lucene/search/grouping/AllGroupsCollector.java src/java/org/apache/lucene/search/CachingCollector.java

[mi...@apache.org]

Author: mikemccand
Date: Wed May 18 12:46:54 2011
New Revision: 1124230

URL: http://svn.apache.org/viewvc?rev=1124230&view=rev
Log:
fix javadoc warnings

Modified:
    lucene/dev/branches/branch_3x/lucene/contrib/grouping/src/java/org/apache/lucene/search/grouping/AllGroupsCollector.java
    lucene/dev/branches/branch_3x/lucene/src/java/org/apache/lucene/search/CachingCollector.java

Modified: lucene/dev/branches/branch_3x/lucene/contrib/grouping/src/java/org/apache/lucene/search/grouping/AllGroupsCollector.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/lucene/contrib/grouping/src/java/org/apache/lucene/search/grouping/AllGroupsCollector.java?rev=1124230&r1=1124229&r2=1124230&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/lucene/contrib/grouping/src/java/org/apache/lucene/search/grouping/AllGroupsCollector.java (original)
+++ lucene/dev/branches/branch_3x/lucene/contrib/grouping/src/java/org/apache/lucene/search/grouping/AllGroupsCollector.java Wed May 18 12:46:54 2011
@@ -34,9 +34,9 @@ import java.util.List;
  * the most relevant document of a group.
  *
  * <p/>
- * Internally, {@link SentinelIntSet} is used to detect
- * if a group is already added to the total count.  For each
- * segment the {@link SentinelIntSet} is cleared and filled
+ * Implementation detail: an int hash set (SentinelIntSet)
+ * is used to detect if a group is already added to the
+ * total count.  For each segment the int set is cleared and filled
  * with previous counted groups that occur in the new
  * segment.
  *
@@ -56,8 +56,11 @@ public class AllGroupsCollector extends 
    * Expert: Constructs a {@link AllGroupsCollector}
    *
    * @param groupField  The field to group by
-   * @param initialSize The initial size of the {@link SentinelIntSet}. The initial size should roughly match the total
-   * number of expected unique groups. Be aware that the heap usage is 4 bytes * initialSize.
+   * @param initialSize The initial allocation size of the
+   * internal int set and group list
+   * which should roughly match the total
+   * number of expected unique groups. Be aware that the
+   * heap usage is 4 bytes * initialSize.
    */
   public AllGroupsCollector(String groupField, int initialSize) {
     this.groupField = groupField;
@@ -67,9 +70,8 @@ public class AllGroupsCollector extends 
 
   /**
    * Constructs a {@link AllGroupsCollector}. This sets the
-   * initialSize for the {@link SentinelIntSet} and group
-   * list to 128 in the {@link #AllGroupsCollector(String,
-   * int)} constructor.
+   * initial allocation size for the internal int set and group
+   * list to 128.
    *
    * @param groupField The field to group by
    */

Modified: lucene/dev/branches/branch_3x/lucene/src/java/org/apache/lucene/search/CachingCollector.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/lucene/src/java/org/apache/lucene/search/CachingCollector.java?rev=1124230&r1=1124229&r2=1124230&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/lucene/src/java/org/apache/lucene/search/CachingCollector.java (original)
+++ lucene/dev/branches/branch_3x/lucene/src/java/org/apache/lucene/search/CachingCollector.java Wed May 18 12:46:54 2011
@@ -42,7 +42,7 @@ import org.apache.lucene.util.RamUsageEs
  * <p><b>NOTE</b>: this class caches at least 128 documents
  * before checking RAM limits.
  * 
- * <p>See {@link org.apache.lucene.search.grouping} for more
+ * <p>See the Lucene <tt>contrib/grouping</tt> module for more
  * details including a full code example.</p>
  *
  * @lucene.experimental