svn commit: r804617 - in /lucene/java/trunk/src/java/org/apache/lucene: search/Weight.java search/payloads/BoostingNearQuery.java search/spans/NearSpansUnordered.java util/ReaderUtil.java

[ho...@apache.org]

Author: hossman
Date: Sun Aug 16 05:14:38 2009
New Revision: 804617

URL: http://svn.apache.org/viewvc?rev=804617&view=rev
Log:
fixing obvious javadoc mistakes in core (the kind that cause the javadoc command to generate warning messages)

Modified:
    lucene/java/trunk/src/java/org/apache/lucene/search/Weight.java
    lucene/java/trunk/src/java/org/apache/lucene/search/payloads/BoostingNearQuery.java
    lucene/java/trunk/src/java/org/apache/lucene/search/spans/NearSpansUnordered.java
    lucene/java/trunk/src/java/org/apache/lucene/util/ReaderUtil.java

Modified: lucene/java/trunk/src/java/org/apache/lucene/search/Weight.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/Weight.java?rev=804617&r1=804616&r2=804617&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/Weight.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/Weight.java Sun Aug 16 05:14:38 2009
@@ -41,7 +41,7 @@
  * query.
  * <li>The query normalization factor is passed to {@link #normalize(float)}. At
  * this point the weighting is complete.
- * <li>A <code>Scorer</code> is constructed by {@link #scorer(IndexReader)}.
+ * <li>A <code>Scorer</code> is constructed by {@link #scorer(IndexReader,boolean,boolean)}.
  * </ol>
  * 
  * @since 2.9
@@ -51,8 +51,8 @@
   /**
    * An explanation of the score computation for the named document.
    * 
-   * Until 3.0, null may be passed in situations where the {@Searcher} is not
-   * available, so impls must only use {@Searcher} to generate optional 
+   * Until 3.0, null may be passed in situations where the Searcher is not
+   * available, so impls must only use Searcher to generate optional 
    * explain info.
    * 
    * @param searcher over the index or null

Modified: lucene/java/trunk/src/java/org/apache/lucene/search/payloads/BoostingNearQuery.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/payloads/BoostingNearQuery.java?rev=804617&r1=804616&r2=804617&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/payloads/BoostingNearQuery.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/payloads/BoostingNearQuery.java Sun Aug 16 05:14:38 2009
@@ -121,7 +121,7 @@
      * @param start The start position of the span being scored
      * @param end The end position of the span being scored
      *
-     * @see {@link org.apache.lucene.search.spans.Spans}
+     * @see Spans
      */
     protected void processPayloads(Collection payLoads, int start, int end) {
       for (Iterator iterator = payLoads.iterator(); iterator.hasNext();) {

Modified: lucene/java/trunk/src/java/org/apache/lucene/search/spans/NearSpansUnordered.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/spans/NearSpansUnordered.java?rev=804617&r1=804616&r2=804617&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/spans/NearSpansUnordered.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/spans/NearSpansUnordered.java Sun Aug 16 05:14:38 2009
@@ -220,7 +220,7 @@
   // TODO: Remove warning after API has been finalized
   /**
    * WARNING: The List is not necessarily in order of the the positions
-   * @return
+   * @return Collection of <code>byte[]</code> payloads
    * @throws IOException
    */
   public Collection/*<byte[]>*/ getPayload() throws IOException {

Modified: lucene/java/trunk/src/java/org/apache/lucene/util/ReaderUtil.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/util/ReaderUtil.java?rev=804617&r1=804616&r2=804617&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/util/ReaderUtil.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/util/ReaderUtil.java Sun Aug 16 05:14:38 2009
@@ -45,9 +45,9 @@
   /**
    * Returns sub IndexReader that contains the given document id.
    *    
-   * @param doc
-   * @param reader
-   * @return
+   * @param doc id of document
+   * @param reader parent reader
+   * @return sub reader of parent which contains the specified doc id
    */
   public static IndexReader subReader(int doc, IndexReader reader) {
     List subReadersList = new ArrayList();
@@ -66,9 +66,9 @@
   /**
    * Returns sub-reader subIndex from reader.
    * 
-   * @param reader
-   * @param subIndex
-   * @return
+   * @param reader parent reader
+   * @param subIndex index of desired sub reader
+   * @return the subreader at subINdex
    */
   public static IndexReader subReader(IndexReader reader, int subIndex) {
     List subReadersList = new ArrayList();