lucene-java-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mikemcc...@apache.org
Subject svn commit: r649598 - /lucene/java/trunk/src/java/org/apache/lucene/index/IndexModifier.java
Date Fri, 18 Apr 2008 16:35:17 GMT
Author: mikemccand
Date: Fri Apr 18 09:35:08 2008
New Revision: 649598

URL: http://svn.apache.org/viewvc?rev=649598&view=rev
Log:
add warnings to javadoc for IndexModifier.docCount

Modified:
    lucene/java/trunk/src/java/org/apache/lucene/index/IndexModifier.java

Modified: lucene/java/trunk/src/java/org/apache/lucene/index/IndexModifier.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/index/IndexModifier.java?rev=649598&r1=649597&r2=649598&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/index/IndexModifier.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/index/IndexModifier.java Fri Apr 18 09:35:08
2008
@@ -338,9 +338,12 @@
 
 
   /**
-   * Returns the number of documents currently in this index.
-   * @see IndexWriter#docCount()
-   * @see IndexReader#numDocs()
+   * Returns the number of documents currently in this
+   * index.  If the writer is currently open, this returns
+   * {@link IndexWriter#docCount()}, else {@link
+   * IndexReader#numDocs()}.  But, note that {@link
+   * IndexWriter#docCount()} does not take deletions into
+   * account, unlike {@link IndexReader#numDocs}.
    * @throws IllegalStateException if the index is closed
    */
   public int docCount() {



Mime
View raw message