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

LUCENE-3023: clear javadocs errors 

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1098461 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Robert Muir 2011-05-02 02:31:01 +00:00
parent 2a969f828c
commit c096f2e1e6
5 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
lucene/src/java/org/apache/lucene/index/FlushByRamOrCountsPolicy.java
View File

@ -25,18 +25,18 @@ import org.apache.lucene.index.DocumentsWriterPerThreadPool.ThreadState;
* {@link IndexWriterConfig}. * {@link IndexWriterConfig}.
* *
* <ul> * <ul>
* <li>{@link #onDelete(DocumentsWriterFlushControl, ThreadState)} - flushes * <li>{@link #onDelete(DocumentsWriterFlushControl, DocumentsWriterPerThreadPool.ThreadState)} - flushes
* based on the global number of buffered delete terms iff * based on the global number of buffered delete terms iff
* {@link IndexWriterConfig#getMaxBufferedDeleteTerms()} is enabled</li> * {@link IndexWriterConfig#getMaxBufferedDeleteTerms()} is enabled</li>
* <li>{@link #onInsert(DocumentsWriterFlushControl, ThreadState)} - flushes * <li>{@link #onInsert(DocumentsWriterFlushControl, DocumentsWriterPerThreadPool.ThreadState)} - flushes
* either on the number of documents per {@link DocumentsWriterPerThread} ( * either on the number of documents per {@link DocumentsWriterPerThread} (
* {@link DocumentsWriterPerThread#getNumDocsInRAM()}) or on the global active * {@link DocumentsWriterPerThread#getNumDocsInRAM()}) or on the global active
* memory consumption in the current indexing session iff * memory consumption in the current indexing session iff
* {@link IndexWriterConfig#getMaxBufferedDocs()} or * {@link IndexWriterConfig#getMaxBufferedDocs()} or
* {@link IndexWriterConfig#getRAMBufferSizeMB()} is enabled respectively</li> * {@link IndexWriterConfig#getRAMBufferSizeMB()} is enabled respectively</li>
* <li>{@link #onUpdate(DocumentsWriterFlushControl, ThreadState)} - calls * <li>{@link #onUpdate(DocumentsWriterFlushControl, DocumentsWriterPerThreadPool.ThreadState)} - calls
* {@link #onInsert(DocumentsWriterFlushControl, ThreadState)} and * {@link #onInsert(DocumentsWriterFlushControl, DocumentsWriterPerThreadPool.ThreadState)} and
* {@link #onDelete(DocumentsWriterFlushControl, ThreadState)} in order</li> * {@link #onDelete(DocumentsWriterFlushControl, DocumentsWriterPerThreadPool.ThreadState)} in order</li>
* </ul> * </ul>
* All {@link IndexWriterConfig} settings are used to mark * All {@link IndexWriterConfig} settings are used to mark
* {@link DocumentsWriterPerThread} as flush pending during indexing with * {@link DocumentsWriterPerThread} as flush pending during indexing with

4
lucene/src/java/org/apache/lucene/index/FlushPolicy.java
View File

@ -43,7 +43,7 @@ import org.apache.lucene.util.SetOnce;
* {@link DocumentsWriterFlushControl}, the {@link FlushPolicy} decides if a * {@link DocumentsWriterFlushControl}, the {@link FlushPolicy} decides if a
* {@link DocumentsWriterPerThread} needs flushing and mark it as * {@link DocumentsWriterPerThread} needs flushing and mark it as
* flush-pending via * flush-pending via
* {@link DocumentsWriterFlushControl#setFlushPending(ThreadState)}. * {@link DocumentsWriterFlushControl#setFlushPending(DocumentsWriterPerThreadPool.ThreadState)}.
* *
* @see ThreadState * @see ThreadState
* @see DocumentsWriterFlushControl * @see DocumentsWriterFlushControl
@ -92,7 +92,7 @@ public abstract class FlushPolicy {
ThreadState state); ThreadState state);
/** /**
* Called by {@link DocumentsWriter} to initialize the FlushPolicy * Called by DocumentsWriter to initialize the FlushPolicy
*/ */
protected synchronized void init(DocumentsWriter docsWriter) { protected synchronized void init(DocumentsWriter docsWriter) {
writer.set(docsWriter); writer.set(docsWriter);

2
lucene/src/java/org/apache/lucene/index/IndexWriter.java
View File

@ -82,7 +82,7 @@ import org.apache.lucene.util.MapBackedSet;
documents (see {@link IndexWriterConfig#setRAMBufferSizeMB}) or the documents (see {@link IndexWriterConfig#setRAMBufferSizeMB}) or the
number of added documents (see {@link IndexWriterConfig#setMaxBufferedDocs(int)}). number of added documents (see {@link IndexWriterConfig#setMaxBufferedDocs(int)}).
The default is to flush when RAM usage hits The default is to flush when RAM usage hits
{@value IndexWriterConfig#DEFAULT_RAM_BUFFER_SIZE_MB} MB. For {@link IndexWriterConfig#DEFAULT_RAM_BUFFER_SIZE_MB} MB. For
best indexing speed you should flush by RAM usage with a best indexing speed you should flush by RAM usage with a
large RAM buffer. Additionally, if IndexWriter reaches the configured number of large RAM buffer. Additionally, if IndexWriter reaches the configured number of
buffered deletes (see {@link IndexWriterConfig#setMaxBufferedDeleteTerms}) buffered deletes (see {@link IndexWriterConfig#setMaxBufferedDeleteTerms})

2
lucene/src/java/org/apache/lucene/index/IndexWriterConfig.java
View File

@ -538,7 +538,7 @@ public final class IndexWriterConfig implements Cloneable {
* IndexWriter to assign thread-states to incoming indexing threads. If no * IndexWriter to assign thread-states to incoming indexing threads. If no
* {@link DocumentsWriterPerThreadPool} is set {@link IndexWriter} will use * {@link DocumentsWriterPerThreadPool} is set {@link IndexWriter} will use
* {@link ThreadAffinityDocumentsWriterThreadPool} with max number of * {@link ThreadAffinityDocumentsWriterThreadPool} with max number of
* thread-states set to {@value DocumentsWriterPerThreadPool#DEFAULT_MAX_THREAD_STATES} (see * thread-states set to {@link DocumentsWriterPerThreadPool#DEFAULT_MAX_THREAD_STATES} (see
* {@link DocumentsWriterPerThreadPool#DEFAULT_MAX_THREAD_STATES}). * {@link DocumentsWriterPerThreadPool#DEFAULT_MAX_THREAD_STATES}).
* </p> * </p>
* <p> * <p>

1
lucene/src/java/org/apache/lucene/index/ThreadAffinityDocumentsWriterThreadPool.java
View File

@ -19,6 +19,7 @@ import java.util.Map;
import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentHashMap;
import org.apache.lucene.document.Document; import org.apache.lucene.document.Document;
import org.apache.lucene.index.DocumentsWriterPerThreadPool.ThreadState; //javadoc
/** /**
* A {@link DocumentsWriterPerThreadPool} implementation that tries to assign an * A {@link DocumentsWriterPerThreadPool} implementation that tries to assign an