lucene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rm...@apache.org
Subject svn commit: r1376514 - in /lucene/dev/trunk/lucene/core/src/java/org/apache/lucene: analysis/tokenattributes/ codecs/ document/
Date Thu, 23 Aug 2012 14:48:33 GMT
Author: rmuir
Date: Thu Aug 23 14:48:33 2012
New Revision: 1376514

URL: http://svn.apache.org/viewvc?rev=1376514&view=rev
Log:
javadocs summary consistency and sentence bounds fixes

Modified:
    lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttribute.java
    lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttributeImpl.java
    lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionLengthAttribute.java
    lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/BlockTreeTermsWriter.java
    lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/FieldsProducer.java
    lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/FixedGapTermsIndexReader.java
    lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/StoredFieldsReader.java
    lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/TermsIndexReaderBase.java
    lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java

Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttribute.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttribute.java?rev=1376514&r1=1376513&r2=1376514&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttribute.java
(original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttribute.java
Thu Aug 23 14:48:33 2012
@@ -19,7 +19,7 @@ package org.apache.lucene.analysis.token
 
 import org.apache.lucene.util.Attribute;
 
-/** The positionIncrement determines the position of this token
+/** Determines the position of this token
  * relative to the previous Token in a TokenStream, used in phrase
  * searching.
  *

Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttributeImpl.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttributeImpl.java?rev=1376514&r1=1376513&r2=1376514&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttributeImpl.java
(original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttributeImpl.java
Thu Aug 23 14:48:33 2012
@@ -20,7 +20,7 @@ package org.apache.lucene.analysis.token
 import org.apache.lucene.analysis.TokenStream;
 import org.apache.lucene.util.AttributeImpl;
 
-/** The positionIncrement determines the position of this token
+/** Determines the position of this token
  * relative to the previous Token in a {@link TokenStream}, used in phrase
  * searching.
  *

Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionLengthAttribute.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionLengthAttribute.java?rev=1376514&r1=1376513&r2=1376514&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionLengthAttribute.java
(original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionLengthAttribute.java
Thu Aug 23 14:48:33 2012
@@ -19,7 +19,7 @@ package org.apache.lucene.analysis.token
 
 import org.apache.lucene.util.Attribute;
 
-/** The positionLength determines how many positions this
+/** Determines how many positions this
  *  token spans.  Very few analyzer components actually
  *  produce this attribute, and indexing ignores it, but
  *  it's useful to express the graph structure naturally

Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/BlockTreeTermsWriter.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/BlockTreeTermsWriter.java?rev=1376514&r1=1376513&r2=1376514&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/BlockTreeTermsWriter.java
(original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/BlockTreeTermsWriter.java
Thu Aug 23 14:48:33 2012
@@ -71,7 +71,7 @@ import org.apache.lucene.util.fst.Util;
 */
 
 /**
- * block-based terms index and dictionary writer.
+ * Block-based terms index and dictionary writer.
  * <p>
  * Writes terms dict and index, block-encoding (column
  * stride) each term's metadata for each set of terms

Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/FieldsProducer.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/FieldsProducer.java?rev=1376514&r1=1376513&r2=1376514&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/FieldsProducer.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/FieldsProducer.java Thu
Aug 23 14:48:33 2012
@@ -22,7 +22,7 @@ import java.io.IOException;
 
 import org.apache.lucene.index.Fields;
 
-/** Abstract API that produces terms, doc, freq, prox and
+/** Abstract API that produces terms, doc, freq, prox, offset and
  *  payloads postings.  
  *
  * @lucene.experimental

Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/FixedGapTermsIndexReader.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/FixedGapTermsIndexReader.java?rev=1376514&r1=1376513&r2=1376514&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/FixedGapTermsIndexReader.java
(original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/FixedGapTermsIndexReader.java
Thu Aug 23 14:48:33 2012
@@ -34,7 +34,7 @@ import java.io.IOException;
 import org.apache.lucene.index.IndexFileNames;
 
 /** 
- * TermsIndexReader for simple every-nth terms indexes.
+ * TermsIndexReader for simple every Nth terms indexes.
  *
  * @see FixedGapTermsIndexWriter
  * @lucene.experimental 

Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/StoredFieldsReader.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/StoredFieldsReader.java?rev=1376514&r1=1376513&r2=1376514&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/StoredFieldsReader.java
(original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/StoredFieldsReader.java
Thu Aug 23 14:48:33 2012
@@ -22,8 +22,8 @@ import java.io.IOException;
 import org.apache.lucene.index.StoredFieldVisitor;
 
 /**
- * Codec API for reading stored fields:
- * 
+ * Codec API for reading stored fields.
+ * <p>
  * You need to implement {@link #visitDocument(int, StoredFieldVisitor)} to
  * read the stored fields for a document, implement {@link #clone()} (creating
  * clones of any IndexInputs used, etc), and {@link #close()}

Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/TermsIndexReaderBase.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/TermsIndexReaderBase.java?rev=1376514&r1=1376513&r2=1376514&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/TermsIndexReaderBase.java
(original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/TermsIndexReaderBase.java
Thu Aug 23 14:48:33 2012
@@ -51,7 +51,7 @@ public abstract class TermsIndexReaderBa
   /** 
    * Similar to TermsEnum, except, the only "metadata" it
    * reports for a given indexed term is the long fileOffset
-   * into the main terms dictionary file:
+   * into the main terms dictionary file.
    */
   public static abstract class FieldIndexEnum {
 

Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java?rev=1376514&r1=1376513&r2=1376514&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java
(original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java
Thu Aug 23 14:48:33 2012
@@ -27,7 +27,8 @@ import org.apache.lucene.index.StoredFie
 
 /** A {@link StoredFieldVisitor} that creates a {@link
  *  Document} containing all stored fields, or only specific
- *  requested fields provided to {@link #DocumentStoredFieldVisitor(Set)}
+ *  requested fields provided to {@link #DocumentStoredFieldVisitor(Set)}.
+ *  <p>
  *  This is used by {@link IndexReader#document(int)} to load a
  *  document.
  *



Mime
View raw message