From c5d2165437816de61c0b06a5d4e54a5f442896e4 Mon Sep 17 00:00:00 2001 From: Michael McCandless Date: Mon, 30 Aug 2010 15:28:45 +0000 Subject: [PATCH] javadoc fixes git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@990823 13f79535-47bb-0310-9956-ffa450edef68 --- .../java/org/apache/lucene/index/IndexReader.java | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/lucene/src/java/org/apache/lucene/index/IndexReader.java b/lucene/src/java/org/apache/lucene/index/IndexReader.java index 7940059fd20..14dcd4a0755 100644 --- a/lucene/src/java/org/apache/lucene/index/IndexReader.java +++ b/lucene/src/java/org/apache/lucene/index/IndexReader.java @@ -64,9 +64,8 @@ import java.util.concurrent.atomic.AtomicInteger; NOTE: 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.

@@ -744,8 +743,8 @@ public abstract class IndexReader implements Cloneable,Closeable { * NOTE: 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 implements Cloneable,Closeable { * NOTE: 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 nth position * @param fieldSelector The {@link FieldSelector} to use to determine what