improve the API doc for getUseCompoundFile()

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@150420 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Daniel Naber 2004-08-11 18:59:08 +00:00
parent 76e2362954
commit d42dd740d6
1 changed files with 4 additions and 3 deletions

View File

@ -121,9 +121,10 @@ public class IndexWriter {
private boolean closeDir;
/** Setting to turn on usage of a compound file. When on, multiple files
* for each segment are merged into a single file once the segment creation
* is finished. This is done regardless of what directory is in use.
/** Get the current setting of whether to use the compound file format.
* Note that this just returns the value you set with setUseCompoundFile(boolean)
* or the default. You cannot use this to query the status of an existing index.
* @see #setUseCompoundFile(boolean)
*/
public boolean getUseCompoundFile() {
return useCompoundFile;