Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

LUCENE-3436: fix javadocs warnings 

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1171582 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Robert Muir 2011-09-16 14:16:33 +00:00
parent 28ae5a5763
commit edd8822929
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
modules/suggest/src/java/org/apache/lucene/search/spell/DirectSpellChecker.java
View File

@ -318,7 +318,7 @@ public class DirectSpellChecker {
* @param term Term you want to spell check on * @param term Term you want to spell check on
* @param numSug the maximum number of suggested words * @param numSug the maximum number of suggested words
* @param ir IndexReader to find terms from * @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 * @param accuracy return only suggested words that match with this similarity
* @return sorted list of the suggested words according to the comparator * @return sorted list of the suggested words according to the comparator
* @throws IOException * @throws IOException

6
modules/suggest/src/java/org/apache/lucene/search/spell/SpellChecker.java
View File

@ -219,7 +219,7 @@ public class SpellChecker implements java.io.Closeable {
} }
/** /**
* 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. * decide whether a suggestion is included or not.
* @return The current accuracy setting * @return The current accuracy setting
*/ */
@ -244,7 +244,7 @@ public class SpellChecker implements java.io.Closeable {
* @throws AlreadyClosedException if the Spellchecker is already closed * @throws AlreadyClosedException if the Spellchecker is already closed
* @return String[] * @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 { public String[] suggestSimilar(String word, int numSug) throws IOException {
return this.suggestSimilar(word, numSug, null, null, SuggestMode.SUGGEST_WHEN_NOT_IN_INDEX); return this.suggestSimilar(word, numSug, null, null, SuggestMode.SUGGEST_WHEN_NOT_IN_INDEX);
@ -268,7 +268,7 @@ public class SpellChecker implements java.io.Closeable {
* @throws AlreadyClosedException if the Spellchecker is already closed * @throws AlreadyClosedException if the Spellchecker is already closed
* @return String[] * @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 { 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); return this.suggestSimilar(word, numSug, null, null, SuggestMode.SUGGEST_WHEN_NOT_IN_INDEX, accuracy);

2
modules/suggest/src/java/org/apache/lucene/search/spell/SuggestMode.java
View File

@ -36,7 +36,7 @@ public enum SuggestMode {
/** /**
* Always attempt to offer suggestions (however, other parameters may limit * Always attempt to offer suggestions (however, other parameters may limit
* suggestions. For example, see * suggestions. For example, see
* {@link DirectSpellChecker.setMaxQueryFrequency} ). * {@link DirectSpellChecker#setMaxQueryFrequency(float)} ).
*/ */
SUGGEST_ALWAYS SUGGEST_ALWAYS
} }