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

put useful javadoc deprecation comments first - so they show up in summary 

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@808054 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Mark Robert Miller 2009-08-26 15:29:15 +00:00
parent bd14e0c056
commit e639f45cff
4 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -26,7 +26,7 @@ import org.apache.lucene.index.CorruptIndexException;
* Wrapper used by {@link HitIterator} to provide a lazily loaded hit
* from {@link Hits}.
*
* @deprecated Hits will be removed in Lucene 3.0. Use {@link TopScoreDocCollector} and {@link TopDocs} instead.
* @deprecated Use {@link TopScoreDocCollector} and {@link TopDocs} instead. Hits will be removed in Lucene 3.0.
*/
public class Hit implements java.io.Serializable {

12
src/java/org/apache/lucene/search/HitCollectorWrapper.java
View File

@ -22,12 +22,12 @@ import java.io.IOException;
import org.apache.lucene.index.IndexReader;
/**
* Wrapper for ({@link HitCollector}) implementations, which
* simply re-bases the incoming docID before calling {@link
* HitCollector#collect}.
* @deprecated this class will be removed when {@link
* HitCollector} is removed. Please migrate custom
* HitCollectors to the new {@link Collector} class.
* Wrapper for ({@link HitCollector}) implementations, which simply re-bases the
* incoming docID before calling {@link HitCollector#collect}.
*
* @deprecated Please migrate custom HitCollectors to the new {@link Collector}
* class. This class will be removed when {@link HitCollector} is
* removed.
*/
public class HitCollectorWrapper extends Collector {
private HitCollector collector;

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

@ -25,7 +25,7 @@ import java.util.NoSuchElementException;
* {@link Hits#iterator()} returns an instance of this class. Calls to {@link #next()}
* return a {@link Hit} instance.
*
* @deprecated Hits will be removed in Lucene 3.0. Use {@link TopScoreDocCollector} and {@link TopDocs} instead.
* @deprecated Use {@link TopScoreDocCollector} and {@link TopDocs} instead. Hits will be removed in Lucene 3.0.
*/
public class HitIterator implements Iterator {
private Hits hits;

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

@ -39,8 +39,8 @@ import org.apache.lucene.index.CorruptIndexException;
* is thrown when accessing hit <code>n</code> &ge; current_{@link #length()}
* (but <code>n</code> &lt; {@link #length()}_at_start).
*
* @deprecated Hits will be removed in Lucene 3.0. <p>
* Instead e. g. {@link TopScoreDocCollector} and {@link TopDocs} can be used:<br>
* @deprecated
* see {@link TopScoreDocCollector} and {@link TopDocs} :<br>
* <pre>
* TopScoreDocCollector collector = new TopScoreDocCollector(hitsPerPage);
* searcher.search(query, collector);