merge/cleanup outdated javadocs

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1349063 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Robert Muir 2012-06-11 23:01:25 +00:00
parent bffd120797
commit 25a59d8902
2 changed files with 8 additions and 20 deletions

View File

@ -61,6 +61,13 @@ import java.io.IOException;
* <li>FileName --&gt; {@link DataOutput#writeString String}</li> * <li>FileName --&gt; {@link DataOutput#writeString String}</li>
* <li>FileData --&gt; raw file data</li> * <li>FileData --&gt; raw file data</li>
* </ul> * </ul>
* <p>Notes:</p>
* <ul>
* <li>FileCount indicates how many files are contained in this compound file.
* The entry table that follows has that many entries.
* <li>Each directory entry contains a long pointer to the start of this file's data
* section, the files length, and a String with that file's name.
* </ul>
* *
* @lucene.experimental * @lucene.experimental
*/ */

View File

@ -37,26 +37,7 @@ import org.apache.lucene.util.IOUtils;
/** /**
* Combines multiple files into a single compound file. * Combines multiple files into a single compound file.
* *
* The file format data file:<br> * @see CompoundFileDirectory
* <ul>
* <li>VInt Version</li>
* <li>{File Data} fileCount entries with the raw data of the corresponding file
* </li>
* <ul>
* File format entry table:<br>
* <ul>
* <li>int Version</li>
* <li>VInt fileCount - number of entries with the following structure:</li>
* <ul>
* <li>String fileName</li>
* <li>long dataOffset</li>
* <li>long dataLength</li>
* </ul>
* </li> </ul> The fileCount integer indicates how many files are contained in
* this compound file. The entry table that follows has that many entries. Each
* directory entry contains a long pointer to the start of this file's data
* section, the files length, and a String with that file's name.
*
* @lucene.internal * @lucene.internal
*/ */
final class CompoundFileWriter implements Closeable{ final class CompoundFileWriter implements Closeable{