svn commit: r1629406 - in /lucene/dev/branches/lucene5969/lucene: backward-codecs/src/java/org/apache/lucene/codecs/lucene40/ codecs/src/java/org/apache/lucene/codecs/simpletext/ core/src/java/org/apache/lucene/codecs/ core/src/java/org/apache/lucene/c...

[rm...@apache.org]

Author: rmuir
Date: Sat Oct  4 15:51:31 2014
New Revision: 1629406

URL: http://svn.apache.org/r1629406
Log:
LUCENE-5969: javadocs

Modified:
    lucene/dev/branches/lucene5969/lucene/backward-codecs/src/java/org/apache/lucene/codecs/lucene40/Lucene40CompoundFormat.java
    lucene/dev/branches/lucene5969/lucene/codecs/src/java/org/apache/lucene/codecs/simpletext/SimpleTextCompoundFormat.java
    lucene/dev/branches/lucene5969/lucene/core/src/java/org/apache/lucene/codecs/CompoundFormat.java
    lucene/dev/branches/lucene5969/lucene/core/src/java/org/apache/lucene/codecs/lucene50/Lucene50CompoundFormat.java
    lucene/dev/branches/lucene5969/lucene/core/src/java/org/apache/lucene/codecs/lucene50/package.html

Modified: lucene/dev/branches/lucene5969/lucene/backward-codecs/src/java/org/apache/lucene/codecs/lucene40/Lucene40CompoundFormat.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5969/lucene/backward-codecs/src/java/org/apache/lucene/codecs/lucene40/Lucene40CompoundFormat.java?rev=1629406&r1=1629405&r2=1629406&view=diff
==============================================================================
--- lucene/dev/branches/lucene5969/lucene/backward-codecs/src/java/org/apache/lucene/codecs/lucene40/Lucene40CompoundFormat.java (original)
+++ lucene/dev/branches/lucene5969/lucene/backward-codecs/src/java/org/apache/lucene/codecs/lucene40/Lucene40CompoundFormat.java Sat Oct  4 15:51:31 2014
@@ -33,6 +33,10 @@ import org.apache.lucene.store.IOContext
  */
 @Deprecated
 public final class Lucene40CompoundFormat extends CompoundFormat {
+  
+  /** Sole constructor. */
+  public Lucene40CompoundFormat() {
+  }
 
   @Override
   public Directory getCompoundReader(Directory dir, SegmentInfo si, IOContext context) throws IOException {

Modified: lucene/dev/branches/lucene5969/lucene/codecs/src/java/org/apache/lucene/codecs/simpletext/SimpleTextCompoundFormat.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5969/lucene/codecs/src/java/org/apache/lucene/codecs/simpletext/SimpleTextCompoundFormat.java?rev=1629406&r1=1629405&r2=1629406&view=diff
==============================================================================
--- lucene/dev/branches/lucene5969/lucene/codecs/src/java/org/apache/lucene/codecs/simpletext/SimpleTextCompoundFormat.java (original)
+++ lucene/dev/branches/lucene5969/lucene/codecs/src/java/org/apache/lucene/codecs/simpletext/SimpleTextCompoundFormat.java Sat Oct  4 15:51:31 2014
@@ -49,6 +49,10 @@ import org.apache.lucene.util.StringHelp
  * @lucene.experimental
  */
 public class SimpleTextCompoundFormat extends CompoundFormat {
+  
+  /** Sole constructor. */
+  public SimpleTextCompoundFormat() {
+  }
 
   @Override
   public Directory getCompoundReader(Directory dir, SegmentInfo si, IOContext context) throws IOException {

Modified: lucene/dev/branches/lucene5969/lucene/core/src/java/org/apache/lucene/codecs/CompoundFormat.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5969/lucene/core/src/java/org/apache/lucene/codecs/CompoundFormat.java?rev=1629406&r1=1629405&r2=1629406&view=diff
==============================================================================
--- lucene/dev/branches/lucene5969/lucene/core/src/java/org/apache/lucene/codecs/CompoundFormat.java (original)
+++ lucene/dev/branches/lucene5969/lucene/core/src/java/org/apache/lucene/codecs/CompoundFormat.java Sat Oct  4 15:51:31 2014
@@ -49,7 +49,10 @@ public abstract class CompoundFormat {
    */
   // TODO: get checkAbort out of here, and everywhere, and have iw do it at a higher level
   public abstract void write(Directory dir, SegmentInfo si, Collection<String> files, CheckAbort checkAbort, IOContext context) throws IOException;
-  
+
+  /**
+   * Returns the compound file names used by this segment.
+   */
   // TODO: get this out of here, and use trackingdirwrapper. but this is really scary in IW right now...
   // NOTE: generally si.useCompoundFile is not even yet 'set' when this is called.
   public abstract String[] files(SegmentInfo si);

Modified: lucene/dev/branches/lucene5969/lucene/core/src/java/org/apache/lucene/codecs/lucene50/Lucene50CompoundFormat.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5969/lucene/core/src/java/org/apache/lucene/codecs/lucene50/Lucene50CompoundFormat.java?rev=1629406&r1=1629405&r2=1629406&view=diff
==============================================================================
--- lucene/dev/branches/lucene5969/lucene/core/src/java/org/apache/lucene/codecs/lucene50/Lucene50CompoundFormat.java (original)
+++ lucene/dev/branches/lucene5969/lucene/core/src/java/org/apache/lucene/codecs/lucene50/Lucene50CompoundFormat.java Sat Oct  4 15:51:31 2014
@@ -63,6 +63,10 @@ import org.apache.lucene.store.IndexOutp
  */
 public final class Lucene50CompoundFormat extends CompoundFormat {
 
+  /** Sole constructor. */
+  public Lucene50CompoundFormat() {
+  }
+  
   @Override
   public Directory getCompoundReader(Directory dir, SegmentInfo si, IOContext context) throws IOException {
     return new Lucene50CompoundReader(dir, si, context);

Modified: lucene/dev/branches/lucene5969/lucene/core/src/java/org/apache/lucene/codecs/lucene50/package.html
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5969/lucene/core/src/java/org/apache/lucene/codecs/lucene50/package.html?rev=1629406&r1=1629405&r2=1629406&view=diff
==============================================================================
--- lucene/dev/branches/lucene5969/lucene/core/src/java/org/apache/lucene/codecs/lucene50/package.html (original)
+++ lucene/dev/branches/lucene5969/lucene/core/src/java/org/apache/lucene/codecs/lucene50/package.html Sat Oct  4 15:51:31 2014
@@ -243,7 +243,7 @@ file.</td>
 <td>Stores metadata about a segment</td>
 </tr>
 <tr>
-<td>{@link org.apache.lucene.codecs.lucene50.LUcene50CompoundFormat Compound File}</td>
+<td>{@link org.apache.lucene.codecs.lucene50.Lucene50CompoundFormat Compound File}</td>
 <td>.cfs, .cfe</td>
 <td>An optional "virtual" file consisting of all the other index files for
 systems that frequently run out of file handles.</td>