svn commit: r1446665 - in /lucene/dev/branches/lucene4765/lucene/core/src/java/org/apache/lucene/index: FieldInfo.java MultiDocValues.java SortedSetDocValues.java

[rm...@apache.org]

Author: rmuir
Date: Fri Feb 15 16:09:53 2013
New Revision: 1446665

URL: http://svn.apache.org/r1446665
Log:
fix documentation-lint

Modified:
    lucene/dev/branches/lucene4765/lucene/core/src/java/org/apache/lucene/index/FieldInfo.java
    lucene/dev/branches/lucene4765/lucene/core/src/java/org/apache/lucene/index/MultiDocValues.java
    lucene/dev/branches/lucene4765/lucene/core/src/java/org/apache/lucene/index/SortedSetDocValues.java

Modified: lucene/dev/branches/lucene4765/lucene/core/src/java/org/apache/lucene/index/FieldInfo.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene4765/lucene/core/src/java/org/apache/lucene/index/FieldInfo.java?rev=1446665&r1=1446664&r2=1446665&view=diff
==============================================================================
--- lucene/dev/branches/lucene4765/lucene/core/src/java/org/apache/lucene/index/FieldInfo.java (original)
+++ lucene/dev/branches/lucene4765/lucene/core/src/java/org/apache/lucene/index/FieldInfo.java Fri Feb 15 16:09:53 2013
@@ -103,7 +103,7 @@ public final class FieldInfo {
      */
     SORTED,
     /** 
-     * A pre-sorted Set<byte[]>. Fields with this type only store distinct byte values 
+     * A pre-sorted Set&lt;byte[]&gt;. Fields with this type only store distinct byte values 
      * and store additional offset pointers per document to dereference the shared 
      * byte[]s. The stored byte[] is presorted and allows access via document id, 
      * ordinal and by-value.

Modified: lucene/dev/branches/lucene4765/lucene/core/src/java/org/apache/lucene/index/MultiDocValues.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene4765/lucene/core/src/java/org/apache/lucene/index/MultiDocValues.java?rev=1446665&r1=1446664&r2=1446665&view=diff
==============================================================================
--- lucene/dev/branches/lucene4765/lucene/core/src/java/org/apache/lucene/index/MultiDocValues.java (original)
+++ lucene/dev/branches/lucene4765/lucene/core/src/java/org/apache/lucene/index/MultiDocValues.java Fri Feb 15 16:09:53 2013
@@ -269,6 +269,7 @@ public class MultiDocValues {
   
   /** maps per-segment ordinals to/from global ordinal space */
   // TODO: use more efficient packed ints structures?
+  // TODO: pull this out? its pretty generic (maps between N ord()-enabled TermsEnums) 
   public static class OrdinalMap {
     // cache key of whoever asked for this aweful thing
     final Object owner;
@@ -279,6 +280,14 @@ public class MultiDocValues {
     // segmentOrd -> (globalOrd - segmentOrd)
     final AppendingLongBuffer ordDeltas[];
     
+    /** 
+     * Creates an ordinal map that allows mapping ords to/from a merged
+     * space from <code>subs</code>.
+     * @param owner a cache key
+     * @param subs TermsEnums that support {@link TermsEnum#ord()}. They need
+     *             not be dense (e.g. can be FilteredTermsEnums}.
+     * @throws IOException if an I/O error occurred.
+     */
     public OrdinalMap(Object owner, TermsEnum subs[]) throws IOException {
       // create the ordinal mappings by pulling a termsenum over each sub's 
       // unique terms, and walking a multitermsenum over those
@@ -320,18 +329,33 @@ public class MultiDocValues {
       }
     }
     
+    /** 
+     * Given a segment number and segment ordinal, returns
+     * the corresponding global ordinal.
+     */
     public long getGlobalOrd(int subIndex, long segmentOrd) {
       return segmentOrd + ordDeltas[subIndex].get(segmentOrd);
     }
 
+    /**
+     * Given a segment number and global ordinal, returns
+     * the corresponding segment ordinal.
+     */
     public long getSegmentOrd(int subIndex, long globalOrd) {
       return globalOrd - globalOrdDeltas.get(globalOrd);
     }
     
+    /** 
+     * Given a global ordinal, returns the index of the first
+     * sub that contains this term.
+     */
     public int getSegmentNumber(long globalOrd) {
       return (int) subIndexes.get(globalOrd);
     }
     
+    /**
+     * Returns the total number of unique terms in global ord space.
+     */
     public long getValueCount() {
       return globalOrdDeltas.size();
     }

Modified: lucene/dev/branches/lucene4765/lucene/core/src/java/org/apache/lucene/index/SortedSetDocValues.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene4765/lucene/core/src/java/org/apache/lucene/index/SortedSetDocValues.java?rev=1446665&r1=1446664&r2=1446665&view=diff
==============================================================================
--- lucene/dev/branches/lucene4765/lucene/core/src/java/org/apache/lucene/index/SortedSetDocValues.java (original)
+++ lucene/dev/branches/lucene4765/lucene/core/src/java/org/apache/lucene/index/SortedSetDocValues.java Fri Feb 15 16:09:53 2013
@@ -33,6 +33,9 @@ public abstract class SortedSetDocValues
    * constructors, typically implicit.) */
   protected SortedSetDocValues() {}
 
+  /** When returned by {@link #nextOrd()} it means there are no more 
+   * ordinals for the document.
+   */
   public static final long NO_MORE_ORDS = -1;
 
   /**