svn commit: r1466276 - in /lucene/dev/branches/branch_4x: ./ lucene/ lucene/core/ lucene/core/src/java/org/apache/lucene/util/BytesRefHash.java

[mi...@apache.org]

Author: mikemccand
Date: Tue Apr  9 22:44:18 2013
New Revision: 1466276

URL: http://svn.apache.org/r1466276
Log:
add javadoc

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/util/BytesRefHash.java

Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/util/BytesRefHash.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/util/BytesRefHash.java?rev=1466276&r1=1466275&r2=1466276&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/util/BytesRefHash.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/util/BytesRefHash.java Tue Apr  9 22:44:18 2013
@@ -402,6 +402,12 @@ public final class BytesRefHash {
     return hashPos;
   }
 
+  /** Adds a "arbitrary" int offset instead of a BytesRef
+   *  term.  This is used in the indexer to hold the hash for term
+   *  vectors, because they do not redundantly store the byte[] term
+   *  directly and instead reference the byte[] term
+   *  already stored by the postings BytesRefHash.  See
+   *  add(int textStart) in TermsHashPerField. */
   public int addByPoolOffset(int offset) {
     assert bytesStart != null : "Bytesstart is null - not initialized";
     // final position