svn commit: r1171582 - in /lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell: DirectSpellChecker.java SpellChecker.java SuggestMode.java

[rm...@apache.org]

Author: rmuir
Date: Fri Sep 16 14:16:33 2011
New Revision: 1171582

URL: http://svn.apache.org/viewvc?rev=1171582&view=rev
Log:
LUCENE-3436: fix javadocs warnings

Modified:
    lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/DirectSpellChecker.java
    lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/SpellChecker.java
    lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/SuggestMode.java

Modified: lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/DirectSpellChecker.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/DirectSpellChecker.java?rev=1171582&r1=1171581&r2=1171582&view=diff
==============================================================================
--- lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/DirectSpellChecker.java (original)
+++ lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/DirectSpellChecker.java Fri Sep 16 14:16:33 2011
@@ -318,7 +318,7 @@ public class DirectSpellChecker {
    * @param term Term you want to spell check on
    * @param numSug the maximum number of suggested words
    * @param ir IndexReader to find terms from
-   * @param morePopular return only suggested words that are as frequent or more frequent than the searched word
+   * @param suggestMode specifies when to return suggested words
    * @param accuracy return only suggested words that match with this similarity
    * @return sorted list of the suggested words according to the comparator
    * @throws IOException

Modified: lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/SpellChecker.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/SpellChecker.java?rev=1171582&r1=1171581&r2=1171582&view=diff
==============================================================================
--- lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/SpellChecker.java (original)
+++ lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/SpellChecker.java Fri Sep 16 14:16:33 2011
@@ -219,7 +219,7 @@ public class SpellChecker implements jav
   }
 
   /**
-   * The accuracy (minimum score) to be used, unless overridden in {@link #suggestSimilar(String, int, org.apache.lucene.index.IndexReader, String, boolean, float)}, to
+   * The accuracy (minimum score) to be used, unless overridden in {@link #suggestSimilar(String, int, IndexReader, String, SuggestMode, float)}, to
    * decide whether a suggestion is included or not.
    * @return The current accuracy setting
    */
@@ -244,7 +244,7 @@ public class SpellChecker implements jav
    * @throws AlreadyClosedException if the Spellchecker is already closed
    * @return String[]
    *
-   * @see #suggestSimilar(String, int, org.apache.lucene.index.IndexReader, String, boolean, float) 
+   * @see #suggestSimilar(String, int, IndexReader, String, SuggestMode, float) 
    */
   public String[] suggestSimilar(String word, int numSug) throws IOException {
     return this.suggestSimilar(word, numSug, null, null, SuggestMode.SUGGEST_WHEN_NOT_IN_INDEX);
@@ -268,7 +268,7 @@ public class SpellChecker implements jav
    * @throws AlreadyClosedException if the Spellchecker is already closed
    * @return String[]
    *
-   * @see #suggestSimilar(String, int, org.apache.lucene.index.IndexReader, String, boolean, float)
+   * @see #suggestSimilar(String, int, IndexReader, String, SuggestMode, float)
    */
   public String[] suggestSimilar(String word, int numSug, float accuracy) throws IOException {
     return this.suggestSimilar(word, numSug, null, null, SuggestMode.SUGGEST_WHEN_NOT_IN_INDEX, accuracy);

Modified: lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/SuggestMode.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/SuggestMode.java?rev=1171582&r1=1171581&r2=1171582&view=diff
==============================================================================
--- lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/SuggestMode.java (original)
+++ lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/SuggestMode.java Fri Sep 16 14:16:33 2011
@@ -36,7 +36,7 @@ public enum SuggestMode {
   /**
    * Always attempt to offer suggestions (however, other parameters may limit
    * suggestions. For example, see
-   * {@link DirectSpellChecker.setMaxQueryFrequency} ).
+   * {@link DirectSpellChecker#setMaxQueryFrequency(float)} ).
    */
   SUGGEST_ALWAYS
 }