Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

LUCENE-10568: fix javadocs errors in IndexWriter.DocStats (#884)

This commit is contained in:
sunwq 2022-05-16 12:34:29 +08:00 committed by GitHub
parent c577508630
commit de8a6998d7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
lucene/core/src/java/org/apache/lucene/index/IndexWriter.java
View File

@ -6198,14 +6198,15 @@ public class IndexWriter
/** DocStats for this index */
public static final class DocStats {
/**
* The total number of docs in this index, including docs not yet flushed (still in the RAM
* buffer), not counting deletions.
* The total number of docs in this index, counting docs not yet flushed (still in the RAM
* buffer), and also counting deleted docs. <b>NOTE:</b> buffered deletions are not counted. If
* you really need these to be counted you should call {@link IndexWriter#commit()} first.
*/
public final int maxDoc;
/**
* The total number of docs in this index, including docs not yet flushed (still in the RAM
* buffer), and including deletions. <b>NOTE:</b> buffered deletions are not counted. If you
* really need these to be counted you should call {@link IndexWriter#commit()} first.
* The total number of docs in this index, counting docs not yet flushed (still in the RAM
* buffer), but not counting deleted docs.
*/
public final int numDocs;