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

javadocs fixes 

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@825602 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael McCandless 2009-10-15 18:22:19 +00:00
parent da48773756
commit b714198d17
2 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -161,12 +161,13 @@ public class IndexSearcher extends Searcher {
/**
* Just like {@link #search(Weight, Filter, int, Sort)}, but you choose
* whether or not the fields in the returned {@link FieldDoc} instances should
* be set by specifying fillFields.<br>
* <b>NOTE:</b> currently, this method tracks document scores and sets them in
* the returned {@link FieldDoc}, however in 3.0 it will move to not track
* document scores. If document scores tracking is still needed, you can use
* {@link #search(Weight, Filter, Collector)} and pass in a
* {@link TopFieldCollector} instance.
* be set by specifying fillFields.
*
* <p>NOTE: this does not compute scores by default. If you
* need scores, create a {@link TopFieldCollector}
* instance by calling {@link TopFieldCollector#create} and
* then pass that to {@link #search(Weight, Filter,
* Collector)}.</p>
*/
public TopFieldDocs search(Weight weight, Filter filter, final int nDocs,
Sort sort, boolean fillFields)

10
src/java/org/apache/lucene/search/Searcher.java
View File

@ -37,11 +37,11 @@ public abstract class Searcher implements Searchable {
* <code>filter</code> if non-null, and sorting the hits by the criteria in
* <code>sort</code>.
*
* <b>NOTE:</b> currently, this method tracks document scores and sets them in
* the returned {@link FieldDoc}, however in 3.0 it will move to not track
* document scores. If document scores tracking is still needed, you can use
* {@link #search(Weight, Filter, Collector)} and pass in a
* {@link TopFieldCollector} instance.
* <p>NOTE: this does not compute scores by default. If
* you need scores, create a {@link TopFieldCollector}
* instance by calling {@link TopFieldCollector#create}
* and then pass that to {@link #search(Query, Filter,
* Collector)}.</p>
*
* @throws BooleanQuery.TooManyClauses
*/