svn commit: r1124298 - in /lucene/dev/trunk: lucene/contrib/misc/src/java/org/apache/lucene/store/ lucene/src/java/org/apache/lucene/search/ modules/grouping/src/java/org/apache/lucene/search/grouping/

[mi...@apache.org]

Author: mikemccand
Date: Wed May 18 15:17:51 2011
New Revision: 1124298

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

Modified:
    lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/store/NRTCachingDirectory.java
    lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/CachingCollector.java
    lucene/dev/trunk/modules/grouping/src/java/org/apache/lucene/search/grouping/AllGroupsCollector.java

Modified: lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/store/NRTCachingDirectory.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/store/NRTCachingDirectory.java?rev=1124298&r1=1124297&r2=1124298&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/store/NRTCachingDirectory.java (original)
+++ lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/store/NRTCachingDirectory.java Wed May 18 15:17:51 2011
@@ -28,6 +28,7 @@ import org.apache.lucene.index.IndexFile
 import org.apache.lucene.index.IndexWriter;       // javadocs
 import org.apache.lucene.index.MergePolicy;
 import org.apache.lucene.index.MergeScheduler;
+import org.apache.lucene.store.RAMDirectory;      // javadocs
 import org.apache.lucene.util.IOUtils;
 
 // TODO

Modified: lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/CachingCollector.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/CachingCollector.java?rev=1124298&r1=1124297&r2=1124298&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/CachingCollector.java (original)
+++ lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/CachingCollector.java Wed May 18 15:17:51 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>modules/grouping</tt> module for more
  * details including a full code example.</p>
  *
  * @lucene.experimental

Modified: lucene/dev/trunk/modules/grouping/src/java/org/apache/lucene/search/grouping/AllGroupsCollector.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/grouping/src/java/org/apache/lucene/search/grouping/AllGroupsCollector.java?rev=1124298&r1=1124297&r2=1124298&view=diff
==============================================================================
--- lucene/dev/trunk/modules/grouping/src/java/org/apache/lucene/search/grouping/AllGroupsCollector.java (original)
+++ lucene/dev/trunk/modules/grouping/src/java/org/apache/lucene/search/grouping/AllGroupsCollector.java Wed May 18 15:17:51 2011
@@ -35,9 +35,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.
  *
@@ -58,9 +58,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} and groups list. 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;
@@ -69,8 +71,9 @@ 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.
+   * Constructs a {@link AllGroupsCollector}. This sets the
+   * initial allocation size for the internal int set and group
+   * list to 128.
    *
    * @param groupField The field to group by
    */