svn commit: r1304220 - in /lucene/dev/branches/branch_3x: ./ lucene/ lucene/contrib/facet/ lucene/contrib/spellchecker/ lucene/contrib/spellchecker/src/java/org/apache/lucene/search/suggest/ lucene/contrib/spellchecker/src/java/org/apache/lucene/search...

[si...@apache.org]

Author: simonw
Date: Fri Mar 23 08:11:56 2012
New Revision: 1304220

URL: http://svn.apache.org/viewvc?rev=1304220&view=rev
Log:
LUCENE-3902: fix javadocs

Modified:
    lucene/dev/branches/branch_3x/   (props changed)
    lucene/dev/branches/branch_3x/lucene/   (props changed)
    lucene/dev/branches/branch_3x/lucene/contrib/facet/   (props changed)
    lucene/dev/branches/branch_3x/lucene/contrib/spellchecker/   (props changed)
    lucene/dev/branches/branch_3x/lucene/contrib/spellchecker/src/java/org/apache/lucene/search/suggest/Lookup.java
    lucene/dev/branches/branch_3x/lucene/contrib/spellchecker/src/java/org/apache/lucene/search/suggest/tst/TSTLookup.java
    lucene/dev/branches/branch_3x/solr/   (props changed)
    lucene/dev/branches/branch_3x/solr/core/   (props changed)

Modified: lucene/dev/branches/branch_3x/lucene/contrib/spellchecker/src/java/org/apache/lucene/search/suggest/Lookup.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/lucene/contrib/spellchecker/src/java/org/apache/lucene/search/suggest/Lookup.java?rev=1304220&r1=1304219&r2=1304220&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/lucene/contrib/spellchecker/src/java/org/apache/lucene/search/suggest/Lookup.java (original)
+++ lucene/dev/branches/branch_3x/lucene/contrib/spellchecker/src/java/org/apache/lucene/search/suggest/Lookup.java Fri Mar 23 08:11:56 2012
@@ -17,7 +17,6 @@ package org.apache.lucene.search.suggest
  * limitations under the License.
  */
 
-import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
@@ -57,6 +56,9 @@ public abstract class Lookup {
     }
   }
   
+  /**
+   * A simple char-by-char comparator for {@link CharSequence}
+   */
   public static final Comparator<CharSequence> CHARSEQUENCE_COMPARATOR = new CharSequenceComparator();
   
   private static class CharSequenceComparator implements Comparator<CharSequence> {
@@ -79,8 +81,11 @@ public abstract class Lookup {
     
   }
   
+  /**
+   * A {@link PriorityQueue} collecting a fixed size of high priority {@link LookupResult}
+   */
   public static final class LookupPriorityQueue extends PriorityQueue<LookupResult> {
-    
+  // TODO: should we move this out of the interface into a utility class?
     public LookupPriorityQueue(int size) {
       initialize(size);
     }
@@ -90,6 +95,10 @@ public abstract class Lookup {
       return a.value < b.value;
     }
     
+    /**
+     * Returns the top N results in descending order.
+     * @return the top N results in descending order.
+     */
     public LookupResult[] getResults() {
       int size = size();
       LookupResult[] res = new LookupResult[size];

Modified: lucene/dev/branches/branch_3x/lucene/contrib/spellchecker/src/java/org/apache/lucene/search/suggest/tst/TSTLookup.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/lucene/contrib/spellchecker/src/java/org/apache/lucene/search/suggest/tst/TSTLookup.java?rev=1304220&r1=1304219&r2=1304220&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/lucene/contrib/spellchecker/src/java/org/apache/lucene/search/suggest/tst/TSTLookup.java (original)
+++ lucene/dev/branches/branch_3x/lucene/contrib/spellchecker/src/java/org/apache/lucene/search/suggest/tst/TSTLookup.java Fri Mar 23 08:11:56 2012
@@ -19,9 +19,6 @@ package org.apache.lucene.search.suggest
 
 import java.io.DataInputStream;
 import java.io.DataOutputStream;
-import java.io.File;
-import java.io.FileInputStream;
-import java.io.FileOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
@@ -104,6 +101,7 @@ public class TSTLookup extends Lookup {
     int maxCnt = Math.min(num, list.size());
     if (onlyMorePopular) {
       LookupPriorityQueue queue = new LookupPriorityQueue(num);
+      
       for (TernaryTreeNode ttn : list) {
         queue.insertWithOverflow(new LookupResult(ttn.token, ((Number)ttn.val).longValue()));
       }
@@ -198,4 +196,5 @@ public class TSTLookup extends Lookup {
     }
     return true;
   }
+  
 }