svn commit: r1349064 - in /lucene/dev/branches/branch_4x: ./ lucene/ lucene/core/ lucene/core/src/java/org/apache/lucene/store/CompoundFileDirectory.java lucene/core/src/java/org/apache/lucene/store/CompoundFileWriter.java

[rm...@apache.org]

Author: rmuir
Date: Mon Jun 11 23:02:07 2012
New Revision: 1349064

URL: http://svn.apache.org/viewvc?rev=1349064&view=rev
Log:
merge/cleanup outdated javadocs

Modified:
    lucene/dev/branches/branch_4x/   (props changed)
    lucene/dev/branches/branch_4x/lucene/   (props changed)
    lucene/dev/branches/branch_4x/lucene/core/   (props changed)
    lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/store/CompoundFileDirectory.java
    lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/store/CompoundFileWriter.java

Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/store/CompoundFileDirectory.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/store/CompoundFileDirectory.java?rev=1349064&r1=1349063&r2=1349064&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/store/CompoundFileDirectory.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/store/CompoundFileDirectory.java Mon Jun 11 23:02:07 2012
@@ -61,6 +61,13 @@ import java.io.IOException;
  *   <li>FileName --&gt; {@link DataOutput#writeString String}</li>
  *   <li>FileData --&gt; raw file data</li>
  * </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
  */

Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/store/CompoundFileWriter.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/store/CompoundFileWriter.java?rev=1349064&r1=1349063&r2=1349064&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/store/CompoundFileWriter.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/store/CompoundFileWriter.java Mon Jun 11 23:02:07 2012
@@ -37,26 +37,7 @@ import org.apache.lucene.util.IOUtils;
 /**
  * Combines multiple files into a single compound file.
  * 
- * The file format data file:<br>
- * <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.
- * 
+ * @see CompoundFileDirectory
  * @lucene.internal
  */
 final class CompoundFileWriter implements Closeable{