svn commit: r697115 - in /lucene/java/trunk/src/java/org/apache/lucene: analysis/package.html document/Document.java search/ConstantScoreQuery.java search/TopDocCollector.java search/payloads/PayloadSpanUtil.java util/OpenBitSet.java

[mi...@apache.org]

Author: mikemccand
Date: Fri Sep 19 07:51:04 2008
New Revision: 697115

URL: http://svn.apache.org/viewvc?rev=697115&view=rev
Log:
LUCENE-1392: small javadocs/extra imports fixes

Modified:
    lucene/java/trunk/src/java/org/apache/lucene/analysis/package.html
    lucene/java/trunk/src/java/org/apache/lucene/document/Document.java
    lucene/java/trunk/src/java/org/apache/lucene/search/ConstantScoreQuery.java
    lucene/java/trunk/src/java/org/apache/lucene/search/TopDocCollector.java
    lucene/java/trunk/src/java/org/apache/lucene/search/payloads/PayloadSpanUtil.java
    lucene/java/trunk/src/java/org/apache/lucene/util/OpenBitSet.java

Modified: lucene/java/trunk/src/java/org/apache/lucene/analysis/package.html
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/analysis/package.html?rev=697115&r1=697114&r2=697115&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/analysis/package.html (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/analysis/package.html Fri Sep 19 07:51:04 2008
@@ -93,7 +93,7 @@
       {@link org.apache.lucene.document.Field}s.</li>
     <li>The contrib/analyzers library located at the root of the Lucene distribution has a number of different Analyzer implementations to solve a variety
     of different problems related to searching.  Many of the Analyzers are designed to analyze non-English languages.</li>
-    <li>The {@link org.apache.lucene.analysis.snowball contrib/snowball library} 
+    <li>The contrib/snowball library 
         located at the root of the Lucene distribution has Analyzer and TokenFilter 
         implementations for a variety of Snowball stemmers.  
         See <a href="http://snowball.tartarus.org">http://snowball.tartarus.org</a> 

Modified: lucene/java/trunk/src/java/org/apache/lucene/document/Document.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/document/Document.java?rev=697115&r1=697114&r2=697115&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/document/Document.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/document/Document.java Fri Sep 19 07:51:04 2008
@@ -188,8 +188,9 @@
 
   /** Returns a List of all the fields in a document.
    * <p>Note that fields which are <i>not</i> {@link Fieldable#isStored() stored} are
-   * <i>not</i> available in documents retrieved from the index, e.g. with {@link
-   * Hits#doc(int)}, {@link Searcher#doc(int)} or {@link IndexReader#document(int)}.
+   * <i>not</i> available in documents retrieved from the
+   * index, e.g. {@link Searcher#doc(int)} or {@link
+   * IndexReader#document(int)}.
    */
   public final List getFields() {
     return fields;

Modified: lucene/java/trunk/src/java/org/apache/lucene/search/ConstantScoreQuery.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/ConstantScoreQuery.java?rev=697115&r1=697114&r2=697115&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/ConstantScoreQuery.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/ConstantScoreQuery.java Fri Sep 19 07:51:04 2008
@@ -20,7 +20,6 @@
 import org.apache.lucene.index.IndexReader;
 
 import java.io.IOException;
-import java.util.BitSet;
 import java.util.Set;
 
 /**

Modified: lucene/java/trunk/src/java/org/apache/lucene/search/TopDocCollector.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/TopDocCollector.java?rev=697115&r1=697114&r2=697115&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/TopDocCollector.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/TopDocCollector.java Fri Sep 19 07:51:04 2008
@@ -52,7 +52,7 @@
   }
 
   /** Constructor to collect the top-scoring documents by using the given PQ.
-   * @hq the PQ to use by this instance.
+   * @param hq the PQ to use by this instance.
    */
   protected TopDocCollector(PriorityQueue hq) {
     this.hq = hq;

Modified: lucene/java/trunk/src/java/org/apache/lucene/search/payloads/PayloadSpanUtil.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/payloads/PayloadSpanUtil.java?rev=697115&r1=697114&r2=697115&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/payloads/PayloadSpanUtil.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/payloads/PayloadSpanUtil.java Fri Sep 19 07:51:04 2008
@@ -66,7 +66,7 @@
    * Query should be rewritten for wild/fuzzy support.
    * 
    * @param query
-   * @return
+   * @return payloads Collection
    * @throws IOException
    */
   public Collection getPayloadsForQuery(Query query) throws IOException {

Modified: lucene/java/trunk/src/java/org/apache/lucene/util/OpenBitSet.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/util/OpenBitSet.java?rev=697115&r1=697114&r2=697115&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/util/OpenBitSet.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/util/OpenBitSet.java Fri Sep 19 07:51:04 2008
@@ -26,7 +26,7 @@
 /** An "open" BitSet implementation that allows direct access to the array of words
  * storing the bits.
  * <p/>
- * Unlike java.util.bitet, the fact that bits are packed into an array of longs
+ * Unlike java.util.bitset, the fact that bits are packed into an array of longs
  * is part of the interface.  This allows efficient implementation of other algorithms
  * by someone other than the author.  It also allows one to efficiently implement
  * alternate serialization or interchange formats.