You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by mi...@apache.org on 2010/08/30 17:28:46 UTC

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

Author: mikemccand
Date: Mon Aug 30 15:28:45 2010
New Revision: 990823

URL: http://svn.apache.org/viewvc?rev=990823&view=rev
Log:
javadoc fixes

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=990823&r1=990822&r2=990823&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 Mon Aug 30 15:28:45 2010
@@ -64,9 +64,8 @@ import java.util.concurrent.atomic.Atomi
 
  <b>NOTE</b>: as of 2.4, it's possible to open a read-only
  IndexReader using the static open methods that accept the 
- boolean readOnly parameter.  Such a reader has better 
- concurrency as it's not necessary to synchronize on the 
- isDeleted method.  You must specify false if you want to 
+ boolean readOnly parameter.  Such a reader may have better 
+ concurrency.  You must specify false if you want to 
  make changes with the resulting IndexReader.
  </p>
 
@@ -744,8 +743,8 @@ public abstract class IndexReader implem
    * <b>NOTE:</b> for performance reasons, this method does not check if the
    * requested document is deleted, and therefore asking for a deleted document
    * may yield unspecified results. Usually this is not required, however you
-   * can call {@link #isDeleted(int)} with the requested document ID to verify
-   * the document is not deleted.
+   * can test if the doc is deleted by checking the {@link
+   * Bits} returned from {@link MultiFields#getDeletedDocs}.
    * 
    * @throws CorruptIndexException if the index is corrupt
    * @throws IOException if there is a low-level IO error
@@ -769,8 +768,8 @@ public abstract class IndexReader implem
    * <b>NOTE:</b> for performance reasons, this method does not check if the
    * requested document is deleted, and therefore asking for a deleted document
    * may yield unspecified results. Usually this is not required, however you
-   * can call {@link #isDeleted(int)} with the requested document ID to verify
-   * the document is not deleted.
+   * can test if the doc is deleted by checking the {@link
+   * Bits} returned from {@link MultiFields#getDeletedDocs}.
    * 
    * @param n Get the document at the <code>n</code><sup>th</sup> position
    * @param fieldSelector The {@link FieldSelector} to use to determine what