You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by rm...@apache.org on 2012/10/13 17:31:31 UTC

svn commit: r1397860 - in /lucene/dev/branches/lucene4446/lucene/core/src/java/org/apache/lucene/codecs/lucene41: Lucene41PostingsReader.java Lucene41PostingsWriter.java

Author: rmuir
Date: Sat Oct 13 15:31:30 2012
New Revision: 1397860

URL: http://svn.apache.org/viewvc?rev=1397860&view=rev
Log:
missing javadocs

Modified:
    lucene/dev/branches/lucene4446/lucene/core/src/java/org/apache/lucene/codecs/lucene41/Lucene41PostingsReader.java
    lucene/dev/branches/lucene4446/lucene/core/src/java/org/apache/lucene/codecs/lucene41/Lucene41PostingsWriter.java

Modified: lucene/dev/branches/lucene4446/lucene/core/src/java/org/apache/lucene/codecs/lucene41/Lucene41PostingsReader.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene4446/lucene/core/src/java/org/apache/lucene/codecs/lucene41/Lucene41PostingsReader.java?rev=1397860&r1=1397859&r2=1397860&view=diff
==============================================================================
--- lucene/dev/branches/lucene4446/lucene/core/src/java/org/apache/lucene/codecs/lucene41/Lucene41PostingsReader.java (original)
+++ lucene/dev/branches/lucene4446/lucene/core/src/java/org/apache/lucene/codecs/lucene41/Lucene41PostingsReader.java Sat Oct 13 15:31:30 2012
@@ -62,6 +62,7 @@ public final class Lucene41PostingsReade
 
   // public static boolean DEBUG = false;
 
+  /** Sole constructor. */
   public Lucene41PostingsReader(Directory dir, FieldInfos fieldInfos, SegmentInfo segmentInfo, IOContext ioContext, String segmentSuffix) throws IOException {
     boolean success = false;
     IndexInput docIn = null;

Modified: lucene/dev/branches/lucene4446/lucene/core/src/java/org/apache/lucene/codecs/lucene41/Lucene41PostingsWriter.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene4446/lucene/core/src/java/org/apache/lucene/codecs/lucene41/Lucene41PostingsWriter.java?rev=1397860&r1=1397859&r2=1397860&view=diff
==============================================================================
--- lucene/dev/branches/lucene4446/lucene/core/src/java/org/apache/lucene/codecs/lucene41/Lucene41PostingsWriter.java (original)
+++ lucene/dev/branches/lucene4446/lucene/core/src/java/org/apache/lucene/codecs/lucene41/Lucene41PostingsWriter.java Sat Oct 13 15:31:30 2012
@@ -113,6 +113,8 @@ public final class Lucene41PostingsWrite
   private final ForUtil forUtil;
   private final Lucene41SkipWriter skipWriter;
   
+  /** Creates a postings writer with the specified PackedInts overhead ratio */
+  // TODO: does this ctor even make sense?
   public Lucene41PostingsWriter(SegmentWriteState state, float acceptableOverheadRatio) throws IOException {
     super();
 
@@ -181,6 +183,7 @@ public final class Lucene41PostingsWrite
     encoded = new byte[MAX_ENCODED_SIZE];
   }
 
+  /** Creates a postings writer with <code>PackedInts.COMPACT</code> */
   public Lucene41PostingsWriter(SegmentWriteState state) throws IOException {
     this(state, PackedInts.COMPACT);
   }