fix javadoc comment (copy+paste error)

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@410160 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/lucene/index/IndexModifier.java

@@ -400,18 +400,17 @@ public class IndexModifier {
   }
 
   /**
-   * The maximum number of terms that will be indexed for a single field in a
+   * Determines the minimal number of documents required before the buffered
-   * document.  This limits the amount of memory required for indexing, so that
+   * in-memory documents are merging and a new Segment is created.
-   * collections with very large files will not crash the indexing process by
+   * Since Documents are merged in a {@link org.apache.lucene.store.RAMDirectory},
-   * running out of memory.<p/>
+   * large value gives faster indexing.  At the same time, mergeFactor limits
-   * Note that this effectively truncates large documents, excluding from the
+   * the number of files open in a FSDirectory.
-   * index terms that occur further in the document.  If you know your source
+   *
-   * documents are large, be sure to set this value high enough to accomodate
+   * <p>The default value is 10.
-   * the expected size.  If you set it to Integer.MAX_VALUE, then the only limit
+   * 
-   * is your memory, but you should anticipate an OutOfMemoryError.<p/>
-   * By default, no more than 10,000 terms will be indexed for a field.
    * @see IndexWriter#setMaxBufferedDocs(int)
    * @throws IllegalStateException if the index is closed
+   * @throws IllegalArgumentException if maxBufferedDocs is smaller than 2
    */
   public void setMaxBufferedDocs(int maxBufferedDocs) {
     synchronized(directory) {