From 4c47c2668644c3b7693a5fa90d005af43bbc04b0 Mon Sep 17 00:00:00 2001 From: Robert Muir Date: Thu, 23 Aug 2012 14:48:33 +0000 Subject: [PATCH] javadocs summary consistency and sentence bounds fixes git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1376514 13f79535-47bb-0310-9956-ffa450edef68 --- .../analysis/tokenattributes/PositionIncrementAttribute.java | 2 +- .../tokenattributes/PositionIncrementAttributeImpl.java | 2 +- .../analysis/tokenattributes/PositionLengthAttribute.java | 2 +- .../java/org/apache/lucene/codecs/BlockTreeTermsWriter.java | 2 +- .../src/java/org/apache/lucene/codecs/FieldsProducer.java | 2 +- .../org/apache/lucene/codecs/FixedGapTermsIndexReader.java | 2 +- .../src/java/org/apache/lucene/codecs/StoredFieldsReader.java | 4 ++-- .../java/org/apache/lucene/codecs/TermsIndexReaderBase.java | 2 +- .../apache/lucene/document/DocumentStoredFieldVisitor.java | 3 ++- 9 files changed, 11 insertions(+), 10 deletions(-) diff --git a/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttribute.java b/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttribute.java index 3229c84f7f2..fba07508701 100644 --- a/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttribute.java +++ b/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttribute.java @@ -19,7 +19,7 @@ package org.apache.lucene.analysis.tokenattributes; 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. * diff --git a/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttributeImpl.java b/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttributeImpl.java index 2336d08fdc3..7cf47b16ae6 100644 --- a/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttributeImpl.java +++ b/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionIncrementAttributeImpl.java @@ -20,7 +20,7 @@ package org.apache.lucene.analysis.tokenattributes; 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. * diff --git a/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionLengthAttribute.java b/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionLengthAttribute.java index 8589cd13e5d..6facfec4c72 100644 --- a/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionLengthAttribute.java +++ b/lucene/core/src/java/org/apache/lucene/analysis/tokenattributes/PositionLengthAttribute.java @@ -19,7 +19,7 @@ package org.apache.lucene.analysis.tokenattributes; 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 diff --git a/lucene/core/src/java/org/apache/lucene/codecs/BlockTreeTermsWriter.java b/lucene/core/src/java/org/apache/lucene/codecs/BlockTreeTermsWriter.java index 73bceb5c107..5cefa24658d 100644 --- a/lucene/core/src/java/org/apache/lucene/codecs/BlockTreeTermsWriter.java +++ b/lucene/core/src/java/org/apache/lucene/codecs/BlockTreeTermsWriter.java @@ -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. *

* Writes terms dict and index, block-encoding (column * stride) each term's metadata for each set of terms diff --git a/lucene/core/src/java/org/apache/lucene/codecs/FieldsProducer.java b/lucene/core/src/java/org/apache/lucene/codecs/FieldsProducer.java index a27dcacd186..a9a3d98a888 100644 --- a/lucene/core/src/java/org/apache/lucene/codecs/FieldsProducer.java +++ b/lucene/core/src/java/org/apache/lucene/codecs/FieldsProducer.java @@ -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 diff --git a/lucene/core/src/java/org/apache/lucene/codecs/FixedGapTermsIndexReader.java b/lucene/core/src/java/org/apache/lucene/codecs/FixedGapTermsIndexReader.java index d2df89be6bc..15f85189001 100644 --- a/lucene/core/src/java/org/apache/lucene/codecs/FixedGapTermsIndexReader.java +++ b/lucene/core/src/java/org/apache/lucene/codecs/FixedGapTermsIndexReader.java @@ -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 diff --git a/lucene/core/src/java/org/apache/lucene/codecs/StoredFieldsReader.java b/lucene/core/src/java/org/apache/lucene/codecs/StoredFieldsReader.java index a8fec4425e4..c5205e7f855 100644 --- a/lucene/core/src/java/org/apache/lucene/codecs/StoredFieldsReader.java +++ b/lucene/core/src/java/org/apache/lucene/codecs/StoredFieldsReader.java @@ -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. + *

* 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()} diff --git a/lucene/core/src/java/org/apache/lucene/codecs/TermsIndexReaderBase.java b/lucene/core/src/java/org/apache/lucene/codecs/TermsIndexReaderBase.java index c7a266501dd..38453054ff3 100644 --- a/lucene/core/src/java/org/apache/lucene/codecs/TermsIndexReaderBase.java +++ b/lucene/core/src/java/org/apache/lucene/codecs/TermsIndexReaderBase.java @@ -51,7 +51,7 @@ public abstract class TermsIndexReaderBase implements Closeable { /** * 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 { diff --git a/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java b/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java index 275dc94374f..5a8f4d2c25a 100644 --- a/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java +++ b/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java @@ -27,7 +27,8 @@ import org.apache.lucene.index.StoredFieldVisitor; /** 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)}. + *

* This is used by {@link IndexReader#document(int)} to load a * document. *