Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix javadoc warnings 

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1124298 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael McCandless 2011-05-18 15:17:51 +00:00
parent af9930c6cb
commit 92b00742ee
3 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
lucene/contrib/misc/src/java/org/apache/lucene/store/NRTCachingDirectory.java
View File

@ -28,6 +28,7 @@ import org.apache.lucene.index.IndexFileNames;
import org.apache.lucene.index.IndexWriter; // javadocs import org.apache.lucene.index.IndexWriter; // javadocs
import org.apache.lucene.index.MergePolicy; import org.apache.lucene.index.MergePolicy;
import org.apache.lucene.index.MergeScheduler; import org.apache.lucene.index.MergeScheduler;
import org.apache.lucene.store.RAMDirectory; // javadocs
import org.apache.lucene.util.IOUtils; import org.apache.lucene.util.IOUtils;
// TODO // TODO

2
lucene/src/java/org/apache/lucene/search/CachingCollector.java
View File

@ -42,7 +42,7 @@ import org.apache.lucene.util.RamUsageEstimator;
* <p><b>NOTE</b>: this class caches at least 128 documents * <p><b>NOTE</b>: this class caches at least 128 documents
* before checking RAM limits. * 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> * details including a full code example.</p>
* *
* @lucene.experimental * @lucene.experimental

19
modules/grouping/src/java/org/apache/lucene/search/grouping/AllGroupsCollector.java
View File

@ -35,9 +35,9 @@ import java.util.List;
* the most relevant document of a group. * the most relevant document of a group.
* *
* <p/> * <p/>
* Internally, {@link SentinelIntSet} is used to detect * Implementation detail: an int hash set (SentinelIntSet)
* if a group is already added to the total count. For each * is used to detect if a group is already added to the
* segment the {@link SentinelIntSet} is cleared and filled * total count. For each segment the int set is cleared and filled
* with previous counted groups that occur in the new * with previous counted groups that occur in the new
* segment. * segment.
* *
@ -58,9 +58,11 @@ public class AllGroupsCollector extends Collector {
* Expert: Constructs a {@link AllGroupsCollector} * Expert: Constructs a {@link AllGroupsCollector}
* *
* @param groupField The field to group by * @param groupField The field to group by
* @param initialSize The initial size of the {@link SentinelIntSet} and groups list. The initial size should * @param initialSize The initial allocation size of the
* roughly match the total number of expected unique groups. Be aware that the heap usage * internal int set and group list
* is 4 bytes * initialSize. * 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) { public AllGroupsCollector(String groupField, int initialSize) {
this.groupField = groupField; this.groupField = groupField;
@ -69,8 +71,9 @@ public class AllGroupsCollector extends Collector {
} }
/** /**
* Constructs a {@link AllGroupsCollector}. This sets the initialSize for the {@link SentinelIntSet} and group list * Constructs a {@link AllGroupsCollector}. This sets the
* 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 * @param groupField The field to group by
*/ */