svn commit: r1063513 - /lucene/dev/trunk/lucene/src/java/org/apache/lucene/index/IndexReader.java

[mi...@apache.org]

Author: mikemccand
Date: Tue Jan 25 23:15:01 2011
New Revision: 1063513

URL: http://svn.apache.org/viewvc?rev=1063513&view=rev
Log:
LUCENE-2887: sharpen jdocs for IndexReader.undeleteAll

Modified:
    lucene/dev/trunk/lucene/src/java/org/apache/lucene/index/IndexReader.java

Modified: lucene/dev/trunk/lucene/src/java/org/apache/lucene/index/IndexReader.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/src/java/org/apache/lucene/index/IndexReader.java?rev=1063513&r1=1063512&r2=1063513&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/src/java/org/apache/lucene/index/IndexReader.java (original)
+++ lucene/dev/trunk/lucene/src/java/org/apache/lucene/index/IndexReader.java Tue Jan 25 23:15:01 2011
@@ -1227,11 +1227,13 @@ public abstract class IndexReader implem
   /** Undeletes all documents currently marked as deleted in
    * this index.
    *
-   * <p>NOTE: this is only a best-effort process.  For
-   * example, if all documents in a given segment were
-   * deleted, Lucene now drops that segment from the index,
-   * which means its documents will not be recovered by this
-   * method.
+   * <p>NOTE: this method can only recover documents marked
+   * for deletion but not yet removed from the index; when
+   * and how Lucene removes deleted documents is an
+   * implementation detail, subject to change from release
+   * to release.  However, you can use {@link
+   * #numDeletedDocs} on the current IndexReader instance to
+   * see how many documents will be un-deleted.
    *
    * @throws StaleReaderException if the index has changed
    *  since this reader was opened