Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

LUCENE-4011: Fixed some lucene core javadoc links 

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1329012 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Christopher John Male 2012-04-23 00:42:20 +00:00
parent 1381427039
commit 46b66c5b71
13 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
lucene/core/src/java/org/apache/lucene/document/Field.java
View File

@ -32,6 +32,7 @@ import org.apache.lucene.index.IndexableField;
import org.apache.lucene.index.IndexableFieldType;
import org.apache.lucene.index.Norm;
import org.apache.lucene.util.BytesRef;
import org.apache.lucene.index.FieldInvertState; // javadocs
/**
* Expert: directly creata a field for a document. Most

2
lucene/core/src/java/org/apache/lucene/index/DocumentsWriterPerThread.java
View File

@ -40,7 +40,7 @@ import org.apache.lucene.util.MutableBits;
public class DocumentsWriterPerThread {
/**
* The IndexingChain must define the {@link #getChain(DocumentsWriter)} method
* The IndexingChain must define the {@link #getChain(DocumentsWriterPerThread)} method
* which returns the DocConsumer that the DocumentsWriter calls to process the
* documents.
*/

3
lucene/core/src/java/org/apache/lucene/index/FieldInvertState.java
View File

@ -50,8 +50,7 @@ public final class FieldInvertState {
}
/**
* Re-initialize the state, using this boost value.
* @param docBoost boost value to use.
* Re-initialize the state
*/
void reset() {
position = 0;

8
lucene/core/src/java/org/apache/lucene/index/IndexWriter.java
View File

@ -292,7 +292,7 @@ public class IndexWriter implements Closeable, TwoPhaseCommit {
* learn, improve and iterate.</p>
*
* <p>The resulting reader supports {@link
* IndexReader#reopen}, but that call will simply forward
* DirectoryReader#openIfChanged}, but that call will simply forward
* back to this method (though this may change in the
* future).</p>
*
@ -303,7 +303,7 @@ public class IndexWriter implements Closeable, TwoPhaseCommit {
* file descriptors, CPU time) will be consumed.</p>
*
* <p>For lower latency on reopening a reader, you should
* call {@link #setMergedSegmentWarmer} to
* call {@link IndexWriterConfig#setMergedSegmentWarmer} to
* pre-warm a newly merged segment before it's committed
* to the index. This is important for minimizing
* index-to-search delay after a large merge. </p>
@ -1948,11 +1948,11 @@ public class IndexWriter implements Closeable, TwoPhaseCommit {
/**
* Prepares the {@link SegmentInfo} for the new flushed segment and persists
* the deleted documents {@link MutableBits}. Use
* {@link #publishFlushedSegment(SegmentInfo, FrozenBufferedDeletes)} to
* {@link #publishFlushedSegment(SegmentInfo, FrozenBufferedDeletes, FrozenBufferedDeletes)} to
* publish the returned {@link SegmentInfo} together with its segment private
* delete packet.
*
* @see #publishFlushedSegment(SegmentInfo, FrozenBufferedDeletes)
* @see #publishFlushedSegment(SegmentInfo, FrozenBufferedDeletes, FrozenBufferedDeletes)
*/
SegmentInfo prepareFlushedSegment(FlushedSegment flushedSegment) throws IOException {
assert flushedSegment != null;

1
lucene/core/src/java/org/apache/lucene/search/BoostAttribute.java
View File

@ -20,6 +20,7 @@ package org.apache.lucene.search;
import org.apache.lucene.util.Attribute;
import org.apache.lucene.util.AttributeSource; // javadocs only
import org.apache.lucene.index.TermsEnum; // javadocs only
import org.apache.lucene.index.Terms; // javadocs only
/** Add this {@link Attribute} to a {@link TermsEnum} returned by {@link MultiTermQuery#getTermsEnum(Terms,AttributeSource)}
* and update the boost on each returned term. This enables to control the boost factor

4
lucene/core/src/java/org/apache/lucene/search/ConstantScoreAutoRewrite.java
View File

@ -47,7 +47,7 @@ class ConstantScoreAutoRewrite extends TermCollectingRewrite<BooleanQuery> {
/** If the number of terms in this query is equal to or
* larger than this setting then {@link
* #CONSTANT_SCORE_FILTER_REWRITE} is used. */
* MultiTermQuery#CONSTANT_SCORE_FILTER_REWRITE} is used. */
public void setTermCountCutoff(int count) {
termCountCutoff = count;
}
@ -60,7 +60,7 @@ class ConstantScoreAutoRewrite extends TermCollectingRewrite<BooleanQuery> {
/** If the number of documents to be visited in the
* postings exceeds this specified percentage of the
* maxDoc() for the index, then {@link
* #CONSTANT_SCORE_FILTER_REWRITE} is used.
* MultiTermQuery#CONSTANT_SCORE_FILTER_REWRITE} is used.
* @param percent 0.0 to 100.0 */
public void setDocCountPercent(double percent) {
docCountPercent = percent;

10
lucene/core/src/java/org/apache/lucene/search/FieldValueHitQueue.java
View File

@ -66,10 +66,10 @@ public abstract class FieldValueHitQueue<T extends FieldValueHitQueue.Entry> ext
}
/**
* Returns whether <code>a</code> is less relevant than <code>b</code>.
* @param a ScoreDoc
* @param b ScoreDoc
* @return <code>true</code> if document <code>a</code> should be sorted after document <code>b</code>.
* Returns whether <code>hitA</code> is less relevant than <code>hitB</code>.
* @param hitA Entry
* @param hitB Entry
* @return <code>true</code> if document <code>hitA</code> should be sorted after document <code>hitB</code>.
*/
@Override
protected boolean lessThan(final Entry hitA, final Entry hitB) {
@ -201,7 +201,7 @@ public abstract class FieldValueHitQueue<T extends FieldValueHitQueue.Entry> ext
*
* @param entry The Entry used to create a FieldDoc
* @return The newly created FieldDoc
* @see Searchable#search(Weight,Filter,int,Sort)
* @see IndexSearcher#search(Query,Filter,int,Sort)
*/
FieldDoc fillFields(final Entry entry) {
final int n = comparators.length;

4
lucene/core/src/java/org/apache/lucene/search/FuzzyTermsEnum.java
View File

@ -407,10 +407,6 @@ public final class FuzzyTermsEnum extends TermsEnum {
* After calling the constructor the enumeration is already pointing to the first
* valid term if such a term exists.
*
* @param reader Delivers terms.
* @param term Pattern term.
* @param minSimilarity Minimum required similarity for terms from the reader. Default value is 0.5f.
* @param prefixLength Length of required common prefix. Default value is 0.
* @throws IOException
*/
public LinearFuzzyTermsEnum() throws IOException {

1
lucene/core/src/java/org/apache/lucene/search/IndexSearcher.java
View File

@ -46,6 +46,7 @@ import org.apache.lucene.store.NIOFSDirectory; // javadoc
import org.apache.lucene.util.ReaderUtil;
import org.apache.lucene.util.TermContext;
import org.apache.lucene.util.ThreadInterruptedException;
import org.apache.lucene.index.IndexWriter; // javadocs
/** Implements search over a single IndexReader.
*

1
lucene/core/src/java/org/apache/lucene/search/MaxNonCompetitiveBoostAttribute.java
View File

@ -20,6 +20,7 @@ package org.apache.lucene.search;
import org.apache.lucene.util.Attribute;
import org.apache.lucene.util.AttributeSource; // javadocs only
import org.apache.lucene.util.BytesRef;
import org.apache.lucene.index.Terms; // javadocs only
/** Add this {@link Attribute} to a fresh {@link AttributeSource} before calling
* {@link MultiTermQuery#getTermsEnum(Terms,AttributeSource)}.

1
lucene/core/src/java/org/apache/lucene/search/NumericRangeQuery.java
View File

@ -34,6 +34,7 @@ import org.apache.lucene.util.AttributeSource;
import org.apache.lucene.util.BytesRef;
import org.apache.lucene.util.NumericUtils;
import org.apache.lucene.util.ToStringUtils;
import org.apache.lucene.index.Term; // for javadocs
/**
* <p>A {@link Query} that matches numeric values within a

4
lucene/core/src/java/org/apache/lucene/search/ScoringRewrite.java
View File

@ -47,7 +47,7 @@ public abstract class ScoringRewrite<Q extends Query> extends TermCollectingRewr
* BooleanQuery.TooManyClauses} if the number of terms
* exceeds {@link BooleanQuery#getMaxClauseCount}.
*
* @see #setRewriteMethod */
* @see MultiTermQuery#setRewriteMethod */
public final static ScoringRewrite<BooleanQuery> SCORING_BOOLEAN_QUERY_REWRITE = new ScoringRewrite<BooleanQuery>() {
@Override
protected BooleanQuery getTopLevelQuery() {
@ -83,7 +83,7 @@ public abstract class ScoringRewrite<Q extends Query> extends TermCollectingRewr
* BooleanQuery.TooManyClauses} if the number of terms
* exceeds {@link BooleanQuery#getMaxClauseCount}.
*
* @see #setRewriteMethod */
* @see MultiTermQuery#setRewriteMethod */
public final static RewriteMethod CONSTANT_SCORE_BOOLEAN_QUERY_REWRITE = new RewriteMethod() {
@Override
public Query rewrite(IndexReader reader, MultiTermQuery query) throws IOException {

10
lucene/core/src/java/org/apache/lucene/search/similarities/SimilarityBase.java
View File

@ -268,8 +268,8 @@ public abstract class SimilarityBase extends Similarity {
/** Delegates the {@link #score(int, int)} and
* {@link #explain(int, Explanation)} methods to
* {@link SimilarityBase#score(BasicStats, float, int)} and
* {@link SimilarityBase#explain(BasicStats, int, Explanation, int)},
* {@link SimilarityBase#score(BasicStats, float, float)} and
* {@link SimilarityBase#explain(BasicStats, int, Explanation, float)},
* respectively.
*/
private class BasicExactDocScorer extends ExactSimScorer {
@ -295,10 +295,10 @@ public abstract class SimilarityBase extends Similarity {
}
}
/** Delegates the {@link #score(int, int)} and
/** Delegates the {@link #score(int, float)} and
* {@link #explain(int, Explanation)} methods to
* {@link SimilarityBase#score(BasicStats, float, int)} and
* {@link SimilarityBase#explain(BasicStats, int, Explanation, int)},
* {@link SimilarityBase#score(BasicStats, float, float)} and
* {@link SimilarityBase#explain(BasicStats, int, Explanation, float)},
* respectively.
*/
private class BasicSloppyDocScorer extends SloppySimScorer {