lucene-java-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mikemcc...@apache.org
Subject svn commit: r885740 - in /lucene/java/trunk/src/java/org/apache/lucene/search: TopDocs.java TopFieldDocs.java
Date Tue, 01 Dec 2009 11:38:32 GMT
Author: mikemccand
Date: Tue Dec  1 11:38:31 2009
New Revision: 885740

URL: http://svn.apache.org/viewvc?rev=885740&view=rev
Log:
remove expert & low-level characterization for TopDocs/TopFieldDocs

Modified:
    lucene/java/trunk/src/java/org/apache/lucene/search/TopDocs.java
    lucene/java/trunk/src/java/org/apache/lucene/search/TopFieldDocs.java

Modified: lucene/java/trunk/src/java/org/apache/lucene/search/TopDocs.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/TopDocs.java?rev=885740&r1=885739&r2=885740&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/TopDocs.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/TopDocs.java Tue Dec  1 11:38:31 2009
@@ -17,36 +17,36 @@
  * limitations under the License.
  */
 
-/** Expert: Returned by low-level search implementations.
- * @see Searcher#search(Query,Filter,int) */
+/** Represents hits returned by {@link
+ * Searcher#search(Query,Filter,int)} and {@link
+ * Searcher#search(Query,int)}. */
 public class TopDocs implements java.io.Serializable {
-  /** Expert: The total number of hits for the query.
+  /** The total number of hits for the query.
   */
   public int totalHits;
-  /** Expert: The top hits for the query. */
+  /** The top hits for the query. */
   public ScoreDoc[] scoreDocs;
-  /** Expert: Stores the maximum score value encountered, needed for normalizing. */
+  /** Stores the maximum score value encountered, needed for normalizing. */
   private float maxScore;
   
   /**
-   * Expert: Returns the maximum score value encountered. Note that in case
+   * Returns the maximum score value encountered. Note that in case
    * scores are not tracked, this returns {@link Float#NaN}.
    */
   public float getMaxScore() {
       return maxScore;
   }
   
-  /** Expert: Sets the maximum score value encountered. */
+  /** Sets the maximum score value encountered. */
   public void setMaxScore(float maxScore) {
       this.maxScore=maxScore;
   }
 
-  /** Expert: Constructs a TopDocs with a default maxScore=Float.NaN. */
+  /** Constructs a TopDocs with a default maxScore=Float.NaN. */
   TopDocs(int totalHits, ScoreDoc[] scoreDocs) {
     this(totalHits, scoreDocs, Float.NaN);
   }
 
-  /** Expert: Constructs a TopDocs.*/
   public TopDocs(int totalHits, ScoreDoc[] scoreDocs, float maxScore) {
     this.totalHits = totalHits;
     this.scoreDocs = scoreDocs;

Modified: lucene/java/trunk/src/java/org/apache/lucene/search/TopFieldDocs.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/TopFieldDocs.java?rev=885740&r1=885739&r2=885740&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/TopFieldDocs.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/TopFieldDocs.java Tue Dec  1 11:38:31
2009
@@ -18,13 +18,8 @@
  */
 
 
-/**
- * Expert: Returned by low-level sorted search implementations.
- *
- * <p>Created: Feb 12, 2004 8:58:46 AM 
- *
- * @since   lucene 1.4
- * @see Searcher#search(Query,Filter,int,Sort)
+/** Represents hits returned by {@link
+ * Searcher#search(Query,Filter,int,Sort)}.
  */
 public class TopFieldDocs
 extends TopDocs {



Mime
View raw message