svn commit: r808054 - in /lucene/java/trunk/src/java/org/apache/lucene/search: Hit.java HitCollectorWrapper.java HitIterator.java Hits.java

[ma...@apache.org]

Author: markrmiller
Date: Wed Aug 26 15:29:15 2009
New Revision: 808054

URL: http://svn.apache.org/viewvc?rev=808054&view=rev
Log:
put useful javadoc deprecation comments first - so they show up in summary

Modified:
    lucene/java/trunk/src/java/org/apache/lucene/search/Hit.java
    lucene/java/trunk/src/java/org/apache/lucene/search/HitCollectorWrapper.java
    lucene/java/trunk/src/java/org/apache/lucene/search/HitIterator.java
    lucene/java/trunk/src/java/org/apache/lucene/search/Hits.java

Modified: lucene/java/trunk/src/java/org/apache/lucene/search/Hit.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/Hit.java?rev=808054&r1=808053&r2=808054&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/Hit.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/Hit.java Wed Aug 26 15:29:15 2009
@@ -26,7 +26,7 @@
  * 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 {
 

Modified: lucene/java/trunk/src/java/org/apache/lucene/search/HitCollectorWrapper.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/HitCollectorWrapper.java?rev=808054&r1=808053&r2=808054&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/HitCollectorWrapper.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/HitCollectorWrapper.java Wed Aug 26 15:29:15 2009
@@ -22,12 +22,12 @@
 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;

Modified: lucene/java/trunk/src/java/org/apache/lucene/search/HitIterator.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/HitIterator.java?rev=808054&r1=808053&r2=808054&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/HitIterator.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/HitIterator.java Wed Aug 26 15:29:15 2009
@@ -25,7 +25,7 @@
  * {@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;

Modified: lucene/java/trunk/src/java/org/apache/lucene/search/Hits.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/Hits.java?rev=808054&r1=808053&r2=808054&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/Hits.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/Hits.java Wed Aug 26 15:29:15 2009
@@ -39,8 +39,8 @@
  * 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);