mirror of https://github.com/apache/lucene.git
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
This commit is contained in:
parent
3048b635c0
commit
4c47c26686
|
@ -19,7 +19,7 @@ package org.apache.lucene.analysis.tokenattributes;
|
||||||
|
|
||||||
import org.apache.lucene.util.Attribute;
|
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
|
* relative to the previous Token in a TokenStream, used in phrase
|
||||||
* searching.
|
* searching.
|
||||||
*
|
*
|
||||||
|
|
|
@ -20,7 +20,7 @@ package org.apache.lucene.analysis.tokenattributes;
|
||||||
import org.apache.lucene.analysis.TokenStream;
|
import org.apache.lucene.analysis.TokenStream;
|
||||||
import org.apache.lucene.util.AttributeImpl;
|
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
|
* relative to the previous Token in a {@link TokenStream}, used in phrase
|
||||||
* searching.
|
* searching.
|
||||||
*
|
*
|
||||||
|
|
|
@ -19,7 +19,7 @@ package org.apache.lucene.analysis.tokenattributes;
|
||||||
|
|
||||||
import org.apache.lucene.util.Attribute;
|
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
|
* token spans. Very few analyzer components actually
|
||||||
* produce this attribute, and indexing ignores it, but
|
* produce this attribute, and indexing ignores it, but
|
||||||
* it's useful to express the graph structure naturally
|
* it's useful to express the graph structure naturally
|
||||||
|
|
|
@ -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>
|
* <p>
|
||||||
* Writes terms dict and index, block-encoding (column
|
* Writes terms dict and index, block-encoding (column
|
||||||
* stride) each term's metadata for each set of terms
|
* stride) each term's metadata for each set of terms
|
||||||
|
|
|
@ -22,7 +22,7 @@ import java.io.IOException;
|
||||||
|
|
||||||
import org.apache.lucene.index.Fields;
|
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.
|
* payloads postings.
|
||||||
*
|
*
|
||||||
* @lucene.experimental
|
* @lucene.experimental
|
||||||
|
|
|
@ -34,7 +34,7 @@ import java.io.IOException;
|
||||||
import org.apache.lucene.index.IndexFileNames;
|
import org.apache.lucene.index.IndexFileNames;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* TermsIndexReader for simple every-nth terms indexes.
|
* TermsIndexReader for simple every Nth terms indexes.
|
||||||
*
|
*
|
||||||
* @see FixedGapTermsIndexWriter
|
* @see FixedGapTermsIndexWriter
|
||||||
* @lucene.experimental
|
* @lucene.experimental
|
||||||
|
|
|
@ -22,8 +22,8 @@ import java.io.IOException;
|
||||||
import org.apache.lucene.index.StoredFieldVisitor;
|
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
|
* You need to implement {@link #visitDocument(int, StoredFieldVisitor)} to
|
||||||
* read the stored fields for a document, implement {@link #clone()} (creating
|
* read the stored fields for a document, implement {@link #clone()} (creating
|
||||||
* clones of any IndexInputs used, etc), and {@link #close()}
|
* clones of any IndexInputs used, etc), and {@link #close()}
|
||||||
|
|
|
@ -51,7 +51,7 @@ public abstract class TermsIndexReaderBase implements Closeable {
|
||||||
/**
|
/**
|
||||||
* Similar to TermsEnum, except, the only "metadata" it
|
* Similar to TermsEnum, except, the only "metadata" it
|
||||||
* reports for a given indexed term is the long fileOffset
|
* 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 {
|
public static abstract class FieldIndexEnum {
|
||||||
|
|
||||||
|
|
|
@ -27,7 +27,8 @@ import org.apache.lucene.index.StoredFieldVisitor;
|
||||||
|
|
||||||
/** A {@link StoredFieldVisitor} that creates a {@link
|
/** A {@link StoredFieldVisitor} that creates a {@link
|
||||||
* Document} containing all stored fields, or only specific
|
* 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
|
* This is used by {@link IndexReader#document(int)} to load a
|
||||||
* document.
|
* document.
|
||||||
*
|
*
|
||||||
|
|
Loading…
Reference in New Issue