svn commit: r178894 - /lucene/java/trunk/src/java/org/apache/lucene/index/IndexReader.java /lucene/java/trunk/src/java/org/apache/lucene/index/IndexWriter.java

[dn...@apache.org]

Author: dnaber
Date: Sat May 28 16:00:49 2005
New Revision: 178894

URL: http://svn.apache.org/viewcvs?rev=178894&view=rev
Log:
javadoc improvements

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

Modified: lucene/java/trunk/src/java/org/apache/lucene/index/IndexReader.java
URL: http://svn.apache.org/viewcvs/lucene/java/trunk/src/java/org/apache/lucene/index/IndexReader.java?rev=178894&r1=178893&r2=178894&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/index/IndexReader.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/index/IndexReader.java Sat May 28 16:00:49 2005
@@ -44,6 +44,9 @@
  document in the index.  These document numbers are ephemeral--they may change
  as documents are added to and deleted from an index.  Clients should thus not
  rely on a given document having the same number between sessions.
+ 
+ <p> An IndexReader can be opened on a directory for which an IndexWriter is
+ opened already, but it cannot be used to delete documents from the index then.
 
  @author Doug Cutting
  @version $Id$

Modified: lucene/java/trunk/src/java/org/apache/lucene/index/IndexWriter.java
URL: http://svn.apache.org/viewcvs/lucene/java/trunk/src/java/org/apache/lucene/index/IndexWriter.java?rev=178894&r1=178893&r2=178894&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/index/IndexWriter.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/index/IndexWriter.java Sat May 28 16:00:49 2005
@@ -44,9 +44,14 @@
   href="#addDocument(org.apache.lucene.document.Document)"><b>addDocument</b></a> method.  
   When finished adding documents, <a href="#close()"><b>close</b></a> should be called.
 
-  If an index will not have more documents added for a while and optimal search
+  <p>If an index will not have more documents added for a while and optimal search
   performance is desired, then the <a href="#optimize()"><b>optimize</b></a>
   method should be called before the index is closed.
+  
+  <p>Opening an IndexWriter creates a lock file for the directory in use. Trying to open
+  another IndexWriter on the same directory will lead to an IOException. The IOException
+  is also thrown if an IndexReader on the same directory is used to delete documents
+  from the index.
   */
 
 public class IndexWriter {