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

LUCENE-2837: fixup jdocs 

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1055575 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael McCandless 2011-01-05 18:45:25 +00:00
parent 24e41ab20a
commit c29b449d42
19 changed files with 46 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lucene/src/java/org/apache/lucene/document/AbstractField.java
View File

@ -99,7 +99,7 @@ public abstract class AbstractField implements Fieldable {
*
* <p>Note: this value is not stored directly with the document in the index.
* Documents returned from {@link org.apache.lucene.index.IndexReader#document(int)} and
* {@link org.apache.lucene.search.Searcher#doc(int)} may thus not have the same value present as when
* {@link org.apache.lucene.search.IndexSearcher#doc(int)} may thus not have the same value present as when
* this field was indexed.
*
* @see #setBoost(float)

3
lucene/src/java/org/apache/lucene/document/Document.java
View File

@ -18,6 +18,7 @@ package org.apache.lucene.document;
*/
import java.util.*; // for javadoc
import org.apache.lucene.search.IndexSearcher; // for javadoc
import org.apache.lucene.search.ScoreDoc; // for javadoc
import org.apache.lucene.index.IndexReader; // for javadoc
@ -165,7 +166,7 @@ public final class Document implements java.io.Serializable {
/** Returns a List of all the fields in a document.
* <p>Note that fields which are <i>not</i> {@link Fieldable#isStored() stored} are
* <i>not</i> available in documents retrieved from the
* index, e.g. {@link Searcher#doc(int)} or {@link
* index, e.g. {@link IndexSearcher#doc(int)} or {@link
* IndexReader#document(int)}.
*/
public final List<Fieldable> getFields() {

2
lucene/src/java/org/apache/lucene/document/Fieldable.java
View File

@ -64,7 +64,7 @@ public interface Fieldable extends Serializable {
*
* <p>Note: this value is not stored directly with the document in the index.
* Documents returned from {@link org.apache.lucene.index.IndexReader#document(int)} and
* {@link org.apache.lucene.search.Searcher#doc(int)} may thus not have the same value present as when
* {@link org.apache.lucene.search.IndexSearcher#doc(int)} may thus not have the same value present as when
* this field was indexed.
*
* @see #setBoost(float)

10
lucene/src/java/org/apache/lucene/index/IndexReader.java
View File

@ -301,7 +301,7 @@ public abstract class IndexReader implements Cloneable,Closeable {
* @param readOnly true if no changes (deletions, norms) will be made with this IndexReader
* @param termInfosIndexDivisor Subsamples which indexed
* terms are loaded into RAM. This has the same effect as {@link
* IndexWriter#setTermIndexInterval} except that setting
* IndexWriterConfig#setTermIndexInterval} except that setting
* must be done at indexing time while this setting can be
* set per reader. When set to N, then one in every
* N*termIndexInterval terms in the index is loaded into
@ -351,7 +351,7 @@ public abstract class IndexReader implements Cloneable,Closeable {
* @param readOnly true if no changes (deletions, norms) will be made with this IndexReader
* @param termInfosIndexDivisor Subsamples which indexed
* terms are loaded into RAM. This has the same effect as {@link
* IndexWriter#setTermIndexInterval} except that setting
* IndexWriterConfig#setTermIndexInterval} except that setting
* must be done at indexing time while this setting can be
* set per reader. When set to N, then one in every
* N*termIndexInterval terms in the index is loaded into
@ -380,7 +380,7 @@ public abstract class IndexReader implements Cloneable,Closeable {
* @param readOnly true if no changes (deletions, norms) will be made with this IndexReader
* @param termInfosIndexDivisor Subsamples which indexed
* terms are loaded into RAM. This has the same effect as {@link
* IndexWriter#setTermIndexInterval} except that setting
* IndexWriterConfig#setTermIndexInterval} except that setting
* must be done at indexing time while this setting can be
* set per reader. When set to N, then one in every
* N*termIndexInterval terms in the index is loaded into
@ -413,7 +413,7 @@ public abstract class IndexReader implements Cloneable,Closeable {
* @param readOnly true if no changes (deletions, norms) will be made with this IndexReader
* @param termInfosIndexDivisor Subsamples which indexed
* terms are loaded into RAM. This has the same effect as {@link
* IndexWriter#setTermIndexInterval} except that setting
* IndexWriterConfig#setTermIndexInterval} except that setting
* must be done at indexing time while this setting can be
* set per reader. When set to N, then one in every
* N*termIndexInterval terms in the index is loaded into
@ -542,7 +542,7 @@ public abstract class IndexReader implements Cloneable,Closeable {
* 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>

2
lucene/src/java/org/apache/lucene/search/BoostAttribute.java
View File

@ -21,7 +21,7 @@ import org.apache.lucene.util.Attribute;
import org.apache.lucene.util.AttributeSource; // javadocs only
import org.apache.lucene.index.TermsEnum; // javadocs only
/** Add this {@link Attribute} to a {@link TermsEnum} returned by {@link MultiTermQuery#getTermsEnum(IndexReader,AttributeSource)}
/** 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
* for each matching term in {@link MultiTermQuery#SCORING_BOOLEAN_QUERY_REWRITE} or
* {@link TopTermsRewrite} mode.

2
lucene/src/java/org/apache/lucene/search/Collector.java
View File

@ -136,7 +136,7 @@ public abstract class Collector {
*
* <p>
* Note: This is called in an inner search loop. For good search performance,
* implementations of this method should not call {@link Searcher#doc(int)} or
* implementations of this method should not call {@link IndexSearcher#doc(int)} or
* {@link org.apache.lucene.index.IndexReader#document(int)} on every hit.
* Doing so can slow searches by an order of magnitude or more.
*/

2
lucene/src/java/org/apache/lucene/search/FieldDoc.java
View File

@ -43,7 +43,7 @@ public class FieldDoc extends ScoreDoc {
* Sort object. Each Object will be either an Integer, Float or String,
* depending on the type of values in the terms of the original field.
* @see Sort
* @see Searcher#search(Query,Filter,int,Sort)
* @see IndexSearcher#search(Query,Filter,int,Sort)
*/
public Comparable[] fields;

2
lucene/src/java/org/apache/lucene/search/FieldValueHitQueue.java
View File

@ -28,7 +28,7 @@ import org.apache.lucene.util.PriorityQueue;
*
* @lucene.experimental
* @since 2.9
* @see Searcher#search(Query,Filter,int,Sort)
* @see IndexSearcher#search(Query,Filter,int,Sort)
* @see FieldCache
*/
public abstract class FieldValueHitQueue extends PriorityQueue<FieldValueHitQueue.Entry> {

15
lucene/src/java/org/apache/lucene/search/IndexSearcher.java
View File

@ -37,6 +37,7 @@ import org.apache.lucene.index.CorruptIndexException;
import org.apache.lucene.index.IndexReader;
import org.apache.lucene.index.Term;
import org.apache.lucene.store.Directory;
import org.apache.lucene.store.NIOFSDirectory; // javadoc
import org.apache.lucene.util.ReaderUtil;
import org.apache.lucene.util.ThreadInterruptedException;
@ -284,7 +285,7 @@ public class IndexSearcher {
*
* <p>Applications should only use this if they need <i>all</i> of the
* matching documents. The high-level search API ({@link
* Searcher#search(Query, Filter, int)}) is usually more efficient, as it skips
* IndexSearcher#search(Query, Filter, int)}) is usually more efficient, as it skips
* non-high-scoring hits.
*
* @param query to match documents
@ -303,7 +304,7 @@ public class IndexSearcher {
*
* <p>Applications should only use this if they need <i>all</i> of the
* matching documents. The high-level search API ({@link
* Searcher#search(Query, int)}) is usually more efficient, as it skips
* IndexSearcher#search(Query, int)}) is usually more efficient, as it skips
* non-high-scoring hits.
* <p>Note: The <code>score</code> passed to this method is a raw score.
* In other words, the score will not necessarily be a float whose value is
@ -347,8 +348,8 @@ public class IndexSearcher {
/** Expert: Low-level search implementation. Finds the top <code>n</code>
* hits for <code>query</code>, applying <code>filter</code> if non-null.
*
* <p>Applications should usually call {@link Searcher#search(Query,int)} or
* {@link Searcher#search(Query,Filter,int)} instead.
* <p>Applications should usually call {@link IndexSearcher#search(Query,int)} or
* {@link IndexSearcher#search(Query,Filter,int)} instead.
* @throws BooleanQuery.TooManyClauses
*/
protected TopDocs search(Weight weight, Filter filter, int nDocs) throws IOException {
@ -394,7 +395,7 @@ public class IndexSearcher {
* <code>sort</code>.
*
* <p>Applications should usually call {@link
* Searcher#search(Query,Filter,int,Sort)} instead.
* IndexSearcher#search(Query,Filter,int,Sort)} instead.
*
* @throws BooleanQuery.TooManyClauses
*/
@ -464,7 +465,7 @@ public class IndexSearcher {
*
* <p>
* Applications should only use this if they need <i>all</i> of the matching
* documents. The high-level search API ({@link Searcher#search(Query,int)}) is
* documents. The high-level search API ({@link IndexSearcher#search(Query,int)}) is
* usually more efficient, as it skips non-high-scoring hits.
*
* @param weight
@ -576,7 +577,7 @@ public class IndexSearcher {
* and, for good performance, should not be displayed with every hit.
* Computing an explanation is as expensive as executing the query over the
* entire index.
* <p>Applications should call {@link Searcher#explain(Query, int)}.
* <p>Applications should call {@link IndexSearcher#explain(Query, int)}.
* @throws BooleanQuery.TooManyClauses
*/
protected Explanation explain(Weight weight, int doc) throws IOException {

4
lucene/src/java/org/apache/lucene/search/MaxNonCompetitiveBoostAttribute.java
View File

@ -22,13 +22,13 @@ import org.apache.lucene.util.AttributeSource; // javadocs only
import org.apache.lucene.util.BytesRef;
/** Add this {@link Attribute} to a fresh {@link AttributeSource} before calling
* {@link MultiTermQuery#getTermsEnum(IndexReader,AttributeSource)}.
* {@link MultiTermQuery#getTermsEnum(Terms,AttributeSource)}.
* {@link FuzzyQuery} is using this to control its internal behaviour
* to only return competitive terms.
* <p><b>Please note:</b> This attribute is intended to be added by the {@link MultiTermQuery.RewriteMethod}
* to an empty {@link AttributeSource} that is shared for all segments
* during query rewrite. This attribute source is passed to all segment enums
* on {@link MultiTermQuery#getTermsEnum(IndexReader,AttributeSource)}.
* on {@link MultiTermQuery#getTermsEnum(Terms,AttributeSource)}.
* {@link TopTermsRewrite} uses this attribute to
* inform all enums about the current boost, that is not competitive.
* @lucene.internal

2
lucene/src/java/org/apache/lucene/search/MultiTermQuery.java
View File

@ -33,7 +33,7 @@ import org.apache.lucene.util.AttributeSource;
* FilteredTermsEnum} enumeration.
*
* <p>This query cannot be used directly; you must subclass
* it and define {@link #getTermsEnum(IndexReader,AttributeSource)} to provide a {@link
* it and define {@link #getTermsEnum(Terms,AttributeSource)} to provide a {@link
* FilteredTermsEnum} that iterates through the terms to be
* matched.
*

2
lucene/src/java/org/apache/lucene/search/ScoreDoc.java
View File

@ -24,7 +24,7 @@ public class ScoreDoc implements java.io.Serializable {
public float score;
/** Expert: A hit document's number.
* @see Searcher#doc(int)
* @see IndexSearcher#doc(int)
*/
public int doc;

22
lucene/src/java/org/apache/lucene/search/Similarity.java
View File

@ -521,8 +521,8 @@ import org.apache.lucene.util.SmallFloat;
* </ol>
*
* @see #setDefault(Similarity)
* @see org.apache.lucene.index.IndexWriter#setSimilarity(Similarity)
* @see Searcher#setSimilarity(Similarity)
* @see org.apache.lucene.index.IndexWriterConfig#setSimilarity(Similarity)
* @see IndexSearcher#setSimilarity(Similarity)
*/
public abstract class Similarity implements Serializable {
@ -535,8 +535,8 @@ public abstract class Similarity implements Serializable {
/** Set the default Similarity implementation used by indexing and search
* code.
*
* @see Searcher#setSimilarity(Similarity)
* @see org.apache.lucene.index.IndexWriter#setSimilarity(Similarity)
* @see IndexSearcher#setSimilarity(Similarity)
* @see org.apache.lucene.index.IndexWriterConfig#setSimilarity(Similarity)
*/
public static void setDefault(Similarity similarity) {
Similarity.defaultImpl = similarity;
@ -547,8 +547,8 @@ public abstract class Similarity implements Serializable {
*
* <p>This is initially an instance of {@link DefaultSimilarity}.
*
* @see Searcher#setSimilarity(Similarity)
* @see org.apache.lucene.index.IndexWriter#setSimilarity(Similarity)
* @see IndexSearcher#setSimilarity(Similarity)
* @see org.apache.lucene.index.IndexWriterConfig#setSimilarity(Similarity)
*/
public static Similarity getDefault() {
return Similarity.defaultImpl;
@ -709,11 +709,11 @@ public abstract class Similarity implements Serializable {
* idf(docFreq, searcher.maxDoc());
* </pre>
*
* Note that {@link Searcher#maxDoc()} is used instead of
* Note that {@link IndexSearcher#maxDoc()} is used instead of
* {@link org.apache.lucene.index.IndexReader#numDocs() IndexReader#numDocs()} because also
* {@link Searcher#docFreq(Term)} is used, and when the latter
* is inaccurate, so is {@link Searcher#maxDoc()}, and in the same direction.
* In addition, {@link Searcher#maxDoc()} is more efficient to compute
* {@link IndexSearcher#docFreq(Term)} is used, and when the latter
* is inaccurate, so is {@link IndexSearcher#maxDoc()}, and in the same direction.
* In addition, {@link IndexSearcher#maxDoc()} is more efficient to compute
*
* @param term the term in question
* @param searcher the document collection being searched
@ -740,7 +740,7 @@ public abstract class Similarity implements Serializable {
/**
* This method forwards to {@link
* #idfExplain(Term,Searcher,int)} by passing
* #idfExplain(Term,IndexSearcher,int)} by passing
* <code>searcher.docFreq(term)</code> as the docFreq.
*/
public IDFExplanation idfExplain(final Term term, final IndexSearcher searcher) throws IOException {

2
lucene/src/java/org/apache/lucene/search/SimilarityDelegator.java
View File

@ -20,7 +20,7 @@ import org.apache.lucene.index.FieldInvertState;
*/
/** Expert: Delegating scoring implementation. Useful in {@link
* Query#getSimilarity(Searcher)} implementations, to override only certain
* Query#getSimilarity(IndexSearcher)} implementations, to override only certain
* methods of a Searcher's Similarity implementation.. */
public class SimilarityDelegator extends Similarity {

4
lucene/src/java/org/apache/lucene/search/Sort.java
View File

@ -103,7 +103,7 @@ implements Serializable {
/**
* Represents sorting by computed relevance. Using this sort criteria returns
* the same results as calling
* {@link Searcher#search(Query,int) Searcher#search()}without a sort criteria,
* {@link IndexSearcher#search(Query,int) IndexSearcher#search()}without a sort criteria,
* only with slightly more overhead.
*/
public static final Sort RELEVANCE = new Sort();
@ -116,7 +116,7 @@ implements Serializable {
/**
* Sorts by computed relevance. This is the same sort criteria as calling
* {@link Searcher#search(Query,int) Searcher#search()}without a sort criteria,
* {@link IndexSearcher#search(Query,int) IndexSearcher#search()}without a sort criteria,
* only with slightly more overhead.
*/
public Sort() {

4
lucene/src/java/org/apache/lucene/search/TopDocs.java
View File

@ -18,8 +18,8 @@ package org.apache.lucene.search;
*/
/** Represents hits returned by {@link
* Searcher#search(Query,Filter,int)} and {@link
* Searcher#search(Query,int)}. */
* IndexSearcher#search(Query,Filter,int)} and {@link
* IndexSearcher#search(Query,int)}. */
public class TopDocs implements java.io.Serializable {
/** The total number of hits for the query.
*/

2
lucene/src/java/org/apache/lucene/search/TopFieldDocs.java
View File

@ -19,7 +19,7 @@ package org.apache.lucene.search;
/** Represents hits returned by {@link
* Searcher#search(Query,Filter,int,Sort)}.
* IndexSearcher#search(Query,Filter,int,Sort)}.
*/
public class TopFieldDocs
extends TopDocs {

4
lucene/src/java/org/apache/lucene/search/Weight.java
View File

@ -27,14 +27,14 @@ import org.apache.lucene.index.IndexReader;
* <p>
* The purpose of {@link Weight} is to ensure searching does not
* modify a {@link Query}, so that a {@link Query} instance can be reused. <br>
* {@link Searcher} dependent state of the query should reside in the
* {@link IndexSearcher} dependent state of the query should reside in the
* {@link Weight}. <br>
* {@link IndexReader} dependent state should reside in the {@link Scorer}.
* <p>
* A <code>Weight</code> is used in the following way:
* <ol>
* <li>A <code>Weight</code> is constructed by a top-level query, given a
* <code>Searcher</code> ({@link Query#createWeight(Searcher)}).
* <code>IndexSearcher</code> ({@link Query#createWeight(IndexSearcher)}).
* <li>The {@link #sumOfSquaredWeights()} method is called on the
* <code>Weight</code> to compute the query normalization factor
* {@link Similarity#queryNorm(float)} of the query clauses contained in the

4
lucene/src/java/org/apache/lucene/search/package.html
View File

@ -36,8 +36,8 @@ Code to search indices.
Search over indices.
Applications usually call {@link
org.apache.lucene.search.Searcher#search(Query,int)} or {@link
org.apache.lucene.search.Searcher#search(Query,Filter,int)}.
org.apache.lucene.search.IndexSearcher#search(Query,int)} or {@link
org.apache.lucene.search.IndexSearcher#search(Query,Filter,int)}.
<!-- FILL IN MORE HERE -->
</p>