From f025322f8112d3197c9182cb56fc21c69168a9c3 Mon Sep 17 00:00:00 2001
From: Robert Muir
Date: Sun, 23 Sep 2012 19:54:23 +0000
Subject: [PATCH] fix all malformed javadocs
(@code/deprecated/param/returns/throws with no args)
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1389133 13f79535-47bb-0310-9956-ffa450edef68
---
.../dot.settings/org.eclipse.jdt.core.prefs | 4 +-
.../charfilter/HTMLStripCharFilter.java | 7 +-
.../charfilter/HTMLStripCharFilter.jflex | 7 +-
.../HyphenationCompoundWordTokenFilter.java | 6 +-
.../lucene/analysis/en/KStemFilter.java | 4 +-
.../miscellaneous/WordDelimiterFilter.java | 4 +-
.../analysis/payloads/PayloadEncoder.java | 3 -
.../analysis/payloads/PayloadHelper.java | 1 -
.../lucene/analysis/util/WordlistLoader.java | 4 +-
.../wikipedia/WikipediaTokenizer.java | 3 -
.../sinks/TestTeeSinkTokenFilter.java | 2 -
.../icu/segmentation/ICUTokenizer.java | 2 +-
.../ja/JapaneseIterationMarkCharFilter.java | 6 +-
.../lucene/analysis/ja/dict/Dictionary.java | 7 +-
.../analysis/ja/dict/UserDictionary.java | 1 -
.../lucene/analysis/ja/util/CSVUtil.java | 3 +-
.../analysis/phonetic/BeiderMorseFilter.java | 4 +-
.../cn/smart/hhmm/BigramDictionary.java | 4 +-
.../cn/smart/hhmm/WordDictionary.java | 7 +-
.../analysis/uima/BaseUIMATokenizer.java | 5 +-
.../lucene/analysis/uima/ae/AEProvider.java | 4 +-
.../benchmark/byTask/feeds/HTMLParser.java | 2 +-
.../benchmark/byTask/feeds/QueryMaker.java | 3 +-
.../byTask/feeds/TrecContentSource.java | 4 +-
.../benchmark/byTask/programmatic/Sample.java | 5 -
.../benchmark/byTask/tasks/TaskSequence.java | 1 -
.../benchmark/byTask/utils/Algorithm.java | 1 -
.../lucene/benchmark/byTask/utils/Config.java | 3 +-
.../benchmark/byTask/utils/FileUtils.java | 2 +-
.../benchmark/quality/trec/TrecJudge.java | 2 +-
.../benchmark/utils/ExtractReuters.java | 2 -
.../lucene/classification/Classifier.java | 4 +-
.../apache/lucene/codecs/block/ForUtil.java | 6 +-
.../apache/lucene/codecs/bloom/FuzzySet.java | 6 +-
.../org/apache/lucene/analysis/Token.java | 2 +-
.../apache/lucene/analysis/TokenStream.java | 2 +-
.../lucene/codecs/DocValuesConsumer.java | 2 +-
.../codecs/MultiLevelSkipListWriter.java | 2 +-
.../apache/lucene/codecs/PerDocProducer.java | 2 +-
.../lucene/codecs/SegmentInfoReader.java | 2 +-
.../lucene/codecs/SegmentInfoWriter.java | 2 +-
.../lucene40/Lucene40StoredFieldsReader.java | 2 +-
.../apache/lucene/index/DirectoryReader.java | 4 +-
.../org/apache/lucene/index/FieldInfos.java | 5 +-
.../lucene/index/FilteredTermsEnum.java | 12 +-
.../org/apache/lucene/index/IndexWriter.java | 4 +-
.../apache/lucene/index/ReaderManager.java | 4 +-
.../apache/lucene/index/SegmentMerger.java | 3 +-
.../apache/lucene/index/SegmentReader.java | 6 -
.../java/org/apache/lucene/index/Term.java | 2 +-
.../apache/lucene/search/FieldComparator.java | 2 +-
.../lucene/search/FieldValueHitQueue.java | 2 +-
.../apache/lucene/search/FuzzyTermsEnum.java | 2 +-
.../apache/lucene/search/IndexSearcher.java | 61 +++++---
.../lucene/search/MultiPhraseQuery.java | 2 -
.../lucene/search/NGramPhraseQuery.java | 2 +-
.../org/apache/lucene/search/PhraseQuery.java | 2 -
.../apache/lucene/search/SearcherManager.java | 4 +-
.../lucene/search/TimeLimitingCollector.java | 1 -
.../lucene/search/TopFieldCollector.java | 4 +-
.../java/org/apache/lucene/search/Weight.java | 2 +-
.../search/payloads/PayloadSpanUtil.java | 4 +-
.../search/payloads/PayloadTermQuery.java | 4 +-
.../search/similarities/Similarity.java | 4 +-
.../lucene/search/spans/NearSpansOrdered.java | 2 -
.../search/spans/NearSpansUnordered.java | 2 +-
.../org/apache/lucene/search/spans/Spans.java | 2 +-
.../lucene/store/CompoundFileDirectory.java | 6 +-
.../org/apache/lucene/store/FSDirectory.java | 2 +-
.../apache/lucene/store/MMapDirectory.java | 6 +-
.../apache/lucene/store/NIOFSDirectory.java | 4 +-
.../lucene/store/SimpleFSDirectory.java | 4 +-
.../java/org/apache/lucene/util/BytesRef.java | 4 +-
.../apache/lucene/util/BytesRefIterator.java | 2 +-
.../java/org/apache/lucene/util/CharsRef.java | 4 +-
.../apache/lucene/util/CommandLineUtil.java | 12 +-
.../org/apache/lucene/util/OpenBitSet.java | 4 +-
.../apache/lucene/util/packed/PackedInts.java | 8 +-
.../lucene/codecs/lucene40/TestBitVector.java | 5 -
.../index/TestCrashCausesCorruptIndex.java | 8 --
.../apache/lucene/index/TestIndexWriter.java | 2 -
.../lucene/index/TestIndexWriterReader.java | 4 -
.../apache/lucene/index/TestIsCurrent.java | 4 -
.../index/TestParallelReaderEmptyIndex.java | 2 -
.../apache/lucene/search/TestBooleanOr.java | 8 --
.../lucene/search/TestCustomSearcherSort.java | 5 -
.../apache/lucene/search/TestWildcard.java | 1 -
.../lucene/search/payloads/PayloadHelper.java | 1 -
.../search/spans/TestSpansAdvanced.java | 7 -
.../search/spans/TestSpansAdvanced2.java | 8 --
.../lucene/store/TestFileSwitchDirectory.java | 1 -
.../org/apache/lucene/demo/IndexFiles.java | 2 +-
.../EnhancementsDocumentBuilder.java | 1 -
.../EnhancementsPayloadIterator.java | 2 +-
.../lucene/facet/index/CategoryContainer.java | 2 +-
.../facet/index/CategoryDocumentBuilder.java | 6 +-
.../params/PerDimensionIndexingParams.java | 3 -
.../facet/search/FacetsAccumulator.java | 3 +-
.../lucene/facet/search/SamplingWrapper.java | 7 -
.../search/StandardFacetsAccumulator.java | 5 +-
.../facet/search/params/FacetRequest.java | 2 +-
.../facet/search/sampling/SampleFixer.java | 2 +-
.../search/sampling/TakmiSampleFixer.java | 4 +-
.../lucene/facet/taxonomy/TaxonomyReader.java | 2 +-
.../util/collections/FloatToObjectMap.java | 4 -
.../lucene/util/collections/IntHashSet.java | 5 -
.../util/collections/IntToDoubleMap.java | 5 -
.../lucene/util/collections/IntToIntMap.java | 5 -
.../util/collections/IntToObjectMap.java | 4 -
.../util/collections/ObjectToFloatMap.java | 5 -
.../util/collections/ObjectToIntMap.java | 5 -
.../facet/index/CategoryContainerTest.java | 8 --
.../CategoryAttributesStreamTest.java | 2 -
.../streaming/CategoryParentsStreamTest.java | 10 --
.../streaming/CategoryTokenizerTest.java | 4 -
.../facet/taxonomy/TestTaxonomyCombined.java | 2 -
.../TestDirectoryTaxonomyReader.java | 1 -
.../lucene/util/encoding/EncodingSpeed.java | 4 -
.../lucene/search/highlight/Highlighter.java | 12 +-
.../lucene/search/highlight/QueryScorer.java | 3 -
.../lucene/search/highlight/Scorer.java | 2 +-
.../lucene/search/highlight/TextFragment.java | 1 -
.../lucene/search/highlight/TokenSources.java | 7 +-
.../search/highlight/WeightedSpanTerm.java | 9 --
.../highlight/WeightedSpanTermExtractor.java | 14 +-
.../FastVectorHighlighter.java | 8 +-
.../search/vectorhighlight/FieldQuery.java | 4 -
.../vectorhighlight/FieldTermStack.java | 2 +-
.../vectorhighlight/FragmentsBuilder.java | 8 +-
.../search/highlight/HighlighterTest.java | 3 -
.../custom/HighlightCustomQueryTest.java | 2 -
.../apache/lucene/index/IndexSplitter.java | 3 -
.../lucene/index/MultiPassIndexSplitter.java | 2 +-
.../org/apache/lucene/misc/HighFreqTerms.java | 9 +-
.../lucene/store/NativeUnixDirectory.java | 4 +-
.../apache/lucene/store/WindowsDirectory.java | 4 +-
.../apache/lucene/queries/TermsFilter.java | 2 -
.../lucene/queries/mlt/MoreLikeThis.java | 3 +-
.../analyzing/AnalyzingQueryParser.java | 3 -
.../queryparser/classic/QueryParserBase.java | 4 -
.../flexible/core/builders/QueryBuilder.java | 2 -
.../core/config/AbstractQueryConfig.java | 2 +-
.../flexible/core/nodes/GroupQueryNode.java | 3 -
.../core/nodes/ModifierQueryNode.java | 3 -
.../flexible/core/nodes/QueryNode.java | 9 +-
.../core/processors/QueryNodeProcessor.java | 4 -
.../core/util/UnescapedCharSequence.java | 9 --
.../queryparser/flexible/messages/NLS.java | 7 -
.../nodes/StandardBooleanQueryNode.java | 3 -
.../surround/query/RewriteQuery.java | 4 +-
.../lucene/queryparser/xml/CoreParser.java | 2 -
.../xml/CorePlusExtensionsParser.java | 2 -
.../lucene/queryparser/xml/DOMUtils.java | 2 -
.../queryparser/xml/ParserException.java | 13 --
.../builders/NumericRangeFilterBuilder.java | 2 -
.../xml/builders/SpanNotBuilder.java | 3 -
.../xml/builders/SpanOrTermsBuilder.java | 3 -
.../xml/builders/TermsFilterBuilder.java | 3 -
.../xml/builders/UserInputQueryBuilder.java | 2 -
.../sandbox/queries/FuzzyLikeThisQuery.java | 2 -
.../queries/SlowCollatedTermRangeQuery.java | 2 +-
.../SlowCollatedTermRangeTermsEnum.java | 2 +-
.../sandbox/queries/SlowFuzzyTermsEnum.java | 2 +-
.../sandbox/queries/regex/RegexQuery.java | 8 --
.../queries/regex/RegexQueryCapable.java | 8 ++
.../lucene/spatial/query/SpatialArgs.java | 1 -
.../search/spell/DirectSpellChecker.java | 2 +-
.../lucene/search/spell/SpellChecker.java | 8 +-
.../search/spell/WordBreakSpellChecker.java | 11 +-
.../org/apache/lucene/index/DocHelper.java | 8 --
.../clustering/SearchClusteringEngine.java | 1 -
.../solr/handler/dataimport/Context.java | 3 -
.../solr/handler/dataimport/DIHCache.java | 4 -
.../solr/handler/dataimport/DIHWriter.java | 6 -
.../solr/handler/dataimport/DataSource.java | 3 -
.../handler/dataimport/VariableResolver.java | 1 -
.../extraction/ExtractingDocumentLoader.java | 5 -
.../solr/uima/processor/UIMAToSolrMapper.java | 1 -
.../solrj/embedded/EmbeddedSolrServer.java | 7 +-
.../org/apache/solr/cloud/AssignShard.java | 2 -
.../apache/solr/cloud/DistributedQueue.java | 16 ---
.../org/apache/solr/cloud/LeaderElector.java | 18 ---
.../org/apache/solr/cloud/SolrZkServer.java | 2 -
.../src/java/org/apache/solr/cloud/ZkCLI.java | 8 --
.../org/apache/solr/cloud/ZkController.java | 101 +-------------
.../java/org/apache/solr/core/CloseHook.java | 2 -
.../src/java/org/apache/solr/core/Config.java | 8 --
.../org/apache/solr/core/CoreContainer.java | 21 ---
.../org/apache/solr/core/CoreDescriptor.java | 2 -
.../apache/solr/core/DirectoryFactory.java | 16 +--
.../apache/solr/core/IndexReaderFactory.java | 2 +-
.../java/org/apache/solr/core/SolrConfig.java | 1 -
.../java/org/apache/solr/core/SolrCore.java | 2 -
.../apache/solr/core/SolrResourceLoader.java | 6 +-
.../apache/solr/core/SolrXMLSerializer.java | 2 +-
.../solr/handler/ReplicationHandler.java | 2 -
.../org/apache/solr/handler/SnapPuller.java | 2 -
.../solr/handler/admin/CoreAdminHandler.java | 36 +----
.../handler/component/FacetComponent.java | 1 -
.../component/QueryElevationComponent.java | 2 +-
.../handler/component/SearchComponent.java | 4 +-
.../highlight/DefaultSolrHighlighter.java | 2 +-
.../apache/solr/internal/csv/CSVStrategy.java | 2 +-
.../apache/solr/internal/csv/CharBuffer.java | 1 -
.../internal/csv/ExtendedBufferedReader.java | 6 +-
.../solr/internal/csv/writer/CSVConfig.java | 1 -
.../internal/csv/writer/CSVConfigGuesser.java | 1 -
.../apache/solr/request/UnInvertedField.java | 2 +-
.../solr/response/BinaryResponseWriter.java | 3 -
.../response/transform/DocTransformer.java | 2 +-
.../solr/schema/ExchangeRateProvider.java | 4 +-
.../org/apache/solr/schema/FieldType.java | 1 -
.../org/apache/solr/schema/IndexSchema.java | 5 -
.../apache/solr/schema/PreAnalyzedField.java | 4 +-
.../search/ExtendedDismaxQParserPlugin.java | 5 +-
.../apache/solr/search/FunctionQParser.java | 17 +--
.../java/org/apache/solr/search/Grouping.java | 3 -
.../java/org/apache/solr/search/QParser.java | 2 -
.../apache/solr/search/SolrIndexSearcher.java | 41 ++----
.../apache/solr/search/ValueSourceParser.java | 3 -
.../function/distance/HaversineFunction.java | 2 -
.../distance/StringDistanceFunction.java | 5 -
.../servlet/cache/HttpCacheHeaderUtil.java | 2 -
.../spelling/AbstractLuceneSpellChecker.java | 2 +-
.../solr/spelling/PossibilityIterator.java | 2 -
.../apache/solr/spelling/QueryConverter.java | 5 +-
.../solr/spelling/SolrSpellChecker.java | 7 +-
.../java/org/apache/solr/update/PeerSync.java | 6 -
.../org/apache/solr/update/SolrCoreState.java | 10 +-
.../apache/solr/update/TransactionLog.java | 4 +-
.../org/apache/solr/update/UpdateHandler.java | 2 +-
.../processor/DistributedUpdateProcessor.java | 3 +-
.../org/apache/solr/util/SimplePostTool.java | 3 +-
.../solr/util/xslt/TransformerProvider.java | 2 +-
.../solr/core/AlternateDirectoryTest.java | 2 -
.../solr/core/IndexReaderFactoryTest.java | 2 -
.../spelling/FileBasedSpellCheckerTest.java | 1 -
.../apache/solr/client/solrj/SolrQuery.java | 9 +-
.../apache/solr/client/solrj/SolrServer.java | 68 +++------
.../client/solrj/impl/HttpSolrServer.java | 3 +-
.../client/solrj/impl/LBHttpSolrServer.java | 6 +-
.../solr/client/solrj/util/ClientUtils.java | 1 -
.../solr/common/cloud/ClusterState.java | 7 -
.../solr/common/cloud/HashPartitioner.java | 4 +-
.../solr/common/cloud/SolrZkClient.java | 132 +-----------------
.../solr/common/cloud/ZkCmdExecutor.java | 5 -
.../apache/solr/common/cloud/ZkOperation.java | 2 -
.../solr/common/util/FastOutputStream.java | 1 -
.../apache/solr/common/util/JavaBinCodec.java | 13 +-
.../apache/solr/common/util/NamedList.java | 3 -
.../org/apache/solr/common/util/StrUtils.java | 2 -
.../java/org/apache/solr/common/util/XML.java | 4 +-
.../solr/BaseDistributedSearchTestCase.java | 2 -
.../cloud/AbstractFullDistribZkTestBase.java | 2 -
.../org/apache/solr/cloud/ZkTestServer.java | 6 +-
255 files changed, 328 insertions(+), 1139 deletions(-)
diff --git a/dev-tools/eclipse/dot.settings/org.eclipse.jdt.core.prefs b/dev-tools/eclipse/dot.settings/org.eclipse.jdt.core.prefs
index d5002bdbd81..4334d56c90c 100644
--- a/dev-tools/eclipse/dot.settings/org.eclipse.jdt.core.prefs
+++ b/dev-tools/eclipse/dot.settings/org.eclipse.jdt.core.prefs
@@ -1,4 +1,4 @@
-#Wed Sep 19 20:37:34 EDT 2012
+#Sun Sep 23 13:02:27 EDT 2012
eclipse.preferences.version=1
org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6
org.eclipse.jdt.core.compiler.compliance=1.6
@@ -13,7 +13,7 @@ org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsVisibility=private
org.eclipse.jdt.core.compiler.problem.missingJavadocComments=ignore
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public
-org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
org.eclipse.jdt.core.compiler.problem.missingJavadocTags=ignore
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.java
index 48ba0eb076d..6f054180529 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.java
@@ -30792,7 +30792,8 @@ public final class HTMLStripCharFilter extends BaseCharFilter {
private TextSegment entitySegment = new TextSegment(2);
/**
- * @param source
+ * Creates a new HTMLStripCharFilter over the provided Reader.
+ * @param source Reader to strip html tags from.
*/
public HTMLStripCharFilter(Reader source) {
super(source);
@@ -30800,7 +30801,9 @@ public final class HTMLStripCharFilter extends BaseCharFilter {
}
/**
- * @param source
+ * Creates a new HTMLStripCharFilter over the provided Reader
+ * with the specified start and end tags.
+ * @param source Reader to strip html tags from.
* @param escapedTags Tags in this set (both start and end tags)
* will not be filtered out.
*/
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.jflex b/lucene/analysis/common/src/java/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.jflex
index d3f0c6b6981..f6f6fcd2143 100755
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.jflex
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.jflex
@@ -171,7 +171,8 @@ InlineElment = ( [aAbBiIqQsSuU] |
private TextSegment entitySegment = new TextSegment(2);
/**
- * @param source
+ * Creates a new HTMLStripCharFilter over the provided Reader.
+ * @param source Reader to strip html tags from.
*/
public HTMLStripCharFilter(Reader source) {
super(source);
@@ -179,7 +180,9 @@ InlineElment = ( [aAbBiIqQsSuU] |
}
/**
- * @param source
+ * Creates a new HTMLStripCharFilter over the provided Reader
+ * with the specified start and end tags.
+ * @param source Reader to strip html tags from.
* @param escapedTags Tags in this set (both start and end tags)
* will not be filtered out.
*/
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/compound/HyphenationCompoundWordTokenFilter.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/compound/HyphenationCompoundWordTokenFilter.java
index 843da9218c6..bdb22a27f0f 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/compound/HyphenationCompoundWordTokenFilter.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/compound/HyphenationCompoundWordTokenFilter.java
@@ -132,7 +132,7 @@ public class HyphenationCompoundWordTokenFilter extends
*
* @param hyphenationFilename the filename of the XML grammar to load
* @return An object representing the hyphenation patterns
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
public static HyphenationTree getHyphenationTree(String hyphenationFilename)
throws IOException {
@@ -144,7 +144,7 @@ public class HyphenationCompoundWordTokenFilter extends
*
* @param hyphenationFile the file of the XML grammar to load
* @return An object representing the hyphenation patterns
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
public static HyphenationTree getHyphenationTree(File hyphenationFile)
throws IOException {
@@ -156,7 +156,7 @@ public class HyphenationCompoundWordTokenFilter extends
*
* @param hyphenationSource the InputSource pointing to the XML grammar
* @return An object representing the hyphenation patterns
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
public static HyphenationTree getHyphenationTree(InputSource hyphenationSource)
throws IOException {
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/en/KStemFilter.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/en/KStemFilter.java
index 1a0464135a7..257a562f3ce 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/en/KStemFilter.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/en/KStemFilter.java
@@ -44,8 +44,8 @@ public final class KStemFilter extends TokenFilter {
}
/** Returns the next, stemmed, input Token.
- * @return The stemed form of a token.
- * @throws IOException
+ * @return The stemmed form of a token.
+ * @throws IOException If there is a low-level I/O error.
*/
@Override
public boolean incrementToken() throws IOException {
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/miscellaneous/WordDelimiterFilter.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/miscellaneous/WordDelimiterFilter.java
index 41a3f803217..527eb53f4a7 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/miscellaneous/WordDelimiterFilter.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/miscellaneous/WordDelimiterFilter.java
@@ -351,7 +351,7 @@ public final class WordDelimiterFilter extends TokenFilter {
* Flushes the given WordDelimiterConcatenation by either writing its concat and then clearing, or just clearing.
*
* @param concatenation WordDelimiterConcatenation that will be flushed
- * @return {@code true} if the concatenation was written before it was cleared, {@code} false otherwise
+ * @return {@code true} if the concatenation was written before it was cleared, {@code false} otherwise
*/
private boolean flushConcatenation(WordDelimiterConcatenation concatenation) {
lastConcatCount = concatenation.subwordCount;
@@ -493,7 +493,7 @@ public final class WordDelimiterFilter extends TokenFilter {
* Determines whether the given flag is set
*
* @param flag Flag to see if set
- * @return {@code} true if flag is set
+ * @return {@code true} if flag is set
*/
private boolean has(int flag) {
return (flags & flag) != 0;
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/payloads/PayloadEncoder.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/payloads/PayloadEncoder.java
index ab9965da29a..cc30f47cecc 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/payloads/PayloadEncoder.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/payloads/PayloadEncoder.java
@@ -33,9 +33,6 @@ public interface PayloadEncoder {
/**
* Convert a char array to a {@link BytesRef}
- * @param buffer
- * @param offset
- * @param length
* @return encoded {@link BytesRef}
*/
BytesRef encode(char [] buffer, int offset, int length);
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/payloads/PayloadHelper.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/payloads/PayloadHelper.java
index f8ce632bba9..f7c57bf1a6d 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/payloads/PayloadHelper.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/payloads/PayloadHelper.java
@@ -44,7 +44,6 @@ public class PayloadHelper {
}
/**
- * @param bytes
* @see #decodeFloat(byte[], int)
* @see #encodeFloat(float)
* @return the decoded float
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/util/WordlistLoader.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/util/WordlistLoader.java
index 1f27d163831..5f97fc772cf 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/util/WordlistLoader.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/util/WordlistLoader.java
@@ -184,7 +184,7 @@ public class WordlistLoader {
* (i.e. two tab separated words)
*
* @return stem dictionary that overrules the stemming algorithm
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
public static CharArrayMap getStemDict(Reader reader, CharArrayMap result) throws IOException {
BufferedReader br = null;
@@ -210,7 +210,7 @@ public class WordlistLoader {
*
*
* @return a list of non-blank non-comment lines with whitespace trimmed
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
public static List getLines(InputStream stream, Charset charset) throws IOException{
BufferedReader input = null;
diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/wikipedia/WikipediaTokenizer.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/wikipedia/WikipediaTokenizer.java
index 474e62a0b21..644fe7fad39 100644
--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/wikipedia/WikipediaTokenizer.java
+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/wikipedia/WikipediaTokenizer.java
@@ -140,7 +140,6 @@ public final class WikipediaTokenizer extends Tokenizer {
*
* @param input The input
* @param tokenOutput One of {@link #TOKENS_ONLY}, {@link #UNTOKENIZED_ONLY}, {@link #BOTH}
- * @param untokenizedTypes
*/
public WikipediaTokenizer(Reader input, int tokenOutput, Set untokenizedTypes) {
super(input);
@@ -154,7 +153,6 @@ public final class WikipediaTokenizer extends Tokenizer {
*
* @param input The input
* @param tokenOutput One of {@link #TOKENS_ONLY}, {@link #UNTOKENIZED_ONLY}, {@link #BOTH}
- * @param untokenizedTypes
*/
public WikipediaTokenizer(AttributeFactory factory, Reader input, int tokenOutput, Set untokenizedTypes) {
super(factory, input);
@@ -168,7 +166,6 @@ public final class WikipediaTokenizer extends Tokenizer {
*
* @param input The input
* @param tokenOutput One of {@link #TOKENS_ONLY}, {@link #UNTOKENIZED_ONLY}, {@link #BOTH}
- * @param untokenizedTypes
*/
public WikipediaTokenizer(AttributeSource source, Reader input, int tokenOutput, Set untokenizedTypes) {
super(source, input);
diff --git a/lucene/analysis/common/src/test/org/apache/lucene/analysis/sinks/TestTeeSinkTokenFilter.java b/lucene/analysis/common/src/test/org/apache/lucene/analysis/sinks/TestTeeSinkTokenFilter.java
index dd0954e3d74..21ebf307488 100644
--- a/lucene/analysis/common/src/test/org/apache/lucene/analysis/sinks/TestTeeSinkTokenFilter.java
+++ b/lucene/analysis/common/src/test/org/apache/lucene/analysis/sinks/TestTeeSinkTokenFilter.java
@@ -171,8 +171,6 @@ public class TestTeeSinkTokenFilter extends BaseTokenStreamTestCase {
/**
* Not an explicit test, just useful to print out some info on performance
- *
- * @throws Exception
*/
public void performance() throws Exception {
int[] tokCount = {100, 500, 1000, 2000, 5000, 10000};
diff --git a/lucene/analysis/icu/src/java/org/apache/lucene/analysis/icu/segmentation/ICUTokenizer.java b/lucene/analysis/icu/src/java/org/apache/lucene/analysis/icu/segmentation/ICUTokenizer.java
index d1aad04e947..d92a90ae808 100644
--- a/lucene/analysis/icu/src/java/org/apache/lucene/analysis/icu/segmentation/ICUTokenizer.java
+++ b/lucene/analysis/icu/src/java/org/apache/lucene/analysis/icu/segmentation/ICUTokenizer.java
@@ -139,7 +139,7 @@ public final class ICUTokenizer extends Tokenizer {
* Refill the buffer, accumulating the offset and setting usableLength to the
* last unambiguous break position
*
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
private void refill() throws IOException {
offset += usableLength;
diff --git a/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/JapaneseIterationMarkCharFilter.java b/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/JapaneseIterationMarkCharFilter.java
index 374fe2ca3e6..7a14d520e04 100644
--- a/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/JapaneseIterationMarkCharFilter.java
+++ b/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/JapaneseIterationMarkCharFilter.java
@@ -225,7 +225,7 @@ public class JapaneseIterationMarkCharFilter extends CharFilter {
*
* @param c iteration mark character to normalize
* @return normalized iteration mark
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
private char normalizeIterationMark(char c) throws IOException {
@@ -252,7 +252,7 @@ public class JapaneseIterationMarkCharFilter extends CharFilter {
* Finds the number of subsequent next iteration marks
*
* @return number of iteration marks starting at the current buffer position
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
private int nextIterationMarkSpanSize() throws IOException {
int spanSize = 0;
@@ -272,7 +272,7 @@ public class JapaneseIterationMarkCharFilter extends CharFilter {
* @param position buffer position (should not exceed bufferPosition)
* @param spanSize iteration mark span size
* @return source character
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
private char sourceCharacter(int position, int spanSize) throws IOException {
return (char) buffer.get(position - spanSize);
diff --git a/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/dict/Dictionary.java b/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/dict/Dictionary.java
index 11277a720df..56ffec93280 100644
--- a/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/dict/Dictionary.java
+++ b/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/dict/Dictionary.java
@@ -27,22 +27,19 @@ public interface Dictionary {
/**
* Get left id of specified word
- * @param wordId
* @return left id
*/
public int getLeftId(int wordId);
/**
* Get right id of specified word
- * @param wordId
- * @return left id
+ * @return right id
*/
public int getRightId(int wordId);
/**
* Get word cost of specified word
- * @param wordId
- * @return left id
+ * @return word's cost
*/
public int getWordCost(int wordId);
diff --git a/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/dict/UserDictionary.java b/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/dict/UserDictionary.java
index a41555599b7..ba23f53c933 100644
--- a/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/dict/UserDictionary.java
+++ b/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/dict/UserDictionary.java
@@ -172,7 +172,6 @@ public final class UserDictionary implements Dictionary {
/**
* Convert Map of index and wordIdAndLength to array of {wordId, index, length}
- * @param input
* @return array of {wordId, index, length}
*/
private int[][] toIndexArray(Map input) {
diff --git a/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/util/CSVUtil.java b/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/util/CSVUtil.java
index 493cbf3160d..6e35b0259e1 100644
--- a/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/util/CSVUtil.java
+++ b/lucene/analysis/kuromoji/src/java/org/apache/lucene/analysis/ja/util/CSVUtil.java
@@ -37,7 +37,7 @@ public final class CSVUtil {
/**
* Parse CSV line
- * @param line
+ * @param line line containing csv-encoded data
* @return Array of values
*/
public static String[] parse(String line) {
@@ -96,7 +96,6 @@ public final class CSVUtil {
/**
* Quote and escape input value for CSV
- * @param original
*/
public static String quoteEscape(String original) {
String result = original;
diff --git a/lucene/analysis/phonetic/src/java/org/apache/lucene/analysis/phonetic/BeiderMorseFilter.java b/lucene/analysis/phonetic/src/java/org/apache/lucene/analysis/phonetic/BeiderMorseFilter.java
index ae2c44009dc..0461564f410 100644
--- a/lucene/analysis/phonetic/src/java/org/apache/lucene/analysis/phonetic/BeiderMorseFilter.java
+++ b/lucene/analysis/phonetic/src/java/org/apache/lucene/analysis/phonetic/BeiderMorseFilter.java
@@ -61,8 +61,8 @@ public final class BeiderMorseFilter extends TokenFilter {
* Calls
* {@link #BeiderMorseFilter(TokenStream, PhoneticEngine, org.apache.commons.codec.language.bm.Languages.LanguageSet)}
*
- * @param input
- * @param engine
+ * @param input TokenStream to filter
+ * @param engine configured PhoneticEngine with BM settings.
*/
public BeiderMorseFilter(TokenStream input, PhoneticEngine engine) {
this(input, engine, null);
diff --git a/lucene/analysis/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/BigramDictionary.java b/lucene/analysis/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/BigramDictionary.java
index 6ee1b66aef2..bffed1a299c 100644
--- a/lucene/analysis/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/BigramDictionary.java
+++ b/lucene/analysis/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/BigramDictionary.java
@@ -139,9 +139,7 @@ class BigramDictionary extends AbstractDictionary {
* Load the datafile into this BigramDictionary
*
* @param dctFilePath path to the Bigramdictionary (bigramdict.dct)
- * @throws FileNotFoundException
- * @throws IOException
- * @throws UnsupportedEncodingException
+ * @throws IOException If there is a low-level I/O error
*/
public void loadFromFile(String dctFilePath) throws IOException {
diff --git a/lucene/analysis/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/WordDictionary.java b/lucene/analysis/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/WordDictionary.java
index cfd72abec6b..9a7979ec5a4 100644
--- a/lucene/analysis/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/WordDictionary.java
+++ b/lucene/analysis/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/WordDictionary.java
@@ -133,8 +133,7 @@ class WordDictionary extends AbstractDictionary {
/**
* Load coredict.mem internally from the jar file.
*
- * @throws ClassNotFoundException
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
public void load() throws IOException, ClassNotFoundException {
InputStream input = this.getClass().getResourceAsStream("coredict.mem");
@@ -181,9 +180,7 @@ class WordDictionary extends AbstractDictionary {
*
* @param dctFilePath path to word dictionary (coredict.dct)
* @return number of words read
- * @throws FileNotFoundException
- * @throws IOException
- * @throws UnsupportedEncodingException
+ * @throws IOException If there is a low-level I/O error.
*/
private int loadMainDataFromFile(String dctFilePath) throws IOException {
int i, cnt, length, total = 0;
diff --git a/lucene/analysis/uima/src/java/org/apache/lucene/analysis/uima/BaseUIMATokenizer.java b/lucene/analysis/uima/src/java/org/apache/lucene/analysis/uima/BaseUIMATokenizer.java
index c6001c86102..78758cb7786 100644
--- a/lucene/analysis/uima/src/java/org/apache/lucene/analysis/uima/BaseUIMATokenizer.java
+++ b/lucene/analysis/uima/src/java/org/apache/lucene/analysis/uima/BaseUIMATokenizer.java
@@ -54,8 +54,7 @@ public abstract class BaseUIMATokenizer extends Tokenizer {
*
* {@link #cas} will be filled with extracted metadata (UIMA annotations, feature structures)
*
- * @throws AnalysisEngineProcessException
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
protected void analyzeInput() throws AnalysisEngineProcessException, IOException {
cas.reset();
@@ -66,7 +65,7 @@ public abstract class BaseUIMATokenizer extends Tokenizer {
/**
* initialize the FSIterator which is used to build tokens at each incrementToken() method call
*
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
protected abstract void initializeIterator() throws IOException;
diff --git a/lucene/analysis/uima/src/java/org/apache/lucene/analysis/uima/ae/AEProvider.java b/lucene/analysis/uima/src/java/org/apache/lucene/analysis/uima/ae/AEProvider.java
index 068a405f6f5..ba102d278da 100644
--- a/lucene/analysis/uima/src/java/org/apache/lucene/analysis/uima/ae/AEProvider.java
+++ b/lucene/analysis/uima/src/java/org/apache/lucene/analysis/uima/ae/AEProvider.java
@@ -27,9 +27,7 @@ import org.apache.uima.resource.ResourceInitializationException;
public interface AEProvider {
/**
- *
- * @return AnalysisEngine
- * @throws ResourceInitializationException
+ * Returns the AnalysisEngine
*/
public AnalysisEngine getAE() throws ResourceInitializationException;
diff --git a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/HTMLParser.java b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/HTMLParser.java
index c4712007794..25fe210b653 100755
--- a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/HTMLParser.java
+++ b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/HTMLParser.java
@@ -36,7 +36,7 @@ public interface HTMLParser {
* @param reader reader of html text to parse.
* @param trecSrc the {@link TrecContentSource} used to parse dates.
* @return Parsed doc data.
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
public DocData parse(DocData docData, String name, Date date, Reader reader, TrecContentSource trecSrc) throws IOException;
diff --git a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/QueryMaker.java b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/QueryMaker.java
index 4e54b3992d4..749136b1bd1 100644
--- a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/QueryMaker.java
+++ b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/QueryMaker.java
@@ -37,8 +37,7 @@ public interface QueryMaker {
/** Create the next query */
public Query makeQuery () throws Exception;
- /** Set the properties
- * @throws Exception */
+ /** Set the properties */
public void setConfig (Config config) throws Exception;
/** Reset inputs so that the test run would behave, input wise, as if it just started. */
diff --git a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/TrecContentSource.java b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/TrecContentSource.java
index 3142275870e..7d9ce5f4cf1 100644
--- a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/TrecContentSource.java
+++ b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/TrecContentSource.java
@@ -130,8 +130,8 @@ public class TrecContentSource extends ContentSource {
* @param lineStart line start to look for, must not be null.
* @param collectMatchLine whether to collect the matching line into buffer.
* @param collectAll whether to collect all lines into buffer.
- * @throws IOException
- * @throws NoMoreDataException
+ * @throws IOException If there is a low-level I/O error.
+ * @throws NoMoreDataException If the source is exhausted.
*/
private void read(StringBuilder buf, String lineStart,
boolean collectMatchLine, boolean collectAll) throws IOException, NoMoreDataException {
diff --git a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/programmatic/Sample.java b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/programmatic/Sample.java
index 6a1a60321a9..0c57d20c3b5 100644
--- a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/programmatic/Sample.java
+++ b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/programmatic/Sample.java
@@ -32,11 +32,6 @@ import org.apache.lucene.benchmark.byTask.utils.Config;
*/
public class Sample {
- /**
- * @param args
- * @throws Exception
- * @throws IOException
- */
public static void main(String[] args) throws Exception {
Properties p = initProps();
Config conf = new Config(p);
diff --git a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/TaskSequence.java b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/TaskSequence.java
index 5f80c5f0ec3..10922204369 100644
--- a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/TaskSequence.java
+++ b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/TaskSequence.java
@@ -109,7 +109,6 @@ public class TaskSequence extends PerfTask {
/**
* @param repetitions The repetitions to set.
- * @throws Exception
*/
public void setRepetitions(int repetitions) throws Exception {
fixedTime = false;
diff --git a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/utils/Algorithm.java b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/utils/Algorithm.java
index 78ff2d44d4c..fec744e10ca 100644
--- a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/utils/Algorithm.java
+++ b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/utils/Algorithm.java
@@ -295,7 +295,6 @@ public class Algorithm {
/**
* Execute this algorithm
- * @throws Exception
*/
public void execute() throws Exception {
try {
diff --git a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/utils/Config.java b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/utils/Config.java
index 88af670dfa2..60baaf89287 100644
--- a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/utils/Config.java
+++ b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/utils/Config.java
@@ -58,7 +58,7 @@ public class Config {
* Read both algorithm and config properties.
*
* @param algReader from where to read algorithm and config properties.
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
public Config(Reader algReader) throws IOException {
// read alg file to array of lines
@@ -163,7 +163,6 @@ public class Config {
*
* @param name name of property.
* @param value either single or multiple property value (multiple values are separated by ":")
- * @throws Exception
*/
public void set(String name, String value) throws Exception {
if (valByRound.get(name) != null) {
diff --git a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/utils/FileUtils.java b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/utils/FileUtils.java
index 306aab7f298..2ad6492be4f 100644
--- a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/utils/FileUtils.java
+++ b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/utils/FileUtils.java
@@ -30,7 +30,7 @@ public class FileUtils {
*
* @param dir file or directory
* @return true on success, false if no or part of files have been deleted
- * @throws java.io.IOException
+ * @throws IOException If there is a low-level I/O error.
*/
public static boolean fullyDelete(File dir) throws IOException {
if (dir == null || !dir.exists()) return false;
diff --git a/lucene/benchmark/src/java/org/apache/lucene/benchmark/quality/trec/TrecJudge.java b/lucene/benchmark/src/java/org/apache/lucene/benchmark/quality/trec/TrecJudge.java
index f351b7d1339..e239b3b052b 100644
--- a/lucene/benchmark/src/java/org/apache/lucene/benchmark/quality/trec/TrecJudge.java
+++ b/lucene/benchmark/src/java/org/apache/lucene/benchmark/quality/trec/TrecJudge.java
@@ -46,7 +46,7 @@ public class TrecJudge implements Judge {
* 19 0 doc7295 0
*
* @param reader where judgments are read from.
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
public TrecJudge (BufferedReader reader) throws IOException {
judgements = new HashMap();
diff --git a/lucene/benchmark/src/java/org/apache/lucene/benchmark/utils/ExtractReuters.java b/lucene/benchmark/src/java/org/apache/lucene/benchmark/utils/ExtractReuters.java
index dade9976763..1322f8a6a0f 100644
--- a/lucene/benchmark/src/java/org/apache/lucene/benchmark/utils/ExtractReuters.java
+++ b/lucene/benchmark/src/java/org/apache/lucene/benchmark/utils/ExtractReuters.java
@@ -74,8 +74,6 @@ public class ExtractReuters {
/**
* Override if you wish to change what is extracted
- *
- * @param sgmFile
*/
protected void extractFile(File sgmFile) {
try {
diff --git a/lucene/classification/src/java/org/apache/lucene/classification/Classifier.java b/lucene/classification/src/java/org/apache/lucene/classification/Classifier.java
index 866cede4751..eb681212df2 100644
--- a/lucene/classification/src/java/org/apache/lucene/classification/Classifier.java
+++ b/lucene/classification/src/java/org/apache/lucene/classification/Classifier.java
@@ -32,7 +32,7 @@ public interface Classifier {
* Assign a class to the given text String
* @param text a String containing text to be classified
* @return a String representing a class
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
public String assignClass(String text) throws IOException;
@@ -42,7 +42,7 @@ public interface Classifier {
* @param textFieldName the name of the field used to compare documents
* @param classFieldName the name of the field containing the class assigned to documents
* @param analyzer the analyzer used to tokenize / filter the unseen text
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
public void train(AtomicReader atomicReader, String textFieldName, String classFieldName, Analyzer analyzer)
throws IOException;
diff --git a/lucene/codecs/src/java/org/apache/lucene/codecs/block/ForUtil.java b/lucene/codecs/src/java/org/apache/lucene/codecs/block/ForUtil.java
index b403876eef6..fc52520f551 100644
--- a/lucene/codecs/src/java/org/apache/lucene/codecs/block/ForUtil.java
+++ b/lucene/codecs/src/java/org/apache/lucene/codecs/block/ForUtil.java
@@ -153,7 +153,7 @@ final class ForUtil {
* @param data the data to write
* @param encoded a buffer to use to encode data
* @param out the destination output
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
void writeBlock(int[] data, byte[] encoded, IndexOutput out) throws IOException {
if (isAllEqual(data)) {
@@ -182,7 +182,7 @@ final class ForUtil {
* @param in the input to use to read data
* @param encoded a buffer that can be used to store encoded data
* @param decoded where to write decoded data
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
void readBlock(IndexInput in, byte[] encoded, int[] decoded) throws IOException {
final int numBits = in.readVInt();
@@ -208,7 +208,7 @@ final class ForUtil {
* Skip the next block of data.
*
* @param in the input where to read data
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
void skipBlock(IndexInput in) throws IOException {
final int numBits = in.readVInt();
diff --git a/lucene/codecs/src/java/org/apache/lucene/codecs/bloom/FuzzySet.java b/lucene/codecs/src/java/org/apache/lucene/codecs/bloom/FuzzySet.java
index fd2d095d01b..42973155814 100644
--- a/lucene/codecs/src/java/org/apache/lucene/codecs/bloom/FuzzySet.java
+++ b/lucene/codecs/src/java/org/apache/lucene/codecs/bloom/FuzzySet.java
@@ -111,7 +111,6 @@ public class FuzzySet {
/**
* Use this method to choose a set size where accuracy (low content saturation) is more important
* than deciding how much memory to throw at the problem.
- * @param maxNumberOfValuesExpected
* @param desiredSaturation A number between 0 and 1 expressing the % of bits set once all values have been recorded
* @return The size of the set nearest to the required size
*/
@@ -155,7 +154,6 @@ public class FuzzySet {
/**
* The main method required for a Bloom filter which, given a value determines set membership.
* Unlike a conventional set, the fuzzy set returns NO or MAYBE rather than true or false.
- * @param value
* @return NO or MAYBE
*/
public ContainsResult contains(BytesRef value) {
@@ -182,7 +180,7 @@ public class FuzzySet {
* returned by {@link FixedBitSet#getBits}
*
* @param out Data output stream
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
public void serialize(DataOutput out) throws IOException
{
@@ -229,7 +227,7 @@ public class FuzzySet {
* Records a value in the set. The referenced bytes are hashed and then modulo n'd where n is the
* chosen size of the internal bitset.
* @param value the key value to be hashed
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
public void addValue(BytesRef value) throws IOException {
int hash = hashFunction.hash(value);
diff --git a/lucene/core/src/java/org/apache/lucene/analysis/Token.java b/lucene/core/src/java/org/apache/lucene/analysis/Token.java
index 6a2b71a070c..9a5f1a4d909 100644
--- a/lucene/core/src/java/org/apache/lucene/analysis/Token.java
+++ b/lucene/core/src/java/org/apache/lucene/analysis/Token.java
@@ -523,7 +523,7 @@ public class Token extends CharTermAttributeImpl
/**
* Copy the prototype token's fields into this one. Note: Payloads are shared.
- * @param prototype
+ * @param prototype source Token to copy fields from
*/
public void reinit(Token prototype) {
copyBuffer(prototype.buffer(), 0, prototype.length());
diff --git a/lucene/core/src/java/org/apache/lucene/analysis/TokenStream.java b/lucene/core/src/java/org/apache/lucene/analysis/TokenStream.java
index 14370ff5d74..5b961d67e02 100644
--- a/lucene/core/src/java/org/apache/lucene/analysis/TokenStream.java
+++ b/lucene/core/src/java/org/apache/lucene/analysis/TokenStream.java
@@ -160,7 +160,7 @@ public abstract class TokenStream extends AttributeSource implements Closeable {
* differ from the offset of the last token eg in case one or more whitespaces
* followed after the last token, but a WhitespaceTokenizer was used.
*
- * @throws IOException
+ * @throws IOException If an I/O error occurs
*/
public void end() throws IOException {
// do nothing by default
diff --git a/lucene/core/src/java/org/apache/lucene/codecs/DocValuesConsumer.java b/lucene/core/src/java/org/apache/lucene/codecs/DocValuesConsumer.java
index 1730d05ed8d..12e05df38de 100644
--- a/lucene/core/src/java/org/apache/lucene/codecs/DocValuesConsumer.java
+++ b/lucene/core/src/java/org/apache/lucene/codecs/DocValuesConsumer.java
@@ -84,7 +84,7 @@ public abstract class DocValuesConsumer {
* the total number of documents in this {@link DocValuesConsumer}.
* Must be greater than or equal the last given docID to
* {@link #add(int, StorableField)}.
- * @throws IOException
+ * @throws IOException If an I/O error occurs
*/
public abstract void finish(int docCount) throws IOException;
diff --git a/lucene/core/src/java/org/apache/lucene/codecs/MultiLevelSkipListWriter.java b/lucene/core/src/java/org/apache/lucene/codecs/MultiLevelSkipListWriter.java
index 1a449bf13c7..a90ee4a5a24 100644
--- a/lucene/core/src/java/org/apache/lucene/codecs/MultiLevelSkipListWriter.java
+++ b/lucene/core/src/java/org/apache/lucene/codecs/MultiLevelSkipListWriter.java
@@ -121,7 +121,7 @@ public abstract class MultiLevelSkipListWriter {
* the max level is skip data is to be written to.
*
* @param df the current document frequency
- * @throws IOException
+ * @throws IOException If an I/O error occurs
*/
public void bufferSkip(int df) throws IOException {
diff --git a/lucene/core/src/java/org/apache/lucene/codecs/PerDocProducer.java b/lucene/core/src/java/org/apache/lucene/codecs/PerDocProducer.java
index 0715d9d888f..02af0311396 100644
--- a/lucene/core/src/java/org/apache/lucene/codecs/PerDocProducer.java
+++ b/lucene/core/src/java/org/apache/lucene/codecs/PerDocProducer.java
@@ -45,7 +45,7 @@ public abstract class PerDocProducer implements Closeable {
* the field name
* @return the {@link DocValues} for this field or null if not
* applicable.
- * @throws IOException
+ * @throws IOException If an I/O error occurs
*/
public abstract DocValues docValues(String field) throws IOException;
diff --git a/lucene/core/src/java/org/apache/lucene/codecs/SegmentInfoReader.java b/lucene/core/src/java/org/apache/lucene/codecs/SegmentInfoReader.java
index 1520717e60a..98036230979 100644
--- a/lucene/core/src/java/org/apache/lucene/codecs/SegmentInfoReader.java
+++ b/lucene/core/src/java/org/apache/lucene/codecs/SegmentInfoReader.java
@@ -40,7 +40,7 @@ public abstract class SegmentInfoReader {
* @param directory directory to read from
* @param segmentName name of the segment to read
* @return infos instance to be populated with data
- * @throws IOException
+ * @throws IOException If an I/O error occurs
*/
public abstract SegmentInfo read(Directory directory, String segmentName, IOContext context) throws IOException;
}
diff --git a/lucene/core/src/java/org/apache/lucene/codecs/SegmentInfoWriter.java b/lucene/core/src/java/org/apache/lucene/codecs/SegmentInfoWriter.java
index 91ab7f29814..eedbdbbeff0 100644
--- a/lucene/core/src/java/org/apache/lucene/codecs/SegmentInfoWriter.java
+++ b/lucene/core/src/java/org/apache/lucene/codecs/SegmentInfoWriter.java
@@ -37,7 +37,7 @@ public abstract class SegmentInfoWriter {
/**
* Write {@link SegmentInfo} data.
- * @throws IOException
+ * @throws IOException If an I/O error occurs
*/
public abstract void write(Directory dir, SegmentInfo info, FieldInfos fis, IOContext ioContext) throws IOException;
}
diff --git a/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40StoredFieldsReader.java b/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40StoredFieldsReader.java
index bc626be9408..3ab1b586819 100644
--- a/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40StoredFieldsReader.java
+++ b/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40StoredFieldsReader.java
@@ -120,7 +120,7 @@ public final class Lucene40StoredFieldsReader extends StoredFieldsReader impleme
* Closes the underlying {@link org.apache.lucene.store.IndexInput} streams.
* This means that the Fields values will not be accessible.
*
- * @throws IOException
+ * @throws IOException If an I/O error occurs
*/
public final void close() throws IOException {
if (!closed) {
diff --git a/lucene/core/src/java/org/apache/lucene/index/DirectoryReader.java b/lucene/core/src/java/org/apache/lucene/index/DirectoryReader.java
index e6331990c20..b173c43ccf1 100644
--- a/lucene/core/src/java/org/apache/lucene/index/DirectoryReader.java
+++ b/lucene/core/src/java/org/apache/lucene/index/DirectoryReader.java
@@ -99,7 +99,7 @@ public abstract class DirectoryReader extends BaseCompositeReader
* can tolerate deleted documents being returned you might
* gain some performance by passing false.
* @return The new IndexReader
- * @throws CorruptIndexException
+ * @throws CorruptIndexException if the index is corrupt
* @throws IOException if there is a low-level IO error
*
* @see #openIfChanged(DirectoryReader,IndexWriter,boolean)
@@ -241,7 +241,7 @@ public abstract class DirectoryReader extends BaseCompositeReader
* can tolerate deleted documents being returned you might
* gain some performance by passing false.
*
- * @throws IOException
+ * @throws IOException if there is a low-level IO error
*
* @lucene.experimental
*/
diff --git a/lucene/core/src/java/org/apache/lucene/index/FieldInfos.java b/lucene/core/src/java/org/apache/lucene/index/FieldInfos.java
index 50df32f1473..d3be8a63c1f 100644
--- a/lucene/core/src/java/org/apache/lucene/index/FieldInfos.java
+++ b/lucene/core/src/java/org/apache/lucene/index/FieldInfos.java
@@ -146,10 +146,13 @@ public class FieldInfos implements Iterable {
/**
* Return the fieldinfo object referenced by the fieldNumber.
- * @param fieldNumber
+ * @param fieldNumber field's number. if this is negative, this method
+ * always returns null.
* @return the FieldInfo object or null when the given fieldNumber
* doesn't exist.
*/
+ // TODO: fix this negative behavior, this was something related to Lucene3x?
+ // if the field name is empty, i think it writes the fieldNumber as -1
public FieldInfo fieldInfo(int fieldNumber) {
return (fieldNumber >= 0) ? byNumber.get(fieldNumber) : null;
}
diff --git a/lucene/core/src/java/org/apache/lucene/index/FilteredTermsEnum.java b/lucene/core/src/java/org/apache/lucene/index/FilteredTermsEnum.java
index 0e51884dfc9..563ac85739e 100644
--- a/lucene/core/src/java/org/apache/lucene/index/FilteredTermsEnum.java
+++ b/lucene/core/src/java/org/apache/lucene/index/FilteredTermsEnum.java
@@ -150,7 +150,8 @@ public abstract class FilteredTermsEnum extends TermsEnum {
}
/** This enum does not support seeking!
- * @throws UnsupportedOperationException
+ * @throws UnsupportedOperationException In general, subclasses do not
+ * support seeking.
*/
@Override
public boolean seekExact(BytesRef term, boolean useCache) throws IOException {
@@ -158,7 +159,8 @@ public abstract class FilteredTermsEnum extends TermsEnum {
}
/** This enum does not support seeking!
- * @throws UnsupportedOperationException
+ * @throws UnsupportedOperationException In general, subclasses do not
+ * support seeking.
*/
@Override
public SeekStatus seekCeil(BytesRef term, boolean useCache) throws IOException {
@@ -166,7 +168,8 @@ public abstract class FilteredTermsEnum extends TermsEnum {
}
/** This enum does not support seeking!
- * @throws UnsupportedOperationException
+ * @throws UnsupportedOperationException In general, subclasses do not
+ * support seeking.
*/
@Override
public void seekExact(long ord) throws IOException {
@@ -189,7 +192,8 @@ public abstract class FilteredTermsEnum extends TermsEnum {
}
/** This enum does not support seeking!
- * @throws UnsupportedOperationException
+ * @throws UnsupportedOperationException In general, subclasses do not
+ * support seeking.
*/
@Override
public void seekExact(BytesRef term, TermState state) throws IOException {
diff --git a/lucene/core/src/java/org/apache/lucene/index/IndexWriter.java b/lucene/core/src/java/org/apache/lucene/index/IndexWriter.java
index 20783fb2d17..e4d74a35a55 100644
--- a/lucene/core/src/java/org/apache/lucene/index/IndexWriter.java
+++ b/lucene/core/src/java/org/apache/lucene/index/IndexWriter.java
@@ -320,7 +320,7 @@ public class IndexWriter implements Closeable, TwoPhaseCommit {
* @return IndexReader that covers entire index plus all
* changes made so far by this IndexWriter instance
*
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
DirectoryReader getReader(boolean applyAllDeletes) throws IOException {
ensureOpen();
@@ -473,7 +473,7 @@ public class IndexWriter implements Closeable, TwoPhaseCommit {
* Commit live docs changes for the segment readers for
* the provided infos.
*
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
public synchronized void commit(SegmentInfos infos) throws IOException {
for (SegmentInfoPerCommit info : infos) {
diff --git a/lucene/core/src/java/org/apache/lucene/index/ReaderManager.java b/lucene/core/src/java/org/apache/lucene/index/ReaderManager.java
index 83fdc1c94fc..5a463af0734 100755
--- a/lucene/core/src/java/org/apache/lucene/index/ReaderManager.java
+++ b/lucene/core/src/java/org/apache/lucene/index/ReaderManager.java
@@ -51,7 +51,7 @@ public final class ReaderManager extends ReferenceManager {
* performance by passing false. See
* {@link DirectoryReader#openIfChanged(DirectoryReader, IndexWriter, boolean)}.
*
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
public ReaderManager(IndexWriter writer, boolean applyAllDeletes) throws IOException {
current = DirectoryReader.open(writer, applyAllDeletes);
@@ -61,7 +61,7 @@ public final class ReaderManager extends ReferenceManager {
* Creates and returns a new ReaderManager from the given {@link Directory}.
* @param dir the directory to open the DirectoryReader on.
*
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
public ReaderManager(Directory dir) throws IOException {
current = DirectoryReader.open(dir);
diff --git a/lucene/core/src/java/org/apache/lucene/index/SegmentMerger.java b/lucene/core/src/java/org/apache/lucene/index/SegmentMerger.java
index 716839ae514..cd1a616f385 100644
--- a/lucene/core/src/java/org/apache/lucene/index/SegmentMerger.java
+++ b/lucene/core/src/java/org/apache/lucene/index/SegmentMerger.java
@@ -70,7 +70,6 @@ final class SegmentMerger {
/**
* Add an IndexReader to the collection of readers that are to be merged
- * @param reader
*/
final void add(IndexReader reader) {
for (final AtomicReaderContext ctx : reader.leaves()) {
@@ -253,7 +252,7 @@ final class SegmentMerger {
/**
* Merge the TermVectors from each of the segments into the new one.
- * @throws IOException
+ * @throws IOException if there is a low-level IO error
*/
private final int mergeVectors() throws IOException {
final TermVectorsWriter termVectorsWriter = codec.termVectorsFormat().vectorsWriter(directory, mergeState.segmentInfo, context);
diff --git a/lucene/core/src/java/org/apache/lucene/index/SegmentReader.java b/lucene/core/src/java/org/apache/lucene/index/SegmentReader.java
index 507c3661cd8..221b8537e8a 100644
--- a/lucene/core/src/java/org/apache/lucene/index/SegmentReader.java
+++ b/lucene/core/src/java/org/apache/lucene/index/SegmentReader.java
@@ -168,12 +168,6 @@ public final class SegmentReader extends AtomicReader {
return core.termVectorsLocal.get();
}
- /** Return a term frequency vector for the specified document and field. The
- * vector returned contains term numbers and frequencies for all terms in
- * the specified field of this document, if the field had storeTermVector
- * flag set. If the flag was not set, the method returns null.
- * @throws IOException
- */
@Override
public Fields getTermVectors(int docID) throws IOException {
TermVectorsReader termVectorsReader = getTermVectorsReader();
diff --git a/lucene/core/src/java/org/apache/lucene/index/Term.java b/lucene/core/src/java/org/apache/lucene/index/Term.java
index a2efbcfaac1..ac7696e8775 100644
--- a/lucene/core/src/java/org/apache/lucene/index/Term.java
+++ b/lucene/core/src/java/org/apache/lucene/index/Term.java
@@ -56,7 +56,7 @@ public final class Term implements Comparable {
* This serves two purposes: 1) reuse of a Term with the same field.
* 2) pattern for a query.
*
- * @param fld
+ * @param fld field's name
*/
public Term(String fld) {
this(fld, new BytesRef());
diff --git a/lucene/core/src/java/org/apache/lucene/search/FieldComparator.java b/lucene/core/src/java/org/apache/lucene/search/FieldComparator.java
index 9d1fbafd7bf..b75c020d6ab 100644
--- a/lucene/core/src/java/org/apache/lucene/search/FieldComparator.java
+++ b/lucene/core/src/java/org/apache/lucene/search/FieldComparator.java
@@ -148,7 +148,7 @@ public abstract class FieldComparator {
* @return the comparator to use for this segment; most
* comparators can just return "this" to reuse the same
* comparator across segments
- * @throws IOException
+ * @throws IOException if there is a low-level IO error
*/
public abstract FieldComparator setNextReader(AtomicReaderContext context) throws IOException;
diff --git a/lucene/core/src/java/org/apache/lucene/search/FieldValueHitQueue.java b/lucene/core/src/java/org/apache/lucene/search/FieldValueHitQueue.java
index 97a9974c6f1..a77c9f8422a 100644
--- a/lucene/core/src/java/org/apache/lucene/search/FieldValueHitQueue.java
+++ b/lucene/core/src/java/org/apache/lucene/search/FieldValueHitQueue.java
@@ -159,7 +159,7 @@ public abstract class FieldValueHitQueue ext
* priority first); cannot be null or empty
* @param size
* The number of hits to retain. Must be greater than zero.
- * @throws IOException
+ * @throws IOException if there is a low-level IO error
*/
public static FieldValueHitQueue create(SortField[] fields, int size) throws IOException {
diff --git a/lucene/core/src/java/org/apache/lucene/search/FuzzyTermsEnum.java b/lucene/core/src/java/org/apache/lucene/search/FuzzyTermsEnum.java
index 304b4a36acb..4f52f36bb01 100644
--- a/lucene/core/src/java/org/apache/lucene/search/FuzzyTermsEnum.java
+++ b/lucene/core/src/java/org/apache/lucene/search/FuzzyTermsEnum.java
@@ -96,7 +96,7 @@ public class FuzzyTermsEnum extends TermsEnum {
* @param minSimilarity Minimum required similarity for terms from the reader. Pass an integer value
* representing edit distance. Passing a fraction is deprecated.
* @param prefixLength Length of required common prefix. Default value is 0.
- * @throws IOException
+ * @throws IOException if there is a low-level IO error
*/
public FuzzyTermsEnum(Terms terms, AttributeSource atts, Term term,
final float minSimilarity, final int prefixLength, boolean transpositions) throws IOException {
diff --git a/lucene/core/src/java/org/apache/lucene/search/IndexSearcher.java b/lucene/core/src/java/org/apache/lucene/search/IndexSearcher.java
index b142697a064..5626b25e982 100644
--- a/lucene/core/src/java/org/apache/lucene/search/IndexSearcher.java
+++ b/lucene/core/src/java/org/apache/lucene/search/IndexSearcher.java
@@ -220,7 +220,8 @@ public class IndexSearcher {
* this method can be used for efficient 'deep-paging' across potentially
* large result sets.
*
- * @throws BooleanQuery.TooManyClauses
+ * @throws BooleanQuery.TooManyClauses If a query would exceed
+ * {@link BooleanQuery#getMaxClauseCount()} clauses.
*/
public TopDocs searchAfter(ScoreDoc after, Query query, int n) throws IOException {
return search(createNormalizedWeight(query), after, n);
@@ -234,7 +235,8 @@ public class IndexSearcher {
* this method can be used for efficient 'deep-paging' across potentially
* large result sets.
*
- * @throws BooleanQuery.TooManyClauses
+ * @throws BooleanQuery.TooManyClauses If a query would exceed
+ * {@link BooleanQuery#getMaxClauseCount()} clauses.
*/
public TopDocs searchAfter(ScoreDoc after, Query query, Filter filter, int n) throws IOException {
return search(createNormalizedWeight(wrapFilter(query, filter)), after, n);
@@ -243,7 +245,8 @@ public class IndexSearcher {
/** Finds the top n
* hits for query.
*
- * @throws BooleanQuery.TooManyClauses
+ * @throws BooleanQuery.TooManyClauses If a query would exceed
+ * {@link BooleanQuery#getMaxClauseCount()} clauses.
*/
public TopDocs search(Query query, int n)
throws IOException {
@@ -254,7 +257,8 @@ public class IndexSearcher {
/** Finds the top n
* hits for query, applying filter if non-null.
*
- * @throws BooleanQuery.TooManyClauses
+ * @throws BooleanQuery.TooManyClauses If a query would exceed
+ * {@link BooleanQuery#getMaxClauseCount()} clauses.
*/
public TopDocs search(Query query, Filter filter, int n)
throws IOException {
@@ -269,7 +273,8 @@ public class IndexSearcher {
* @param query to match documents
* @param filter if non-null, used to permit documents to be collected.
* @param results to receive hits
- * @throws BooleanQuery.TooManyClauses
+ * @throws BooleanQuery.TooManyClauses If a query would exceed
+ * {@link BooleanQuery#getMaxClauseCount()} clauses.
*/
public void search(Query query, Filter filter, Collector results)
throws IOException {
@@ -277,11 +282,12 @@ public class IndexSearcher {
}
/** Lower-level search API.
- *
- *
{@link Collector#collect(int)} is called for every matching document.
- *
- * @throws BooleanQuery.TooManyClauses
- */
+ *
+ *
{@link Collector#collect(int)} is called for every matching document.
+ *
+ * @throws BooleanQuery.TooManyClauses If a query would exceed
+ * {@link BooleanQuery#getMaxClauseCount()} clauses.
+ */
public void search(Query query, Collector results)
throws IOException {
search(leafContexts, createNormalizedWeight(query), results);
@@ -296,7 +302,8 @@ public class IndexSearcher {
* {@link IndexSearcher#search(Query,Filter,int,Sort,boolean,boolean)} to
* control scoring.
*
- * @throws BooleanQuery.TooManyClauses
+ * @throws BooleanQuery.TooManyClauses If a query would exceed
+ * {@link BooleanQuery#getMaxClauseCount()} clauses.
*/
public TopFieldDocs search(Query query, Filter filter, int n,
Sort sort) throws IOException {
@@ -314,7 +321,8 @@ public class IndexSearcher {
* true then the maximum score over all
* collected hits will be computed.
*
- * @throws BooleanQuery.TooManyClauses
+ * @throws BooleanQuery.TooManyClauses If a query would exceed
+ * {@link BooleanQuery#getMaxClauseCount()} clauses.
*/
public TopFieldDocs search(Query query, Filter filter, int n,
Sort sort, boolean doDocScores, boolean doMaxScore) throws IOException {
@@ -329,7 +337,8 @@ public class IndexSearcher {
* this method can be used for efficient 'deep-paging' across potentially
* large result sets.
*
- * @throws BooleanQuery.TooManyClauses
+ * @throws BooleanQuery.TooManyClauses If a query would exceed
+ * {@link BooleanQuery#getMaxClauseCount()} clauses.
*/
public TopDocs searchAfter(ScoreDoc after, Query query, Filter filter, int n, Sort sort) throws IOException {
if (after != null && !(after instanceof FieldDoc)) {
@@ -346,7 +355,7 @@ public class IndexSearcher {
* @param n Return only the top n results
* @param sort The {@link org.apache.lucene.search.Sort} object
* @return The top docs, sorted according to the supplied {@link org.apache.lucene.search.Sort} instance
- * @throws IOException
+ * @throws IOException if there is a low-level I/O error
*/
public TopFieldDocs search(Query query, int n,
Sort sort) throws IOException {
@@ -361,7 +370,8 @@ public class IndexSearcher {
* this method can be used for efficient 'deep-paging' across potentially
* large result sets.
*
- * @throws BooleanQuery.TooManyClauses
+ * @throws BooleanQuery.TooManyClauses If a query would exceed
+ * {@link BooleanQuery#getMaxClauseCount()} clauses.
*/
public TopDocs searchAfter(ScoreDoc after, Query query, int n, Sort sort) throws IOException {
if (after != null && !(after instanceof FieldDoc)) {
@@ -385,7 +395,8 @@ public class IndexSearcher {
* true then the maximum score over all
* collected hits will be computed.
*
- * @throws BooleanQuery.TooManyClauses
+ * @throws BooleanQuery.TooManyClauses If a query would exceed
+ * {@link BooleanQuery#getMaxClauseCount()} clauses.
*/
public TopDocs searchAfter(ScoreDoc after, Query query, Filter filter, int n, Sort sort,
boolean doDocScores, boolean doMaxScore) throws IOException {
@@ -403,7 +414,8 @@ public class IndexSearcher {
*
*
Applications should usually call {@link IndexSearcher#search(Query,int)} or
* {@link IndexSearcher#search(Query,Filter,int)} instead.
- * @throws BooleanQuery.TooManyClauses
+ * @throws BooleanQuery.TooManyClauses If a query would exceed
+ * {@link BooleanQuery#getMaxClauseCount()} clauses.
*/
protected TopDocs search(Weight weight, ScoreDoc after, int nDocs) throws IOException {
if (executor == null) {
@@ -440,7 +452,8 @@ public class IndexSearcher {
*
*
Applications should usually call {@link IndexSearcher#search(Query,int)} or
* {@link IndexSearcher#search(Query,Filter,int)} instead.
- * @throws BooleanQuery.TooManyClauses
+ * @throws BooleanQuery.TooManyClauses If a query would exceed
+ * {@link BooleanQuery#getMaxClauseCount()} clauses.
*/
protected TopDocs search(List leaves, Weight weight, ScoreDoc after, int nDocs) throws IOException {
// single thread
@@ -463,7 +476,8 @@ public class IndexSearcher {
*
Applications should usually call {@link
* IndexSearcher#search(Query,Filter,int,Sort)} instead.
*
- * @throws BooleanQuery.TooManyClauses
+ * @throws BooleanQuery.TooManyClauses If a query would exceed
+ * {@link BooleanQuery#getMaxClauseCount()} clauses.
*/
protected TopFieldDocs search(Weight weight,
final int nDocs, Sort sort,
@@ -559,7 +573,8 @@ public class IndexSearcher {
* to match documents
* @param collector
* to receive hits
- * @throws BooleanQuery.TooManyClauses
+ * @throws BooleanQuery.TooManyClauses If a query would exceed
+ * {@link BooleanQuery#getMaxClauseCount()} clauses.
*/
protected void search(List leaves, Weight weight, Collector collector)
throws IOException {
@@ -577,7 +592,8 @@ public class IndexSearcher {
}
/** Expert: called to re-write queries into primitive queries.
- * @throws BooleanQuery.TooManyClauses
+ * @throws BooleanQuery.TooManyClauses If a query would exceed
+ * {@link BooleanQuery#getMaxClauseCount()} clauses.
*/
public Query rewrite(Query original) throws IOException {
Query query = original;
@@ -609,7 +625,8 @@ public class IndexSearcher {
* Computing an explanation is as expensive as executing the query over the
* entire index.
*
Applications should call {@link IndexSearcher#explain(Query, int)}.
- * @throws BooleanQuery.TooManyClauses
+ * @throws BooleanQuery.TooManyClauses If a query would exceed
+ * {@link BooleanQuery#getMaxClauseCount()} clauses.
*/
protected Explanation explain(Weight weight, int doc) throws IOException {
int n = ReaderUtil.subIndex(doc, leafContexts);
diff --git a/lucene/core/src/java/org/apache/lucene/search/MultiPhraseQuery.java b/lucene/core/src/java/org/apache/lucene/search/MultiPhraseQuery.java
index 992162a8e1c..86494afd35f 100644
--- a/lucene/core/src/java/org/apache/lucene/search/MultiPhraseQuery.java
+++ b/lucene/core/src/java/org/apache/lucene/search/MultiPhraseQuery.java
@@ -86,8 +86,6 @@ public class MultiPhraseQuery extends Query {
* Allows to specify the relative position of terms within the phrase.
*
* @see PhraseQuery#add(Term, int)
- * @param terms
- * @param position
*/
public void add(Term[] terms, int position) {
if (termArrays.size() == 0)
diff --git a/lucene/core/src/java/org/apache/lucene/search/NGramPhraseQuery.java b/lucene/core/src/java/org/apache/lucene/search/NGramPhraseQuery.java
index 20c5c39c717..54d396e852a 100644
--- a/lucene/core/src/java/org/apache/lucene/search/NGramPhraseQuery.java
+++ b/lucene/core/src/java/org/apache/lucene/search/NGramPhraseQuery.java
@@ -35,7 +35,7 @@ public class NGramPhraseQuery extends PhraseQuery {
/**
* Constructor that takes gram size.
- * @param n
+ * @param n n-gram size
*/
public NGramPhraseQuery(int n){
super();
diff --git a/lucene/core/src/java/org/apache/lucene/search/PhraseQuery.java b/lucene/core/src/java/org/apache/lucene/search/PhraseQuery.java
index 724ed2c6853..6471b10afa2 100644
--- a/lucene/core/src/java/org/apache/lucene/search/PhraseQuery.java
+++ b/lucene/core/src/java/org/apache/lucene/search/PhraseQuery.java
@@ -90,8 +90,6 @@ public class PhraseQuery extends Query {
* This allows e.g. phrases with more than one term at the same position
* or phrases with gaps (e.g. in connection with stopwords).
*
- * @param term
- * @param position
*/
public void add(Term term, int position) {
if (terms.size() == 0) {
diff --git a/lucene/core/src/java/org/apache/lucene/search/SearcherManager.java b/lucene/core/src/java/org/apache/lucene/search/SearcherManager.java
index 9c5c743d485..d4cd148bf52 100644
--- a/lucene/core/src/java/org/apache/lucene/search/SearcherManager.java
+++ b/lucene/core/src/java/org/apache/lucene/search/SearcherManager.java
@@ -79,7 +79,7 @@ public final class SearcherManager extends ReferenceManager {
* don't require the searcher to be warmed before going live or other
* custom behavior.
*
- * @throws IOException
+ * @throws IOException if there is a low-level I/O error
*/
public SearcherManager(IndexWriter writer, boolean applyAllDeletes, SearcherFactory searcherFactory) throws IOException {
if (searcherFactory == null) {
@@ -96,7 +96,7 @@ public final class SearcherManager extends ReferenceManager {
* null if you don't require the searcher to be warmed
* before going live or other custom behavior.
*
- * @throws IOException
+ * @throws IOException if there is a low-level I/O error
*/
public SearcherManager(Directory dir, SearcherFactory searcherFactory) throws IOException {
if (searcherFactory == null) {
diff --git a/lucene/core/src/java/org/apache/lucene/search/TimeLimitingCollector.java b/lucene/core/src/java/org/apache/lucene/search/TimeLimitingCollector.java
index 98bdd8b1c19..b671b018b1a 100644
--- a/lucene/core/src/java/org/apache/lucene/search/TimeLimitingCollector.java
+++ b/lucene/core/src/java/org/apache/lucene/search/TimeLimitingCollector.java
@@ -96,7 +96,6 @@ public class TimeLimitingCollector extends Collector {
*
*
* @see #setBaseline()
- * @param clockTime
*/
public void setBaseline(long clockTime) {
t0 = clockTime;
diff --git a/lucene/core/src/java/org/apache/lucene/search/TopFieldCollector.java b/lucene/core/src/java/org/apache/lucene/search/TopFieldCollector.java
index 942c7234b90..9842aeb23a2 100644
--- a/lucene/core/src/java/org/apache/lucene/search/TopFieldCollector.java
+++ b/lucene/core/src/java/org/apache/lucene/search/TopFieldCollector.java
@@ -1060,7 +1060,7 @@ public abstract class TopFieldCollector extends TopDocsCollector {
* the given {@link Scorer} in {@link #setScorer(Scorer)}.
* @return a {@link TopFieldCollector} instance which will sort the results by
* the sort criteria.
- * @throws IOException
+ * @throws IOException if there is a low-level I/O error
*/
public static TopFieldCollector create(Sort sort, int numHits,
boolean fillFields, boolean trackDocScores, boolean trackMaxScore,
@@ -1105,7 +1105,7 @@ public abstract class TopFieldCollector extends TopDocsCollector {
* the given {@link Scorer} in {@link #setScorer(Scorer)}.
* @return a {@link TopFieldCollector} instance which will sort the results by
* the sort criteria.
- * @throws IOException
+ * @throws IOException if there is a low-level I/O error
*/
public static TopFieldCollector create(Sort sort, int numHits, FieldDoc after,
boolean fillFields, boolean trackDocScores, boolean trackMaxScore,
diff --git a/lucene/core/src/java/org/apache/lucene/search/Weight.java b/lucene/core/src/java/org/apache/lucene/search/Weight.java
index 051d705a62d..48dd209d8e5 100644
--- a/lucene/core/src/java/org/apache/lucene/search/Weight.java
+++ b/lucene/core/src/java/org/apache/lucene/search/Weight.java
@@ -108,7 +108,7 @@ public abstract class Weight {
* but possibly filtering other documents)
*
* @return a {@link Scorer} which scores documents in/out-of order.
- * @throws IOException
+ * @throws IOException if there is a low-level I/O error
*/
public abstract Scorer scorer(AtomicReaderContext context, boolean scoreDocsInOrder,
boolean topScorer, Bits acceptDocs) throws IOException;
diff --git a/lucene/core/src/java/org/apache/lucene/search/payloads/PayloadSpanUtil.java b/lucene/core/src/java/org/apache/lucene/search/payloads/PayloadSpanUtil.java
index b8ab5d31d07..3ae6ffdc062 100644
--- a/lucene/core/src/java/org/apache/lucene/search/payloads/PayloadSpanUtil.java
+++ b/lucene/core/src/java/org/apache/lucene/search/payloads/PayloadSpanUtil.java
@@ -69,9 +69,9 @@ public class PayloadSpanUtil {
/**
* Query should be rewritten for wild/fuzzy support.
*
- * @param query
+ * @param query rewritten query
* @return payloads Collection
- * @throws IOException
+ * @throws IOException if there is a low-level I/O error
*/
public Collection getPayloadsForQuery(Query query) throws IOException {
Collection payloads = new ArrayList();
diff --git a/lucene/core/src/java/org/apache/lucene/search/payloads/PayloadTermQuery.java b/lucene/core/src/java/org/apache/lucene/search/payloads/PayloadTermQuery.java
index ee62c0d9164..7c9e9e6078f 100644
--- a/lucene/core/src/java/org/apache/lucene/search/payloads/PayloadTermQuery.java
+++ b/lucene/core/src/java/org/apache/lucene/search/payloads/PayloadTermQuery.java
@@ -139,7 +139,7 @@ public class PayloadTermQuery extends SpanTermQuery {
/**
*
* @return {@link #getSpanScore()} * {@link #getPayloadScore()}
- * @throws IOException
+ * @throws IOException if there is a low-level I/O error
*/
@Override
public float score() throws IOException {
@@ -154,7 +154,7 @@ public class PayloadTermQuery extends SpanTermQuery {
* Should not be overridden without good cause!
*
* @return the score for just the Span part w/o the payload
- * @throws IOException
+ * @throws IOException if there is a low-level I/O error
*
* @see #score()
*/
diff --git a/lucene/core/src/java/org/apache/lucene/search/similarities/Similarity.java b/lucene/core/src/java/org/apache/lucene/search/similarities/Similarity.java
index bacd4e6fc3c..9aff3b9e412 100644
--- a/lucene/core/src/java/org/apache/lucene/search/similarities/Similarity.java
+++ b/lucene/core/src/java/org/apache/lucene/search/similarities/Similarity.java
@@ -179,7 +179,7 @@ public abstract class Similarity {
* @param weight collection information from {@link #computeWeight(float, CollectionStatistics, TermStatistics...)}
* @param context segment of the inverted index to be scored.
* @return ExactSimScorer for scoring documents across context
- * @throws IOException
+ * @throws IOException if there is a low-level I/O error
*/
public abstract ExactSimScorer exactSimScorer(SimWeight weight, AtomicReaderContext context) throws IOException;
@@ -188,7 +188,7 @@ public abstract class Similarity {
* @param weight collection information from {@link #computeWeight(float, CollectionStatistics, TermStatistics...)}
* @param context segment of the inverted index to be scored.
* @return SloppySimScorer for scoring documents across context
- * @throws IOException
+ * @throws IOException if there is a low-level I/O error
*/
public abstract SloppySimScorer sloppySimScorer(SimWeight weight, AtomicReaderContext context) throws IOException;
diff --git a/lucene/core/src/java/org/apache/lucene/search/spans/NearSpansOrdered.java b/lucene/core/src/java/org/apache/lucene/search/spans/NearSpansOrdered.java
index a5bc329949b..0559dc8d744 100644
--- a/lucene/core/src/java/org/apache/lucene/search/spans/NearSpansOrdered.java
+++ b/lucene/core/src/java/org/apache/lucene/search/spans/NearSpansOrdered.java
@@ -219,8 +219,6 @@ public class NearSpansOrdered extends Spans {
}
/** Check whether two Spans in the same document are ordered.
- * @param spans1
- * @param spans2
* @return true iff spans1 starts before spans2
* or the spans start at the same position,
* and spans1 ends before spans2.
diff --git a/lucene/core/src/java/org/apache/lucene/search/spans/NearSpansUnordered.java b/lucene/core/src/java/org/apache/lucene/search/spans/NearSpansUnordered.java
index 7279b049d22..42090c65db7 100644
--- a/lucene/core/src/java/org/apache/lucene/search/spans/NearSpansUnordered.java
+++ b/lucene/core/src/java/org/apache/lucene/search/spans/NearSpansUnordered.java
@@ -241,7 +241,7 @@ public class NearSpansUnordered extends Spans {
/**
* WARNING: The List is not necessarily in order of the the positions
* @return Collection of byte[] payloads
- * @throws IOException
+ * @throws IOException if there is a low-level I/O error
*/
@Override
public Collection getPayload() throws IOException {
diff --git a/lucene/core/src/java/org/apache/lucene/search/spans/Spans.java b/lucene/core/src/java/org/apache/lucene/search/spans/Spans.java
index 2e3c0ce2936..a774c60f081 100644
--- a/lucene/core/src/java/org/apache/lucene/search/spans/Spans.java
+++ b/lucene/core/src/java/org/apache/lucene/search/spans/Spans.java
@@ -69,7 +69,7 @@ public abstract class Spans {
* @lucene.experimental
*
* @return a List of byte arrays containing the data of this payload, otherwise null if isPayloadAvailable is false
- * @throws java.io.IOException
+ * @throws IOException if there is a low-level I/O error
*/
// TODO: Remove warning after API has been finalized
public abstract Collection getPayload() throws IOException;
diff --git a/lucene/core/src/java/org/apache/lucene/store/CompoundFileDirectory.java b/lucene/core/src/java/org/apache/lucene/store/CompoundFileDirectory.java
index 5a940cb146f..80a23d933d0 100644
--- a/lucene/core/src/java/org/apache/lucene/store/CompoundFileDirectory.java
+++ b/lucene/core/src/java/org/apache/lucene/store/CompoundFileDirectory.java
@@ -215,14 +215,14 @@ public final class CompoundFileDirectory extends Directory {
}
/** Not implemented
- * @throws UnsupportedOperationException */
+ * @throws UnsupportedOperationException always: not supported by CFS */
@Override
public void deleteFile(String name) {
throw new UnsupportedOperationException();
}
/** Not implemented
- * @throws UnsupportedOperationException */
+ * @throws UnsupportedOperationException always: not supported by CFS */
public void renameFile(String from, String to) {
throw new UnsupportedOperationException();
}
@@ -253,7 +253,7 @@ public final class CompoundFileDirectory extends Directory {
}
/** Not implemented
- * @throws UnsupportedOperationException */
+ * @throws UnsupportedOperationException always: not supported by CFS */
@Override
public Lock makeLock(String name) {
throw new UnsupportedOperationException();
diff --git a/lucene/core/src/java/org/apache/lucene/store/FSDirectory.java b/lucene/core/src/java/org/apache/lucene/store/FSDirectory.java
index 66bcb1daa9d..5c98c6a25f3 100644
--- a/lucene/core/src/java/org/apache/lucene/store/FSDirectory.java
+++ b/lucene/core/src/java/org/apache/lucene/store/FSDirectory.java
@@ -135,7 +135,7 @@ public abstract class FSDirectory extends Directory {
* @param path the path of the directory
* @param lockFactory the lock factory to use, or null for the default
* ({@link NativeFSLockFactory});
- * @throws IOException
+ * @throws IOException if there is a low-level I/O error
*/
protected FSDirectory(File path, LockFactory lockFactory) throws IOException {
// new ctors use always NativeFSLockFactory as default:
diff --git a/lucene/core/src/java/org/apache/lucene/store/MMapDirectory.java b/lucene/core/src/java/org/apache/lucene/store/MMapDirectory.java
index c1c7f5aa007..65c2d923cd6 100644
--- a/lucene/core/src/java/org/apache/lucene/store/MMapDirectory.java
+++ b/lucene/core/src/java/org/apache/lucene/store/MMapDirectory.java
@@ -90,7 +90,7 @@ public class MMapDirectory extends FSDirectory {
* @param path the path of the directory
* @param lockFactory the lock factory to use, or null for the default
* ({@link NativeFSLockFactory});
- * @throws IOException
+ * @throws IOException if there is a low-level I/O error
*/
public MMapDirectory(File path, LockFactory lockFactory) throws IOException {
this(path, lockFactory, DEFAULT_MAX_BUFF);
@@ -99,7 +99,7 @@ public class MMapDirectory extends FSDirectory {
/** Create a new MMapDirectory for the named location and {@link NativeFSLockFactory}.
*
* @param path the path of the directory
- * @throws IOException
+ * @throws IOException if there is a low-level I/O error
*/
public MMapDirectory(File path) throws IOException {
this(path, null);
@@ -123,7 +123,7 @@ public class MMapDirectory extends FSDirectory {
* be {@code 1 << 30}, as the address space is big enough.
*
* Please note: The chunk size is always rounded down to a power of 2.
- * @throws IOException
+ * @throws IOException if there is a low-level I/O error
*/
public MMapDirectory(File path, LockFactory lockFactory, int maxChunkSize) throws IOException {
super(path, lockFactory);
diff --git a/lucene/core/src/java/org/apache/lucene/store/NIOFSDirectory.java b/lucene/core/src/java/org/apache/lucene/store/NIOFSDirectory.java
index e7608858480..7fbc05bc6e9 100644
--- a/lucene/core/src/java/org/apache/lucene/store/NIOFSDirectory.java
+++ b/lucene/core/src/java/org/apache/lucene/store/NIOFSDirectory.java
@@ -58,7 +58,7 @@ public class NIOFSDirectory extends FSDirectory {
* @param path the path of the directory
* @param lockFactory the lock factory to use, or null for the default
* ({@link NativeFSLockFactory});
- * @throws IOException
+ * @throws IOException if there is a low-level I/O error
*/
public NIOFSDirectory(File path, LockFactory lockFactory) throws IOException {
super(path, lockFactory);
@@ -67,7 +67,7 @@ public class NIOFSDirectory extends FSDirectory {
/** Create a new NIOFSDirectory for the named location and {@link NativeFSLockFactory}.
*
* @param path the path of the directory
- * @throws IOException
+ * @throws IOException if there is a low-level I/O error
*/
public NIOFSDirectory(File path) throws IOException {
super(path, null);
diff --git a/lucene/core/src/java/org/apache/lucene/store/SimpleFSDirectory.java b/lucene/core/src/java/org/apache/lucene/store/SimpleFSDirectory.java
index dbcae612f2c..fe818da06f9 100644
--- a/lucene/core/src/java/org/apache/lucene/store/SimpleFSDirectory.java
+++ b/lucene/core/src/java/org/apache/lucene/store/SimpleFSDirectory.java
@@ -35,7 +35,7 @@ public class SimpleFSDirectory extends FSDirectory {
* @param path the path of the directory
* @param lockFactory the lock factory to use, or null for the default
* ({@link NativeFSLockFactory});
- * @throws IOException
+ * @throws IOException if there is a low-level I/O error
*/
public SimpleFSDirectory(File path, LockFactory lockFactory) throws IOException {
super(path, lockFactory);
@@ -44,7 +44,7 @@ public class SimpleFSDirectory extends FSDirectory {
/** Create a new SimpleFSDirectory for the named location and {@link NativeFSLockFactory}.
*
* @param path the path of the directory
- * @throws IOException
+ * @throws IOException if there is a low-level I/O error
*/
public SimpleFSDirectory(File path) throws IOException {
super(path, null);
diff --git a/lucene/core/src/java/org/apache/lucene/util/BytesRef.java b/lucene/core/src/java/org/apache/lucene/util/BytesRef.java
index 29ae3716b69..7877b6fb5df 100644
--- a/lucene/core/src/java/org/apache/lucene/util/BytesRef.java
+++ b/lucene/core/src/java/org/apache/lucene/util/BytesRef.java
@@ -262,7 +262,7 @@ public final class BytesRef implements Comparable,Cloneable {
}
}
- /** @deprecated */
+ /** @deprecated This comparator is only a transition mechanism */
@Deprecated
private final static Comparator utf8SortedAsUTF16SortOrder = new UTF8SortedAsUTF16Comparator();
@@ -272,7 +272,7 @@ public final class BytesRef implements Comparable,Cloneable {
return utf8SortedAsUTF16SortOrder;
}
- /** @deprecated */
+ /** @deprecated This comparator is only a transition mechanism */
@Deprecated
private static class UTF8SortedAsUTF16Comparator implements Comparator {
// Only singleton
diff --git a/lucene/core/src/java/org/apache/lucene/util/BytesRefIterator.java b/lucene/core/src/java/org/apache/lucene/util/BytesRefIterator.java
index 57d7df7e221..3e488f84f02 100644
--- a/lucene/core/src/java/org/apache/lucene/util/BytesRefIterator.java
+++ b/lucene/core/src/java/org/apache/lucene/util/BytesRefIterator.java
@@ -34,7 +34,7 @@ public interface BytesRefIterator {
*
* @return the next {@link BytesRef} in the iterator or null if
* the end of the iterator is reached.
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
public BytesRef next() throws IOException;
diff --git a/lucene/core/src/java/org/apache/lucene/util/CharsRef.java b/lucene/core/src/java/org/apache/lucene/util/CharsRef.java
index c1c129ea005..f874ac90f59 100644
--- a/lucene/core/src/java/org/apache/lucene/util/CharsRef.java
+++ b/lucene/core/src/java/org/apache/lucene/util/CharsRef.java
@@ -217,7 +217,7 @@ public final class CharsRef implements Comparable, CharSequence, Clone
return new CharsRef(chars, offset + start, offset + end);
}
- /** @deprecated */
+ /** @deprecated This comparator is only a transition mechanism */
@Deprecated
private final static Comparator utf16SortedAsUTF8SortOrder = new UTF16SortedAsUTF8Comparator();
@@ -227,7 +227,7 @@ public final class CharsRef implements Comparable, CharSequence, Clone
return utf16SortedAsUTF8SortOrder;
}
- /** @deprecated */
+ /** @deprecated This comparator is only a transition mechanism */
@Deprecated
private static class UTF16SortedAsUTF8Comparator implements Comparator {
// Only singleton
diff --git a/lucene/core/src/java/org/apache/lucene/util/CommandLineUtil.java b/lucene/core/src/java/org/apache/lucene/util/CommandLineUtil.java
index c628bc2813b..c8e5ef55e29 100644
--- a/lucene/core/src/java/org/apache/lucene/util/CommandLineUtil.java
+++ b/lucene/core/src/java/org/apache/lucene/util/CommandLineUtil.java
@@ -62,7 +62,7 @@ public final class CommandLineUtil {
* Loads a specific Directory implementation
* @param clazzName The name of the Directory class to load
* @return The Directory class loaded
- * @throws ClassNotFoundException
+ * @throws ClassNotFoundException If the specified class cannot be found.
*/
public static Class extends Directory> loadDirectoryClass(String clazzName)
throws ClassNotFoundException {
@@ -73,7 +73,7 @@ public final class CommandLineUtil {
* Loads a specific FSDirectory implementation
* @param clazzName The name of the FSDirectory class to load
* @return The FSDirectory class loaded
- * @throws ClassNotFoundException
+ * @throws ClassNotFoundException If the specified class cannot be found.
*/
public static Class extends FSDirectory> loadFSDirectoryClass(String clazzName)
throws ClassNotFoundException {
@@ -97,10 +97,10 @@ public final class CommandLineUtil {
* @param clazz The class of the object to be created
* @param file The file to be used as parameter constructor
* @return The new FSDirectory instance
- * @throws NoSuchMethodException
- * @throws InstantiationException
- * @throws IllegalAccessException
- * @throws InvocationTargetException
+ * @throws NoSuchMethodException If the Directory does not have a constructor that takes File.
+ * @throws InstantiationException If the class is abstract or an interface.
+ * @throws IllegalAccessException If the constructor does not have public visibility.
+ * @throws InvocationTargetException If the constructor throws an exception
*/
public static FSDirectory newFSDirectory(Class extends FSDirectory> clazz, File file)
throws NoSuchMethodException, InstantiationException, IllegalAccessException, InvocationTargetException {
diff --git a/lucene/core/src/java/org/apache/lucene/util/OpenBitSet.java b/lucene/core/src/java/org/apache/lucene/util/OpenBitSet.java
index ea232ad39b8..bc290dedd55 100644
--- a/lucene/core/src/java/org/apache/lucene/util/OpenBitSet.java
+++ b/lucene/core/src/java/org/apache/lucene/util/OpenBitSet.java
@@ -81,9 +81,7 @@ public class OpenBitSet extends DocIdSet implements Bits, Cloneable {
// Used only for assert:
private long numBits;
- /** Constructs an OpenBitSet large enough to hold numBits.
- *
- * @param numBits
+ /** Constructs an OpenBitSet large enough to hold numBits.
*/
public OpenBitSet(long numBits) {
this.numBits = numBits;
diff --git a/lucene/core/src/java/org/apache/lucene/util/packed/PackedInts.java b/lucene/core/src/java/org/apache/lucene/util/packed/PackedInts.java
index b17e0c354ef..08896475534 100644
--- a/lucene/core/src/java/org/apache/lucene/util/packed/PackedInts.java
+++ b/lucene/core/src/java/org/apache/lucene/util/packed/PackedInts.java
@@ -712,7 +712,7 @@ public class PackedInts {
* @param valueCount how many values the stream holds
* @param bitsPerValue the number of bits per value
* @return a Reader
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
* @see PackedInts#getWriterNoHeader(DataOutput, Format, int, int, int)
* @lucene.internal
*/
@@ -754,7 +754,7 @@ public class PackedInts {
*
* @param in the stream to read data from
* @return a Reader
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
* @lucene.internal
*/
public static Reader getReader(DataInput in) throws IOException {
@@ -846,7 +846,7 @@ public class PackedInts {
*
* @param in the stream to read data from
* @return a direct Reader
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
* @lucene.internal
*/
public static Reader getDirectReader(IndexInput in) throws IOException {
@@ -990,7 +990,7 @@ public class PackedInts {
* @param bitsPerValue the number of bits per value
* @param acceptableOverheadRatio an acceptable overhead ratio per value
* @return a Writer
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
* @lucene.internal
*/
public static Writer getWriter(DataOutput out,
diff --git a/lucene/core/src/test/org/apache/lucene/codecs/lucene40/TestBitVector.java b/lucene/core/src/test/org/apache/lucene/codecs/lucene40/TestBitVector.java
index 32080c145dd..f8e294c321c 100644
--- a/lucene/core/src/test/org/apache/lucene/codecs/lucene40/TestBitVector.java
+++ b/lucene/core/src/test/org/apache/lucene/codecs/lucene40/TestBitVector.java
@@ -33,7 +33,6 @@ public class TestBitVector extends LuceneTestCase
/**
* Test the default constructor on BitVectors of various sizes.
- * @throws Exception
*/
public void testConstructSize() throws Exception {
doTestConstructOfSize(8);
@@ -49,7 +48,6 @@ public class TestBitVector extends LuceneTestCase
/**
* Test the get() and set() methods on BitVectors of various sizes.
- * @throws Exception
*/
public void testGetSet() throws Exception {
doTestGetSetVectorOfSize(8);
@@ -70,7 +68,6 @@ public class TestBitVector extends LuceneTestCase
/**
* Test the clear() method on BitVectors of various sizes.
- * @throws Exception
*/
public void testClear() throws Exception {
doTestClearVectorOfSize(8);
@@ -93,7 +90,6 @@ public class TestBitVector extends LuceneTestCase
/**
* Test the count() method on BitVectors of various sizes.
- * @throws Exception
*/
public void testCount() throws Exception {
doTestCountVectorOfSize(8);
@@ -129,7 +125,6 @@ public class TestBitVector extends LuceneTestCase
/**
* Test writing and construction to/from Directory.
- * @throws Exception
*/
public void testWriteRead() throws Exception {
doTestWriteRead(8);
diff --git a/lucene/core/src/test/org/apache/lucene/index/TestCrashCausesCorruptIndex.java b/lucene/core/src/test/org/apache/lucene/index/TestCrashCausesCorruptIndex.java
index 821d0d54b4a..4cac7bb2769 100644
--- a/lucene/core/src/test/org/apache/lucene/index/TestCrashCausesCorruptIndex.java
+++ b/lucene/core/src/test/org/apache/lucene/index/TestCrashCausesCorruptIndex.java
@@ -41,8 +41,6 @@ public class TestCrashCausesCorruptIndex extends LuceneTestCase {
/**
* LUCENE-3627: This test fails.
- *
- * @throws Exception
*/
public void testCrashCorruptsIndexing() throws Exception {
path = _TestUtil.getTempDir("testCrashCorruptsIndexing");
@@ -60,8 +58,6 @@ public class TestCrashCausesCorruptIndex extends LuceneTestCase {
* index 1 document and commit.
* prepare for crashing.
* index 1 more document, and upon commit, creation of segments_2 will crash.
- *
- * @throws IOException
*/
private void indexAndCrashOnCreateOutputSegments2() throws IOException {
Directory realDirectory = FSDirectory.open(path);
@@ -93,8 +89,6 @@ public class TestCrashCausesCorruptIndex extends LuceneTestCase {
/**
* Attempts to index another 1 document.
- *
- * @throws IOException
*/
private void indexAfterRestart() throws IOException {
Directory realDirectory = newFSDirectory(path);
@@ -115,8 +109,6 @@ public class TestCrashCausesCorruptIndex extends LuceneTestCase {
/**
* Run an example search.
- *
- * @throws IOException
*/
private void searchForFleas(final int expectedTotalHits) throws IOException {
Directory realDirectory = newFSDirectory(path);
diff --git a/lucene/core/src/test/org/apache/lucene/index/TestIndexWriter.java b/lucene/core/src/test/org/apache/lucene/index/TestIndexWriter.java
index 213ff9fd021..a7402fee9bf 100644
--- a/lucene/core/src/test/org/apache/lucene/index/TestIndexWriter.java
+++ b/lucene/core/src/test/org/apache/lucene/index/TestIndexWriter.java
@@ -644,8 +644,6 @@ public class TestIndexWriter extends LuceneTestCase {
* Test that no NullPointerException will be raised,
* when adding one document with a single, empty field
* and term vectors enabled.
- * @throws IOException
- *
*/
public void testBadSegment() throws IOException {
Directory dir = newDirectory();
diff --git a/lucene/core/src/test/org/apache/lucene/index/TestIndexWriterReader.java b/lucene/core/src/test/org/apache/lucene/index/TestIndexWriterReader.java
index 43c31f4bef4..02897e363ed 100644
--- a/lucene/core/src/test/org/apache/lucene/index/TestIndexWriterReader.java
+++ b/lucene/core/src/test/org/apache/lucene/index/TestIndexWriterReader.java
@@ -223,8 +223,6 @@ public class TestIndexWriterReader extends LuceneTestCase {
/**
* Test using IW.addIndexes
- *
- * @throws Exception
*/
public void testAddIndexes() throws Exception {
boolean doFullMerge = false;
@@ -310,8 +308,6 @@ public class TestIndexWriterReader extends LuceneTestCase {
/**
* Deletes using IW.deleteDocuments
- *
- * @throws Exception
*/
public void testDeleteFromIndexWriter() throws Exception {
boolean doFullMerge = true;
diff --git a/lucene/core/src/test/org/apache/lucene/index/TestIsCurrent.java b/lucene/core/src/test/org/apache/lucene/index/TestIsCurrent.java
index 901b557d2db..d9421967368 100644
--- a/lucene/core/src/test/org/apache/lucene/index/TestIsCurrent.java
+++ b/lucene/core/src/test/org/apache/lucene/index/TestIsCurrent.java
@@ -56,8 +56,6 @@ public class TestIsCurrent extends LuceneTestCase {
/**
* Failing testcase showing the trouble
- *
- * @throws IOException
*/
@Test
public void testDeleteByTermIsCurrent() throws IOException {
@@ -83,8 +81,6 @@ public class TestIsCurrent extends LuceneTestCase {
/**
* Testcase for example to show that writer.deleteAll() is working as expected
- *
- * @throws IOException
*/
@Test
public void testDeleteAllIsCurrent() throws IOException {
diff --git a/lucene/core/src/test/org/apache/lucene/index/TestParallelReaderEmptyIndex.java b/lucene/core/src/test/org/apache/lucene/index/TestParallelReaderEmptyIndex.java
index 564191640c0..460d9d3b76e 100644
--- a/lucene/core/src/test/org/apache/lucene/index/TestParallelReaderEmptyIndex.java
+++ b/lucene/core/src/test/org/apache/lucene/index/TestParallelReaderEmptyIndex.java
@@ -36,8 +36,6 @@ public class TestParallelReaderEmptyIndex extends LuceneTestCase {
/**
* Creates two empty indexes and wraps a ParallelReader around. Adding this
* reader to a new index should not throw any exception.
- *
- * @throws IOException
*/
public void testEmptyIndex() throws IOException {
Directory rd1 = newDirectory();
diff --git a/lucene/core/src/test/org/apache/lucene/search/TestBooleanOr.java b/lucene/core/src/test/org/apache/lucene/search/TestBooleanOr.java
index 83da2f6497c..22e29b72d1c 100644
--- a/lucene/core/src/test/org/apache/lucene/search/TestBooleanOr.java
+++ b/lucene/core/src/test/org/apache/lucene/search/TestBooleanOr.java
@@ -59,8 +59,6 @@ public class TestBooleanOr extends LuceneTestCase {
/**
* T:files T:deleting C:production C:optimize
* it works.
- *
- * @throws IOException
*/
public void testFlat() throws IOException {
BooleanQuery q = new BooleanQuery();
@@ -74,8 +72,6 @@ public class TestBooleanOr extends LuceneTestCase {
/**
* (T:files T:deleting) (+C:production +C:optimize)
* it works.
- *
- * @throws IOException
*/
public void testParenthesisMust() throws IOException {
BooleanQuery q3 = new BooleanQuery();
@@ -93,8 +89,6 @@ public class TestBooleanOr extends LuceneTestCase {
/**
* (T:files T:deleting) +(C:production C:optimize)
* not working. results NO HIT.
- *
- * @throws IOException
*/
public void testParenthesisMust2() throws IOException {
BooleanQuery q3 = new BooleanQuery();
@@ -112,8 +106,6 @@ public class TestBooleanOr extends LuceneTestCase {
/**
* (T:files T:deleting) (C:production C:optimize)
* not working. results NO HIT.
- *
- * @throws IOException
*/
public void testParenthesisShould() throws IOException {
BooleanQuery q3 = new BooleanQuery();
diff --git a/lucene/core/src/test/org/apache/lucene/search/TestCustomSearcherSort.java b/lucene/core/src/test/org/apache/lucene/search/TestCustomSearcherSort.java
index 39850c26f00..3c872a5981e 100644
--- a/lucene/core/src/test/org/apache/lucene/search/TestCustomSearcherSort.java
+++ b/lucene/core/src/test/org/apache/lucene/search/TestCustomSearcherSort.java
@@ -152,8 +152,6 @@ public class TestCustomSearcherSort extends LuceneTestCase {
/**
* Check the hits for duplicates.
- *
- * @param hits
*/
private void checkHits(ScoreDoc[] hits, String prefix) {
if (hits != null) {
@@ -186,9 +184,6 @@ public class TestCustomSearcherSort extends LuceneTestCase {
public class CustomSearcher extends IndexSearcher {
private int switcher;
- /**
- * @param r
- */
public CustomSearcher(IndexReader r, int switcher) {
super(r);
this.switcher = switcher;
diff --git a/lucene/core/src/test/org/apache/lucene/search/TestWildcard.java b/lucene/core/src/test/org/apache/lucene/search/TestWildcard.java
index 3c53c053ca2..233c395c62d 100644
--- a/lucene/core/src/test/org/apache/lucene/search/TestWildcard.java
+++ b/lucene/core/src/test/org/apache/lucene/search/TestWildcard.java
@@ -269,7 +269,6 @@ public class TestWildcard
* This test looks at both parsing and execution of wildcard queries.
* Although placed here, it also tests prefix queries, verifying that
* prefix queries are not parsed into wild card queries, and viceversa.
- * @throws Exception
*/
public void testParsingAndSearching() throws Exception {
String field = "content";
diff --git a/lucene/core/src/test/org/apache/lucene/search/payloads/PayloadHelper.java b/lucene/core/src/test/org/apache/lucene/search/payloads/PayloadHelper.java
index a8749dbbd5b..8778bd93559 100644
--- a/lucene/core/src/test/org/apache/lucene/search/payloads/PayloadHelper.java
+++ b/lucene/core/src/test/org/apache/lucene/search/payloads/PayloadHelper.java
@@ -113,7 +113,6 @@ public class PayloadHelper {
* @param similarity The Similarity class to use in the Searcher
* @param numDocs The num docs to add
* @return An IndexSearcher
- * @throws IOException
*/
// TODO: randomize
public IndexSearcher setUp(Random random, Similarity similarity, int numDocs) throws IOException {
diff --git a/lucene/core/src/test/org/apache/lucene/search/spans/TestSpansAdvanced.java b/lucene/core/src/test/org/apache/lucene/search/spans/TestSpansAdvanced.java
index 1431422c3af..0d1c0494f0d 100644
--- a/lucene/core/src/test/org/apache/lucene/search/spans/TestSpansAdvanced.java
+++ b/lucene/core/src/test/org/apache/lucene/search/spans/TestSpansAdvanced.java
@@ -86,7 +86,6 @@ public class TestSpansAdvanced extends LuceneTestCase {
* @param writer the Lucene index writer
* @param id the unique id of the document
* @param text the text of the document
- * @throws IOException
*/
protected void addDocument(final RandomIndexWriter writer, final String id,
final String text) throws IOException {
@@ -99,8 +98,6 @@ public class TestSpansAdvanced extends LuceneTestCase {
/**
* Tests two span queries.
- *
- * @throws IOException
*/
public void testBooleanQueryWithSpanQueries() throws IOException {
@@ -109,8 +106,6 @@ public class TestSpansAdvanced extends LuceneTestCase {
/**
* Tests two span queries.
- *
- * @throws IOException
*/
protected void doTestBooleanQueryWithSpanQueries(IndexSearcher s,
final float expectedScore) throws IOException {
@@ -132,8 +127,6 @@ public class TestSpansAdvanced extends LuceneTestCase {
* @param description the description of the search
* @param expectedIds the expected document ids of the hits
* @param expectedScores the expected scores of the hits
- *
- * @throws IOException
*/
protected static void assertHits(IndexSearcher s, Query query,
final String description, final String[] expectedIds,
diff --git a/lucene/core/src/test/org/apache/lucene/search/spans/TestSpansAdvanced2.java b/lucene/core/src/test/org/apache/lucene/search/spans/TestSpansAdvanced2.java
index 584be01bae1..1a3c1ca641d 100644
--- a/lucene/core/src/test/org/apache/lucene/search/spans/TestSpansAdvanced2.java
+++ b/lucene/core/src/test/org/apache/lucene/search/spans/TestSpansAdvanced2.java
@@ -72,8 +72,6 @@ public class TestSpansAdvanced2 extends TestSpansAdvanced {
/**
* Verifies that the index has the correct number of documents.
- *
- * @throws Exception
*/
public void testVerifyIndex() throws Exception {
final IndexReader reader = DirectoryReader.open(mDirectory);
@@ -83,8 +81,6 @@ public class TestSpansAdvanced2 extends TestSpansAdvanced {
/**
* Tests a single span query that matches multiple documents.
- *
- * @throws IOException
*/
public void testSingleSpanQuery() throws IOException {
@@ -99,8 +95,6 @@ public class TestSpansAdvanced2 extends TestSpansAdvanced {
/**
* Tests a single span query that matches multiple documents.
- *
- * @throws IOException
*/
public void testMultipleDifferentSpanQueries() throws IOException {
@@ -119,8 +113,6 @@ public class TestSpansAdvanced2 extends TestSpansAdvanced {
/**
* Tests two span queries.
- *
- * @throws IOException
*/
@Override
public void testBooleanQueryWithSpanQueries() throws IOException {
diff --git a/lucene/core/src/test/org/apache/lucene/store/TestFileSwitchDirectory.java b/lucene/core/src/test/org/apache/lucene/store/TestFileSwitchDirectory.java
index 32ecf12db5e..662fd7d41c2 100644
--- a/lucene/core/src/test/org/apache/lucene/store/TestFileSwitchDirectory.java
+++ b/lucene/core/src/test/org/apache/lucene/store/TestFileSwitchDirectory.java
@@ -37,7 +37,6 @@ import org.apache.lucene.util._TestUtil;
public class TestFileSwitchDirectory extends LuceneTestCase {
/**
* Test if writing doc stores to disk and everything else to ram works.
- * @throws IOException
*/
public void testBasic() throws IOException {
Set fileExtensions = new HashSet();
diff --git a/lucene/demo/src/java/org/apache/lucene/demo/IndexFiles.java b/lucene/demo/src/java/org/apache/lucene/demo/IndexFiles.java
index 6f344469002..a4abadc21b8 100644
--- a/lucene/demo/src/java/org/apache/lucene/demo/IndexFiles.java
+++ b/lucene/demo/src/java/org/apache/lucene/demo/IndexFiles.java
@@ -140,7 +140,7 @@ public class IndexFiles {
*
* @param writer Writer to the index where the given file/dir info will be stored
* @param file The file to index, or the directory to recurse into to find files to index
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
static void indexDocs(IndexWriter writer, File file)
throws IOException {
diff --git a/lucene/facet/src/java/org/apache/lucene/facet/enhancements/EnhancementsDocumentBuilder.java b/lucene/facet/src/java/org/apache/lucene/facet/enhancements/EnhancementsDocumentBuilder.java
index c8ca0286640..9e64e7f4d3b 100644
--- a/lucene/facet/src/java/org/apache/lucene/facet/enhancements/EnhancementsDocumentBuilder.java
+++ b/lucene/facet/src/java/org/apache/lucene/facet/enhancements/EnhancementsDocumentBuilder.java
@@ -43,7 +43,6 @@ import org.apache.lucene.facet.taxonomy.TaxonomyWriter;
public class EnhancementsDocumentBuilder extends CategoryDocumentBuilder {
/**
- * @param taxonomyWriter
* @param params
* Indexing params which include {@link CategoryEnhancement}s.
*/
diff --git a/lucene/facet/src/java/org/apache/lucene/facet/enhancements/EnhancementsPayloadIterator.java b/lucene/facet/src/java/org/apache/lucene/facet/enhancements/EnhancementsPayloadIterator.java
index cb4c129920b..28b8857bdd8 100644
--- a/lucene/facet/src/java/org/apache/lucene/facet/enhancements/EnhancementsPayloadIterator.java
+++ b/lucene/facet/src/java/org/apache/lucene/facet/enhancements/EnhancementsPayloadIterator.java
@@ -50,7 +50,7 @@ public class EnhancementsPayloadIterator extends PayloadIterator {
* A reader of the index.
* @param term
* The category term to iterate.
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
public EnhancementsPayloadIterator(
List enhancementsList,
diff --git a/lucene/facet/src/java/org/apache/lucene/facet/index/CategoryContainer.java b/lucene/facet/src/java/org/apache/lucene/facet/index/CategoryContainer.java
index 803411b75b0..22a9ea520fa 100644
--- a/lucene/facet/src/java/org/apache/lucene/facet/index/CategoryContainer.java
+++ b/lucene/facet/src/java/org/apache/lucene/facet/index/CategoryContainer.java
@@ -204,7 +204,7 @@ public class CategoryContainer implements Iterable, Serializa
* {@link ObjectOutputStream}.
* NOTE: {@link CategoryProperty}s are {@link Serializable}, but do not
* assume that Lucene's {@link Attribute}s are as well
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
protected void serializeCategoryAttribute(ObjectOutputStream out,
CategoryAttribute ca) throws IOException {
diff --git a/lucene/facet/src/java/org/apache/lucene/facet/index/CategoryDocumentBuilder.java b/lucene/facet/src/java/org/apache/lucene/facet/index/CategoryDocumentBuilder.java
index f67cd72a1b7..cedb4f919f9 100644
--- a/lucene/facet/src/java/org/apache/lucene/facet/index/CategoryDocumentBuilder.java
+++ b/lucene/facet/src/java/org/apache/lucene/facet/index/CategoryDocumentBuilder.java
@@ -128,7 +128,7 @@ public class CategoryDocumentBuilder {
* @return This CategoryDocumentBuilder, to enable this one line call:
* {@code new} {@link #CategoryDocumentBuilder(TaxonomyWriter)}.
* {@link #setCategoryPaths(Iterable)}.{@link #build(Document)}.
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
public CategoryDocumentBuilder setCategoryPaths(
Iterable categoryPaths) throws IOException {
@@ -150,7 +150,7 @@ public class CategoryDocumentBuilder {
* @return This CategoryDocumentBuilder, to enable this one line call:
* {@code new} {@link #CategoryDocumentBuilder(TaxonomyWriter)}.
* {@link #setCategories(Iterable)}.{@link #build(Document)}.
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
public CategoryDocumentBuilder setCategories(
Iterable categories) throws IOException {
@@ -277,7 +277,7 @@ public class CategoryDocumentBuilder {
* relevant data.
* @return The {@link CategoryTokenizer} to be used in creating category
* tokens.
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
protected CategoryTokenizer getCategoryTokenizer(TokenStream categoryStream)
throws IOException {
diff --git a/lucene/facet/src/java/org/apache/lucene/facet/index/params/PerDimensionIndexingParams.java b/lucene/facet/src/java/org/apache/lucene/facet/index/params/PerDimensionIndexingParams.java
index 433bc3086b6..1f657d840e2 100644
--- a/lucene/facet/src/java/org/apache/lucene/facet/index/params/PerDimensionIndexingParams.java
+++ b/lucene/facet/src/java/org/apache/lucene/facet/index/params/PerDimensionIndexingParams.java
@@ -95,9 +95,6 @@ public class PerDimensionIndexingParams extends DefaultFacetIndexingParams {
/**
* Add a CategoryListParams for a given CategoryPath's dimension or
* "zero-th" category.
- *
- * @param category
- * @param clParams
*/
public void addCategoryListParams(CategoryPath category, CategoryListParams clParams) {
clParamsMap.put(category.getComponent(0), clParams);
diff --git a/lucene/facet/src/java/org/apache/lucene/facet/search/FacetsAccumulator.java b/lucene/facet/src/java/org/apache/lucene/facet/search/FacetsAccumulator.java
index 9172ae7ae32..f0bfa00baae 100644
--- a/lucene/facet/src/java/org/apache/lucene/facet/search/FacetsAccumulator.java
+++ b/lucene/facet/src/java/org/apache/lucene/facet/search/FacetsAccumulator.java
@@ -81,7 +81,7 @@ public abstract class FacetsAccumulator {
public abstract List accumulate(ScoredDocIDs docids) throws IOException;
/**
- * @return the complement threshold
+ * Returns the complement threshold.
* @see #setComplementThreshold(double)
*/
public double getComplementThreshold() {
@@ -107,6 +107,7 @@ public abstract class FacetsAccumulator {
*
* To disable complements pass {@link #DISABLE_COMPLEMENT}.
* @param complementThreshold the complement threshold to set
+ * @see #getComplementThreshold()
*/
public void setComplementThreshold(double complementThreshold) {
this.complementThreshold = complementThreshold;
diff --git a/lucene/facet/src/java/org/apache/lucene/facet/search/SamplingWrapper.java b/lucene/facet/src/java/org/apache/lucene/facet/search/SamplingWrapper.java
index dc93f38cbe7..6578f94c8b8 100644
--- a/lucene/facet/src/java/org/apache/lucene/facet/search/SamplingWrapper.java
+++ b/lucene/facet/src/java/org/apache/lucene/facet/search/SamplingWrapper.java
@@ -88,18 +88,11 @@ public class SamplingWrapper extends FacetsAccumulator {
return fixedRes;
}
- /**
- * @see FacetsAccumulator#getComplementThreshold()
- */
@Override
public double getComplementThreshold() {
return delegee.getComplementThreshold();
}
- /**
- * @param complementThreshold
- * @see FacetsAccumulator#setComplementThreshold(double)
- */
@Override
public void setComplementThreshold(double complementThreshold) {
delegee.setComplementThreshold(complementThreshold);
diff --git a/lucene/facet/src/java/org/apache/lucene/facet/search/StandardFacetsAccumulator.java b/lucene/facet/src/java/org/apache/lucene/facet/search/StandardFacetsAccumulator.java
index 66d1200899a..2df0975cce0 100644
--- a/lucene/facet/src/java/org/apache/lucene/facet/search/StandardFacetsAccumulator.java
+++ b/lucene/facet/src/java/org/apache/lucene/facet/search/StandardFacetsAccumulator.java
@@ -230,10 +230,7 @@ public class StandardFacetsAccumulator extends FacetsAccumulator {
/**
* Iterate over the documents for this partition and fill the facet arrays with the correct
* count/complement count/value.
- * @param docids
- * @param facetArrays
- * @param partition
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
private final void fillArraysForPartition(ScoredDocIDs docids,
FacetArrays facetArrays, int partition) throws IOException {
diff --git a/lucene/facet/src/java/org/apache/lucene/facet/search/params/FacetRequest.java b/lucene/facet/src/java/org/apache/lucene/facet/search/params/FacetRequest.java
index 297865027f5..7162968f232 100644
--- a/lucene/facet/src/java/org/apache/lucene/facet/search/params/FacetRequest.java
+++ b/lucene/facet/src/java/org/apache/lucene/facet/search/params/FacetRequest.java
@@ -318,7 +318,7 @@ public abstract class FacetRequest implements Cloneable {
* index reader in effect.
* @param taxonomy
* reader of taxonomy in effect.
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
public abstract Aggregator createAggregator(boolean useComplements,
FacetArrays arrays, IndexReader indexReader,
diff --git a/lucene/facet/src/java/org/apache/lucene/facet/search/sampling/SampleFixer.java b/lucene/facet/src/java/org/apache/lucene/facet/search/sampling/SampleFixer.java
index 24735ad1fd0..5b992d3b244 100644
--- a/lucene/facet/src/java/org/apache/lucene/facet/search/sampling/SampleFixer.java
+++ b/lucene/facet/src/java/org/apache/lucene/facet/search/sampling/SampleFixer.java
@@ -38,7 +38,7 @@ public interface SampleFixer {
* full set of matching documents.
* @param fres
* sample result to be fixed.
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
public void fixResult(ScoredDocIDs origDocIds, FacetResult fres) throws IOException;
}
\ No newline at end of file
diff --git a/lucene/facet/src/java/org/apache/lucene/facet/search/sampling/TakmiSampleFixer.java b/lucene/facet/src/java/org/apache/lucene/facet/search/sampling/TakmiSampleFixer.java
index 2f214d3fc73..5a8106d246d 100644
--- a/lucene/facet/src/java/org/apache/lucene/facet/search/sampling/TakmiSampleFixer.java
+++ b/lucene/facet/src/java/org/apache/lucene/facet/search/sampling/TakmiSampleFixer.java
@@ -71,7 +71,7 @@ class TakmiSampleFixer implements SampleFixer {
* result node to be fixed
* @param docIds
* docids in effect
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
private void fixResultNode(FacetResultNode facetResNode, ScoredDocIDs docIds)
throws IOException {
@@ -88,7 +88,7 @@ class TakmiSampleFixer implements SampleFixer {
* result node to be recounted
* @param docIds
* full set of matching documents.
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
private void recount(FacetResultNode fresNode, ScoredDocIDs docIds)
throws IOException {
diff --git a/lucene/facet/src/java/org/apache/lucene/facet/taxonomy/TaxonomyReader.java b/lucene/facet/src/java/org/apache/lucene/facet/taxonomy/TaxonomyReader.java
index f39a0439be8..78d55af5424 100644
--- a/lucene/facet/src/java/org/apache/lucene/facet/taxonomy/TaxonomyReader.java
+++ b/lucene/facet/src/java/org/apache/lucene/facet/taxonomy/TaxonomyReader.java
@@ -257,7 +257,7 @@ public interface TaxonomyReader extends Closeable {
* Expert: decreases the refCount of this TaxonomyReader instance.
* If the refCount drops to 0, then pending changes (if any) can be
* committed to the taxonomy index and this reader can be closed.
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
public void decRef() throws IOException;
diff --git a/lucene/facet/src/java/org/apache/lucene/util/collections/FloatToObjectMap.java b/lucene/facet/src/java/org/apache/lucene/util/collections/FloatToObjectMap.java
index 2d9647df34d..9b321c13b9a 100644
--- a/lucene/facet/src/java/org/apache/lucene/util/collections/FloatToObjectMap.java
+++ b/lucene/facet/src/java/org/apache/lucene/util/collections/FloatToObjectMap.java
@@ -275,7 +275,6 @@ public class FloatToObjectMap implements Iterable {
/**
* Calculating the baseHash index using the internal hashFactor.
- * @param key
*/
protected int calcBaseHashIndex(float key) {
return Float.floatToIntBits(key) & hashFactor;
@@ -339,7 +338,6 @@ public class FloatToObjectMap implements Iterable {
/**
* Find the actual index of a given key.
*
- * @param key
* @return index of the key. zero if the key wasn't found.
*/
protected int find(float key) {
@@ -370,8 +368,6 @@ public class FloatToObjectMap implements Iterable {
* Some methods use the baseHashIndex. If those call {@link #find} there's
* no need to re-calculate that hash.
*
- * @param key
- * @param baseHashIndex
* @return the index of the given key, or 0 as 'Ground' if the key wasn't
* found.
*/
diff --git a/lucene/facet/src/java/org/apache/lucene/util/collections/IntHashSet.java b/lucene/facet/src/java/org/apache/lucene/util/collections/IntHashSet.java
index adf468a4efe..d2bf0bf6fd0 100644
--- a/lucene/facet/src/java/org/apache/lucene/util/collections/IntHashSet.java
+++ b/lucene/facet/src/java/org/apache/lucene/util/collections/IntHashSet.java
@@ -236,8 +236,6 @@ public class IntHashSet {
/**
* Calculating the baseHash index using the internal hashFactor
* .
- *
- * @param key
*/
protected int calcBaseHashIndex(int key) {
return key & hashFactor;
@@ -282,7 +280,6 @@ public class IntHashSet {
/**
* Find the actual index of a given key.
*
- * @param key
* @return index of the key. zero if the key wasn't found.
*/
protected int find(int key) {
@@ -313,8 +310,6 @@ public class IntHashSet {
* Some methods use the baseHashIndex. If those call {@link #find} there's
* no need to re-calculate that hash.
*
- * @param key
- * @param baseHashIndex
* @return the index of the given key, or 0 as 'Ground' if the key wasn't
* found.
*/
diff --git a/lucene/facet/src/java/org/apache/lucene/util/collections/IntToDoubleMap.java b/lucene/facet/src/java/org/apache/lucene/util/collections/IntToDoubleMap.java
index ada9dc3eba7..ed4114bf60f 100644
--- a/lucene/facet/src/java/org/apache/lucene/util/collections/IntToDoubleMap.java
+++ b/lucene/facet/src/java/org/apache/lucene/util/collections/IntToDoubleMap.java
@@ -276,8 +276,6 @@ public class IntToDoubleMap {
/**
* Calculating the baseHash index using the internal hashFactor
* .
- *
- * @param key
*/
protected int calcBaseHashIndex(int key) {
return key & hashFactor;
@@ -340,7 +338,6 @@ public class IntToDoubleMap {
/**
* Find the actual index of a given key.
*
- * @param key
* @return index of the key. zero if the key wasn't found.
*/
protected int find(int key) {
@@ -371,8 +368,6 @@ public class IntToDoubleMap {
* Some methods use the baseHashIndex. If those call {@link #find} there's
* no need to re-calculate that hash.
*
- * @param key
- * @param baseHashIndex
* @return the index of the given key, or 0 as 'Ground' if the key wasn't
* found.
*/
diff --git a/lucene/facet/src/java/org/apache/lucene/util/collections/IntToIntMap.java b/lucene/facet/src/java/org/apache/lucene/util/collections/IntToIntMap.java
index e926da1b3d7..265683cdec9 100644
--- a/lucene/facet/src/java/org/apache/lucene/util/collections/IntToIntMap.java
+++ b/lucene/facet/src/java/org/apache/lucene/util/collections/IntToIntMap.java
@@ -273,8 +273,6 @@ public class IntToIntMap {
/**
* Calculating the baseHash index using the internal hashFactor.
- *
- * @param key
*/
protected int calcBaseHashIndex(int key) {
return key & hashFactor;
@@ -337,7 +335,6 @@ public class IntToIntMap {
/**
* Find the actual index of a given key.
*
- * @param key
* @return index of the key. zero if the key wasn't found.
*/
protected int find(int key) {
@@ -368,8 +365,6 @@ public class IntToIntMap {
* Some methods use the baseHashIndex. If those call {@link #find} there's
* no need to re-calculate that hash.
*
- * @param key
- * @param baseHashIndex
* @return the index of the given key, or 0 as 'Ground' if the key wasn't
* found.
*/
diff --git a/lucene/facet/src/java/org/apache/lucene/util/collections/IntToObjectMap.java b/lucene/facet/src/java/org/apache/lucene/util/collections/IntToObjectMap.java
index 657c894d278..2acfaecc9a9 100644
--- a/lucene/facet/src/java/org/apache/lucene/util/collections/IntToObjectMap.java
+++ b/lucene/facet/src/java/org/apache/lucene/util/collections/IntToObjectMap.java
@@ -275,7 +275,6 @@ public class IntToObjectMap implements Iterable {
/**
* Calculating the baseHash index using the internal hashFactor.
*
- * @param key
*/
protected int calcBaseHashIndex(int key) {
return key & hashFactor;
@@ -339,7 +338,6 @@ public class IntToObjectMap implements Iterable {
/**
* Find the actual index of a given key.
*
- * @param key
* @return index of the key. zero if the key wasn't found.
*/
protected int find(int key) {
@@ -370,8 +368,6 @@ public class IntToObjectMap implements Iterable {
* Some methods use the baseHashIndex. If those call {@link #find} there's
* no need to re-calculate that hash.
*
- * @param key
- * @param baseHashIndex
* @return the index of the given key, or 0 as 'Ground' if the key wasn't
* found.
*/
diff --git a/lucene/facet/src/java/org/apache/lucene/util/collections/ObjectToFloatMap.java b/lucene/facet/src/java/org/apache/lucene/util/collections/ObjectToFloatMap.java
index 9b8039bcbba..bc80575a3b7 100644
--- a/lucene/facet/src/java/org/apache/lucene/util/collections/ObjectToFloatMap.java
+++ b/lucene/facet/src/java/org/apache/lucene/util/collections/ObjectToFloatMap.java
@@ -275,8 +275,6 @@ public class ObjectToFloatMap {
/**
* Calculating the baseHash index using the internal hashFactor.
- *
- * @param key
*/
protected int calcBaseHashIndex(K key) {
return key.hashCode() & hashFactor;
@@ -341,7 +339,6 @@ public class ObjectToFloatMap {
/**
* Find the actual index of a given key.
*
- * @param key
* @return index of the key. zero if the key wasn't found.
*/
protected int find(K key) {
@@ -372,8 +369,6 @@ public class ObjectToFloatMap {
* Some methods use the baseHashIndex. If those call {@link #find} there's
* no need to re-calculate that hash.
*
- * @param key
- * @param baseHashIndex
* @return the index of the given key, or 0 as 'Ground' if the key wasn't
* found.
*/
diff --git a/lucene/facet/src/java/org/apache/lucene/util/collections/ObjectToIntMap.java b/lucene/facet/src/java/org/apache/lucene/util/collections/ObjectToIntMap.java
index 9d3e2c22974..be927e4c63d 100644
--- a/lucene/facet/src/java/org/apache/lucene/util/collections/ObjectToIntMap.java
+++ b/lucene/facet/src/java/org/apache/lucene/util/collections/ObjectToIntMap.java
@@ -275,8 +275,6 @@ public class ObjectToIntMap {
/**
* Calculating the baseHash index using the internal hashFactor.
- *
- * @param key
*/
protected int calcBaseHashIndex(K key) {
return key.hashCode() & hashFactor;
@@ -341,7 +339,6 @@ public class ObjectToIntMap {
/**
* Find the actual index of a given key.
*
- * @param key
* @return index of the key. zero if the key wasn't found.
*/
protected int find(K key) {
@@ -372,8 +369,6 @@ public class ObjectToIntMap {
* Some methods use the baseHashIndex. If those call {@link #find} there's
* no need to re-calculate that hash.
*
- * @param key
- * @param baseHashIndex
* @return the index of the given key, or 0 as 'Ground' if the key wasn't
* found.
*/
diff --git a/lucene/facet/src/test/org/apache/lucene/facet/index/CategoryContainerTest.java b/lucene/facet/src/test/org/apache/lucene/facet/index/CategoryContainerTest.java
index dfced81bb33..ec8a5de5a2d 100644
--- a/lucene/facet/src/test/org/apache/lucene/facet/index/CategoryContainerTest.java
+++ b/lucene/facet/src/test/org/apache/lucene/facet/index/CategoryContainerTest.java
@@ -133,8 +133,6 @@ public class CategoryContainerTest extends CategoryContainerTestBase {
/**
* Test addition of {@link CategoryAttribute} object without properties to a
* {@link CategoryContainer}.
- *
- * @throws FacetException
*/
@Test
public void testAddCategoryAttributeWithoutProperties()
@@ -147,8 +145,6 @@ public class CategoryContainerTest extends CategoryContainerTestBase {
/**
* Test addition of {@link CategoryAttribute} object with property to a
* {@link CategoryContainer}.
- *
- * @throws FacetException
*/
@Test
public void testAddCategoryAttributeWithProperty() throws FacetException {
@@ -174,8 +170,6 @@ public class CategoryContainerTest extends CategoryContainerTestBase {
/**
* Verifies that a {@link CategoryAttributesStream} can be constructed from
* {@link CategoryContainer} and produce the correct number of tokens.
- *
- * @throws IOException
*/
@Test
public void testCategoryAttributesStream() throws IOException {
@@ -190,8 +184,6 @@ public class CategoryContainerTest extends CategoryContainerTestBase {
/**
* Test that {@link CategoryContainer} merges properties.
- *
- * @throws FacetException
*/
@Test
public void testCategoryAttributeMerge() throws FacetException {
diff --git a/lucene/facet/src/test/org/apache/lucene/facet/index/streaming/CategoryAttributesStreamTest.java b/lucene/facet/src/test/org/apache/lucene/facet/index/streaming/CategoryAttributesStreamTest.java
index bfdc631bebd..b74a8be01d0 100644
--- a/lucene/facet/src/test/org/apache/lucene/facet/index/streaming/CategoryAttributesStreamTest.java
+++ b/lucene/facet/src/test/org/apache/lucene/facet/index/streaming/CategoryAttributesStreamTest.java
@@ -35,8 +35,6 @@ public class CategoryAttributesStreamTest extends CategoryContainerTestBase {
/**
* Verifies that a {@link CategoryAttributesStream} accepts
* {@link CategoryAttribute} and passes them on as tokens.
- *
- * @throws IOException
*/
@Test
public void testStream() throws IOException {
diff --git a/lucene/facet/src/test/org/apache/lucene/facet/index/streaming/CategoryParentsStreamTest.java b/lucene/facet/src/test/org/apache/lucene/facet/index/streaming/CategoryParentsStreamTest.java
index cc3aff4042c..acbfa5d05fc 100644
--- a/lucene/facet/src/test/org/apache/lucene/facet/index/streaming/CategoryParentsStreamTest.java
+++ b/lucene/facet/src/test/org/apache/lucene/facet/index/streaming/CategoryParentsStreamTest.java
@@ -41,8 +41,6 @@ public class CategoryParentsStreamTest extends CategoryContainerTestBase {
* Verifies that a {@link CategoryParentsStream} can be constructed from
* {@link CategoryAttributesStream} and produces the correct number of
* tokens with default facet indexing params.
- *
- * @throws IOException
*/
@Test
public void testStreamDefaultParams() throws IOException {
@@ -68,8 +66,6 @@ public class CategoryParentsStreamTest extends CategoryContainerTestBase {
* Verifies that a {@link CategoryParentsStream} can be constructed from
* {@link CategoryAttributesStream} and produces the correct number of
* tokens with non top level facet indexing params.
- *
- * @throws IOException
*/
@Test
public void testStreamNonTopLevelParams() throws IOException {
@@ -108,9 +104,6 @@ public class CategoryParentsStreamTest extends CategoryContainerTestBase {
/**
* Verifies the correctness when no attributes in parents are retained in
* {@link CategoryParentsStream}.
- *
- * @throws IOException
- * @throws FacetException
*/
@Test
public void testNoRetainableAttributes() throws IOException {
@@ -142,9 +135,6 @@ public class CategoryParentsStreamTest extends CategoryContainerTestBase {
/**
* Verifies the correctness when attributes in parents are retained in
* {@link CategoryParentsStream}.
- *
- * @throws IOException
- * @throws FacetException
*/
@Test
public void testRetainableAttributes() throws IOException {
diff --git a/lucene/facet/src/test/org/apache/lucene/facet/index/streaming/CategoryTokenizerTest.java b/lucene/facet/src/test/org/apache/lucene/facet/index/streaming/CategoryTokenizerTest.java
index 14e46bcb6b0..977eeb0f49f 100644
--- a/lucene/facet/src/test/org/apache/lucene/facet/index/streaming/CategoryTokenizerTest.java
+++ b/lucene/facet/src/test/org/apache/lucene/facet/index/streaming/CategoryTokenizerTest.java
@@ -41,8 +41,6 @@ public class CategoryTokenizerTest extends CategoryContainerTestBase {
/**
* Verifies that a {@link CategoryTokenizer} adds the correct
* {@link CharTermAttribute}s to a {@link CategoryAttributesStream}.
- *
- * @throws IOException
*/
@Test
public void testTokensDefaultParams() throws IOException {
@@ -80,8 +78,6 @@ public class CategoryTokenizerTest extends CategoryContainerTestBase {
/**
* Verifies that {@link CategoryTokenizer} elongates the buffer in
* {@link CharTermAttribute} for long categories.
- *
- * @throws IOException
*/
@Test
public void testLongCategoryPath() throws IOException {
diff --git a/lucene/facet/src/test/org/apache/lucene/facet/taxonomy/TestTaxonomyCombined.java b/lucene/facet/src/test/org/apache/lucene/facet/taxonomy/TestTaxonomyCombined.java
index d22140206c1..20dd77b59ee 100644
--- a/lucene/facet/src/test/org/apache/lucene/facet/taxonomy/TestTaxonomyCombined.java
+++ b/lucene/facet/src/test/org/apache/lucene/facet/taxonomy/TestTaxonomyCombined.java
@@ -215,8 +215,6 @@ public class TestTaxonomyCombined extends LuceneTestCase {
* testWriterTwice3 is yet another test which tests creating a taxonomy
* in two separate writing sessions. This test used to fail because of
* a bug involving commit(), explained below, and now should succeed.
- *
- * @throws Exception
*/
@Test
public void testWriterTwice3() throws Exception {
diff --git a/lucene/facet/src/test/org/apache/lucene/facet/taxonomy/directory/TestDirectoryTaxonomyReader.java b/lucene/facet/src/test/org/apache/lucene/facet/taxonomy/directory/TestDirectoryTaxonomyReader.java
index bb405b14dd5..490fb5754c1 100644
--- a/lucene/facet/src/test/org/apache/lucene/facet/taxonomy/directory/TestDirectoryTaxonomyReader.java
+++ b/lucene/facet/src/test/org/apache/lucene/facet/taxonomy/directory/TestDirectoryTaxonomyReader.java
@@ -69,7 +69,6 @@ public class TestDirectoryTaxonomyReader extends LuceneTestCase {
/**
* Test the boolean returned by TR.refresh
- * @throws Exception
*/
@Test
public void testReaderRefreshResult() throws Exception {
diff --git a/lucene/facet/src/test/org/apache/lucene/util/encoding/EncodingSpeed.java b/lucene/facet/src/test/org/apache/lucene/util/encoding/EncodingSpeed.java
index bb7ca21f31d..96dcea5a5ba 100644
--- a/lucene/facet/src/test/org/apache/lucene/util/encoding/EncodingSpeed.java
+++ b/lucene/facet/src/test/org/apache/lucene/util/encoding/EncodingSpeed.java
@@ -46,10 +46,6 @@ public class EncodingSpeed {
private static NumberFormat nf;
- /**
- * @param args
- * @throws IOException
- */
public static void main(String[] args) throws IOException {
testFacetIDs(data3630, 3630);
testFacetIDs(data9910, 9910);
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/Highlighter.java b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/Highlighter.java
index 6e7522463a6..72f05145460 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/Highlighter.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/Highlighter.java
@@ -174,11 +174,7 @@ public class Highlighter
* Low level api to get the most relevant (formatted) sections of the document.
* This method has been made public to allow visibility of score information held in TextFragment objects.
* Thanks to Jason Calabrese for help in redefining the interface.
- * @param tokenStream
- * @param text
- * @param maxNumFragments
- * @param mergeContiguousFragments
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
* @throws InvalidTokenOffsetsException thrown if any token's endOffset exceeds the provided text's length
*/
public final TextFragment[] getBestTextFragments(
@@ -492,9 +488,6 @@ public class Highlighter
return textFragmenter;
}
- /**
- * @param fragmenter
- */
public void setTextFragmenter(Fragmenter fragmenter)
{
textFragmenter = fragmenter;
@@ -509,9 +502,6 @@ public class Highlighter
}
- /**
- * @param scorer
- */
public void setFragmentScorer(Scorer scorer)
{
fragmentScorer = scorer;
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/QueryScorer.java b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/QueryScorer.java
index 1c51fee354c..c2e6a107fb4 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/QueryScorer.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/QueryScorer.java
@@ -84,7 +84,6 @@ public class QueryScorer implements Scorer {
* @param query to use for highlighting
* @param reader {@link IndexReader} to use for quasi tf/idf scoring
* @param field to highlight - pass null to ignore fields
- * @param defaultField
*/
public QueryScorer(Query query, IndexReader reader, String field, String defaultField) {
this.defaultField = defaultField;
@@ -263,8 +262,6 @@ public class QueryScorer implements Scorer {
* ensure an efficient reset - if you are already using a different caching
* {@link TokenStream} impl and you don't want it to be wrapped, set this to
* false.
- *
- * @param wrap
*/
public void setWrapIfNotCachingTokenFilter(boolean wrap) {
this.wrapToCaching = wrap;
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/Scorer.java b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/Scorer.java
index fa406883f44..19fa1808242 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/Scorer.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/Scorer.java
@@ -35,7 +35,7 @@ public interface Scorer {
* @return either a {@link TokenStream} that the Highlighter should continue using (eg
* if you read the tokenSream in this method) or null to continue
* using the same {@link TokenStream} that was passed in.
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
public TokenStream init(TokenStream tokenStream) throws IOException;
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/TextFragment.java b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/TextFragment.java
index dd56f21c8a7..1005afa0344 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/TextFragment.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/TextFragment.java
@@ -55,7 +55,6 @@ public class TextFragment
score=Math.max(score,frag2.score);
}
/**
- * @param fragment
* @return true if this fragment follows the one passed
*/
public boolean follows(TextFragment fragment)
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/TokenSources.java b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/TokenSources.java
index b0830be57d8..add22bcbc13 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/TokenSources.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/TokenSources.java
@@ -93,12 +93,8 @@ public class TokenSources {
* minimal (1000 invocations still registers 0 ms). So this "lazy" (flexible?)
* approach to coding is probably acceptable
*
- * @param reader
- * @param docId
- * @param field
- * @param analyzer
* @return null if field not stored correctly
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
public static TokenStream getAnyTokenStream(IndexReader reader, int docId,
String field, Analyzer analyzer) throws IOException {
@@ -150,7 +146,6 @@ public class TokenSources {
* compression (less disk IO) or slower (more CPU burn) depending on the
* content.
*
- * @param tpv
* @param tokenPositionsGuaranteedContiguous true if the token position
* numbers have no overlaps or gaps. If looking to eek out the last
* drops of performance, set to true. If in doubt, set to false.
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/WeightedSpanTerm.java b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/WeightedSpanTerm.java
index 15c4c012191..ff395468383 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/WeightedSpanTerm.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/WeightedSpanTerm.java
@@ -30,20 +30,11 @@ public class WeightedSpanTerm extends WeightedTerm{
boolean positionSensitive;
private List positionSpans = new ArrayList();
- /**
- * @param weight
- * @param term
- */
public WeightedSpanTerm(float weight, String term) {
super(weight, term);
this.positionSpans = new ArrayList();
}
- /**
- * @param weight
- * @param term
- * @param positionSensitive
- */
public WeightedSpanTerm(float weight, String term, boolean positionSensitive) {
super(weight, term);
this.positionSensitive = positionSensitive;
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/WeightedSpanTermExtractor.java b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/WeightedSpanTermExtractor.java
index 61efe7544d5..4b45302bc27 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/highlight/WeightedSpanTermExtractor.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/highlight/WeightedSpanTermExtractor.java
@@ -88,7 +88,7 @@ public class WeightedSpanTermExtractor {
* Query to extract Terms from
* @param terms
* Map to place created WeightedSpanTerms in
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
protected void extract(Query query, Map terms) throws IOException {
if (query instanceof BooleanQuery) {
@@ -221,7 +221,7 @@ public class WeightedSpanTermExtractor {
* Map to place created WeightedSpanTerms in
* @param spanQuery
* SpanQuery to extract Terms from
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
protected void extractWeightedSpanTerms(Map terms, SpanQuery spanQuery) throws IOException {
Set fieldNames;
@@ -309,7 +309,7 @@ public class WeightedSpanTermExtractor {
* Map to place created WeightedSpanTerms in
* @param query
* Query to extract Terms from
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
protected void extractWeightedTerms(Map terms, Query query) throws IOException {
Set nonWeightedTerms = new HashSet();
@@ -362,7 +362,7 @@ public class WeightedSpanTermExtractor {
* @param tokenStream
* of text to be highlighted
* @return Map containing WeightedSpanTerms
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
public Map getWeightedSpanTerms(Query query, TokenStream tokenStream)
throws IOException {
@@ -381,7 +381,7 @@ public class WeightedSpanTermExtractor {
* @param fieldName
* restricts Term's used based on field name
* @return Map containing WeightedSpanTerms
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
public Map getWeightedSpanTerms(Query query, TokenStream tokenStream,
String fieldName) throws IOException {
@@ -417,7 +417,7 @@ public class WeightedSpanTermExtractor {
* @param reader
* to use for scoring
* @return Map of WeightedSpanTerms with quasi tf/idf scores
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
public Map getWeightedSpanTermsWithScores(Query query, TokenStream tokenStream, String fieldName,
IndexReader reader) throws IOException {
@@ -551,8 +551,6 @@ public class WeightedSpanTermExtractor {
* ensure an efficient reset - if you are already using a different caching
* {@link TokenStream} impl and you don't want it to be wrapped, set this to
* false.
- *
- * @param wrap
*/
public void setWrapIfNotCachingTokenFilter(boolean wrap) {
this.wrapToCaching = wrap;
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FastVectorHighlighter.java b/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FastVectorHighlighter.java
index 5b20539ad2e..80fd58fd9dd 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FastVectorHighlighter.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FastVectorHighlighter.java
@@ -106,7 +106,7 @@ public class FastVectorHighlighter {
* @param fieldName field of the document to be highlighted
* @param fragCharSize the length (number of chars) of a fragment
* @return the best fragment (snippet) string
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
public final String getBestFragment( final FieldQuery fieldQuery, IndexReader reader, int docId,
String fieldName, int fragCharSize ) throws IOException {
@@ -126,7 +126,7 @@ public class FastVectorHighlighter {
* @param maxNumFragments maximum number of fragments
* @return created fragments or null when no fragments created.
* size of the array can be less than maxNumFragments
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
public final String[] getBestFragments( final FieldQuery fieldQuery, IndexReader reader, int docId,
String fieldName, int fragCharSize, int maxNumFragments ) throws IOException {
@@ -149,7 +149,7 @@ public class FastVectorHighlighter {
* @param postTags post-tags to be used to highlight terms
* @param encoder an encoder that generates encoded text
* @return the best fragment (snippet) string
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
public final String getBestFragment( final FieldQuery fieldQuery, IndexReader reader, int docId,
String fieldName, int fragCharSize,
@@ -175,7 +175,7 @@ public class FastVectorHighlighter {
* @param encoder an encoder that generates encoded text
* @return created fragments or null when no fragments created.
* size of the array can be less than maxNumFragments
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
public final String[] getBestFragments( final FieldQuery fieldQuery, IndexReader reader, int docId,
String fieldName, int fragCharSize, int maxNumFragments,
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FieldQuery.java b/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FieldQuery.java
index 79f0a9e2c9d..50ad2477ccb 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FieldQuery.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FieldQuery.java
@@ -292,8 +292,6 @@ public class FieldQuery {
/**
*
- * @param fieldName
- * @param term
* @return QueryPhraseMap
*/
public QueryPhraseMap getFieldTermMap( String fieldName, String term ){
@@ -303,8 +301,6 @@ public class FieldQuery {
/**
*
- * @param fieldName
- * @param phraseCandidate
* @return QueryPhraseMap
*/
public QueryPhraseMap searchPhrase( String fieldName, final List phraseCandidate ){
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FieldTermStack.java b/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FieldTermStack.java
index 456b2e3861d..1375cfdac47 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FieldTermStack.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FieldTermStack.java
@@ -70,7 +70,7 @@ public class FieldTermStack {
* @param docId document id to be highlighted
* @param fieldName field of the document to be highlighted
* @param fieldQuery FieldQuery object
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
public FieldTermStack( IndexReader reader, int docId, String fieldName, final FieldQuery fieldQuery ) throws IOException {
this.fieldName = fieldName;
diff --git a/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FragmentsBuilder.java b/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FragmentsBuilder.java
index 8bb5a89540a..a0c84e8afaa 100644
--- a/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FragmentsBuilder.java
+++ b/lucene/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FragmentsBuilder.java
@@ -37,7 +37,7 @@ public interface FragmentsBuilder {
* @param fieldName field of the document to be highlighted
* @param fieldFragList FieldFragList object
* @return a created fragment or null when no fragment created
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
public String createFragment( IndexReader reader, int docId, String fieldName,
FieldFragList fieldFragList ) throws IOException;
@@ -52,7 +52,7 @@ public interface FragmentsBuilder {
* @param maxNumFragments maximum number of fragments
* @return created fragments or null when no fragments created.
* size of the array can be less than maxNumFragments
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
public String[] createFragments( IndexReader reader, int docId, String fieldName,
FieldFragList fieldFragList, int maxNumFragments ) throws IOException;
@@ -68,7 +68,7 @@ public interface FragmentsBuilder {
* @param postTags post-tags to be used to highlight terms
* @param encoder an encoder that generates encoded text
* @return a created fragment or null when no fragment created
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
public String createFragment( IndexReader reader, int docId, String fieldName,
FieldFragList fieldFragList, String[] preTags, String[] postTags,
@@ -87,7 +87,7 @@ public interface FragmentsBuilder {
* @param encoder an encoder that generates encoded text
* @return created fragments or null when no fragments created.
* size of the array can be less than maxNumFragments
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
public String[] createFragments( IndexReader reader, int docId, String fieldName,
FieldFragList fieldFragList, int maxNumFragments, String[] preTags, String[] postTags,
diff --git a/lucene/highlighter/src/test/org/apache/lucene/search/highlight/HighlighterTest.java b/lucene/highlighter/src/test/org/apache/lucene/search/highlight/HighlighterTest.java
index 3677573a92a..7ce0731e1ef 100644
--- a/lucene/highlighter/src/test/org/apache/lucene/search/highlight/HighlighterTest.java
+++ b/lucene/highlighter/src/test/org/apache/lucene/search/highlight/HighlighterTest.java
@@ -153,7 +153,6 @@ public class HighlighterTest extends BaseTokenStreamTestCase implements Formatte
/**
* This method intended for use with testHighlightingWithDefaultField()
- * @throws InvalidTokenOffsetsException
*/
private String highlightField(Query query, String fieldName, String text)
throws IOException, InvalidTokenOffsetsException {
@@ -1335,8 +1334,6 @@ public class HighlighterTest extends BaseTokenStreamTestCase implements Formatte
/**
* Demonstrates creation of an XHTML compliant doc using new encoding facilities.
- *
- * @throws Exception
*/
public void testEncoding() throws Exception {
diff --git a/lucene/highlighter/src/test/org/apache/lucene/search/highlight/custom/HighlightCustomQueryTest.java b/lucene/highlighter/src/test/org/apache/lucene/search/highlight/custom/HighlightCustomQueryTest.java
index 98ec317c8a1..233bf15fc4e 100644
--- a/lucene/highlighter/src/test/org/apache/lucene/search/highlight/custom/HighlightCustomQueryTest.java
+++ b/lucene/highlighter/src/test/org/apache/lucene/search/highlight/custom/HighlightCustomQueryTest.java
@@ -85,8 +85,6 @@ public class HighlightCustomQueryTest extends LuceneTestCase {
/**
* This method intended for use with
* testHighlightingWithDefaultField()
- *
- * @throws InvalidTokenOffsetsException
*/
private String highlightField(Query query, String fieldName,
String text) throws IOException, InvalidTokenOffsetsException {
diff --git a/lucene/misc/src/java/org/apache/lucene/index/IndexSplitter.java b/lucene/misc/src/java/org/apache/lucene/index/IndexSplitter.java
index 0f0977c3e88..fbfdaa31bc3 100644
--- a/lucene/misc/src/java/org/apache/lucene/index/IndexSplitter.java
+++ b/lucene/misc/src/java/org/apache/lucene/index/IndexSplitter.java
@@ -55,9 +55,6 @@ public class IndexSplitter {
File dir;
- /**
- * @param args
- */
public static void main(String[] args) throws Exception {
if (args.length < 2) {
System.err
diff --git a/lucene/misc/src/java/org/apache/lucene/index/MultiPassIndexSplitter.java b/lucene/misc/src/java/org/apache/lucene/index/MultiPassIndexSplitter.java
index ce6e415a032..73370241696 100644
--- a/lucene/misc/src/java/org/apache/lucene/index/MultiPassIndexSplitter.java
+++ b/lucene/misc/src/java/org/apache/lucene/index/MultiPassIndexSplitter.java
@@ -55,7 +55,7 @@ public class MultiPassIndexSplitter {
* @param seq if true, then the source index will be split into equal
* increasing ranges of document id-s. If false, source document id-s will be
* assigned in a deterministic round-robin fashion to one of the output splits.
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
public void split(Version version, IndexReader in, Directory[] outputs, boolean seq) throws IOException {
if (outputs == null || outputs.length < 2) {
diff --git a/lucene/misc/src/java/org/apache/lucene/misc/HighFreqTerms.java b/lucene/misc/src/java/org/apache/lucene/misc/HighFreqTerms.java
index 9f4d68b9bdf..c0118a14611 100644
--- a/lucene/misc/src/java/org/apache/lucene/misc/HighFreqTerms.java
+++ b/lucene/misc/src/java/org/apache/lucene/misc/HighFreqTerms.java
@@ -106,12 +106,7 @@ public class HighFreqTerms {
+ "java org.apache.lucene.misc.HighFreqTerms [-t] [number_terms] [field]\n\t -t: include totalTermFreq\n\n");
}
/**
- *
- * @param reader
- * @param numTerms
- * @param field
- * @return TermStats[] ordered by terms with highest docFreq first.
- * @throws Exception
+ * Returns TermStats[] ordered by terms with highest docFreq first.
*/
public static TermStats[] getHighFreqTerms(IndexReader reader, int numTerms, String field) throws Exception {
TermStatsQueue tiq = null;
@@ -157,11 +152,9 @@ public class HighFreqTerms {
* containing the term and stores the total in the output array of TermStats.
* Output array is sorted by highest total tf.
*
- * @param reader
* @param terms
* TermStats[]
* @return TermStats[]
- * @throws Exception
*/
public static TermStats[] sortByTotalTermFreq(IndexReader reader, TermStats[] terms) throws Exception {
diff --git a/lucene/misc/src/java/org/apache/lucene/store/NativeUnixDirectory.java b/lucene/misc/src/java/org/apache/lucene/store/NativeUnixDirectory.java
index 3b8ea425106..f990faea912 100644
--- a/lucene/misc/src/java/org/apache/lucene/store/NativeUnixDirectory.java
+++ b/lucene/misc/src/java/org/apache/lucene/store/NativeUnixDirectory.java
@@ -97,7 +97,7 @@ public class NativeUnixDirectory extends FSDirectory {
* not use direct IO. See {@link
* #DEFAULT_MIN_BYTES_DIRECT}
* @param delegate fallback Directory for non-merges
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
public NativeUnixDirectory(File path, int mergeBufferSize, long minBytesDirect, Directory delegate) throws IOException {
super(path, delegate.getLockFactory());
@@ -113,7 +113,7 @@ public class NativeUnixDirectory extends FSDirectory {
*
* @param path the path of the directory
* @param delegate fallback Directory for non-merges
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
public NativeUnixDirectory(File path, Directory delegate) throws IOException {
this(path, DEFAULT_MERGE_BUFFER_SIZE, DEFAULT_MIN_BYTES_DIRECT, delegate);
diff --git a/lucene/misc/src/java/org/apache/lucene/store/WindowsDirectory.java b/lucene/misc/src/java/org/apache/lucene/store/WindowsDirectory.java
index 3ad31f598aa..f635fe37ccd 100644
--- a/lucene/misc/src/java/org/apache/lucene/store/WindowsDirectory.java
+++ b/lucene/misc/src/java/org/apache/lucene/store/WindowsDirectory.java
@@ -54,7 +54,7 @@ public class WindowsDirectory extends FSDirectory {
* @param path the path of the directory
* @param lockFactory the lock factory to use, or null for the default
* ({@link NativeFSLockFactory});
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
public WindowsDirectory(File path, LockFactory lockFactory) throws IOException {
super(path, lockFactory);
@@ -63,7 +63,7 @@ public class WindowsDirectory extends FSDirectory {
/** Create a new WindowsDirectory for the named location and {@link NativeFSLockFactory}.
*
* @param path the path of the directory
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error
*/
public WindowsDirectory(File path) throws IOException {
super(path, null);
diff --git a/lucene/queries/src/java/org/apache/lucene/queries/TermsFilter.java b/lucene/queries/src/java/org/apache/lucene/queries/TermsFilter.java
index e0b35d9eafa..a3023fa5adf 100644
--- a/lucene/queries/src/java/org/apache/lucene/queries/TermsFilter.java
+++ b/lucene/queries/src/java/org/apache/lucene/queries/TermsFilter.java
@@ -42,8 +42,6 @@ public class TermsFilter extends Filter {
/**
* Adds a term to the list of acceptable terms
- *
- * @param term
*/
public void addTerm(Term term) {
terms.add(term);
diff --git a/lucene/queries/src/java/org/apache/lucene/queries/mlt/MoreLikeThis.java b/lucene/queries/src/java/org/apache/lucene/queries/mlt/MoreLikeThis.java
index 62b96a9dfc8..13636030123 100644
--- a/lucene/queries/src/java/org/apache/lucene/queries/mlt/MoreLikeThis.java
+++ b/lucene/queries/src/java/org/apache/lucene/queries/mlt/MoreLikeThis.java
@@ -292,6 +292,7 @@ public final class MoreLikeThis {
* Returns the boost factor used when boosting terms
*
* @return the boost factor used when boosting terms
+ * @see #setBoostFactor(float)
*/
public float getBoostFactor() {
return boostFactor;
@@ -300,7 +301,7 @@ public final class MoreLikeThis {
/**
* Sets the boost factor to use when boosting terms
*
- * @param boostFactor
+ * @see #getBoostFactor()
*/
public void setBoostFactor(float boostFactor) {
this.boostFactor = boostFactor;
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/analyzing/AnalyzingQueryParser.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/analyzing/AnalyzingQueryParser.java
index 67357d3b66b..92154ff11b8 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/analyzing/AnalyzingQueryParser.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/analyzing/AnalyzingQueryParser.java
@@ -72,7 +72,6 @@ public class AnalyzingQueryParser extends org.apache.lucene.queryparser.classic.
* characters (? or *), but is not simple prefix term
*
* @return Resulting {@link Query} built for the term
- * @throws ParseException
*/
@Override
protected Query getWildcardQuery(String field, String termStr) throws ParseException {
@@ -190,7 +189,6 @@ public class AnalyzingQueryParser extends org.apache.lucene.queryparser.classic.
* (without trailing '*' character!)
*
* @return Resulting {@link Query} built for the term
- * @throws ParseException
*/
@Override
protected Query getPrefixQuery(String field, String termStr) throws ParseException {
@@ -243,7 +241,6 @@ public class AnalyzingQueryParser extends org.apache.lucene.queryparser.classic.
* @param termStr Term token to use for building term for the query
*
* @return Resulting {@link Query} built for the term
- * @exception ParseException
*/
@Override
protected Query getFuzzyQuery(String field, String termStr, float minSimilarity)
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/classic/QueryParserBase.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/classic/QueryParserBase.java
index 79807cfa68b..1575ed34244 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/classic/QueryParserBase.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/classic/QueryParserBase.java
@@ -662,10 +662,6 @@ public abstract class QueryParserBase implements CommonQueryParserConfiguration
return query;
}
- /**
- *
- * @exception org.apache.lucene.queryparser.classic.ParseException
- */
protected Query getRangeQuery(String field,
String part1,
String part2,
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/builders/QueryBuilder.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/builders/QueryBuilder.java
index cc3bbe7cd87..cd4573aec76 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/builders/QueryBuilder.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/builders/QueryBuilder.java
@@ -36,8 +36,6 @@ public interface QueryBuilder {
* the query tree root node
*
* @return some object generated from the query tree
- *
- * @throws QueryNodeException
*/
Object build(QueryNode queryNode) throws QueryNodeException;
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/config/AbstractQueryConfig.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/config/AbstractQueryConfig.java
index 4c8869c92f6..0276e3332c4 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/config/AbstractQueryConfig.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/config/AbstractQueryConfig.java
@@ -81,7 +81,7 @@ public abstract class AbstractQueryConfig {
*
* @param the value's type
* @param key the key, cannot be null
- * @param value
+ * @param value value to set
*/
public void set(ConfigurationKey key, T value) {
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/GroupQueryNode.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/GroupQueryNode.java
index dfb818fef12..4330b0a0e88 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/GroupQueryNode.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/GroupQueryNode.java
@@ -71,9 +71,6 @@ public class GroupQueryNode extends QueryNodeImpl {
return clone;
}
- /**
- * @param child
- */
public void setChild(QueryNode child) {
List list = new ArrayList();
list.add(child);
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/ModifierQueryNode.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/ModifierQueryNode.java
index 8c43a2066c7..8f7f221252f 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/ModifierQueryNode.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/ModifierQueryNode.java
@@ -149,9 +149,6 @@ public class ModifierQueryNode extends QueryNodeImpl {
return clone;
}
- /**
- * @param child
- */
public void setChild(QueryNode child) {
List list = new ArrayList();
list.add(child);
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/QueryNode.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/QueryNode.java
index b7aefb249a5..6cdd0ba8bb6 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/QueryNode.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/nodes/QueryNode.java
@@ -46,8 +46,7 @@ public interface QueryNode {
public boolean containsTag(String tagName);
/**
- * @param tagName
- * @return of stored on under that tag name
+ * Returns object stored under that tag name
*/
public Object getTag(String tagName);
@@ -58,7 +57,6 @@ public interface QueryNode {
* when you call the cloneTree() method
*
* @return the cloned tree
- * @throws CloneNotSupportedException
*/
public QueryNode cloneTree() throws CloneNotSupportedException;
@@ -77,16 +75,11 @@ public interface QueryNode {
* Associate the specified value with the specified tagName. If the tagName
* already exists, the old value is replaced. The tagName and value cannot be
* null. tagName will be converted to lowercase.
- *
- * @param tagName
- * @param value
*/
public void setTag(String tagName, Object value);
/**
* Unset a tag. tagName will be converted to lowercase.
- *
- * @param tagName
*/
public void unsetTag(String tagName);
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/processors/QueryNodeProcessor.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/processors/QueryNodeProcessor.java
index b192ecd367a..2e8d7daaef4 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/processors/QueryNodeProcessor.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/processors/QueryNodeProcessor.java
@@ -55,15 +55,11 @@ public interface QueryNodeProcessor {
* tree root node
*
* @return the processed query tree
- *
- * @throws QueryNodeException
*/
public QueryNode process(QueryNode queryTree) throws QueryNodeException;
/**
* Sets the {@link QueryConfigHandler} associated to the query tree.
- *
- * @param queryConfigHandler
*/
public void setQueryConfigHandler(QueryConfigHandler queryConfigHandler);
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/util/UnescapedCharSequence.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/util/UnescapedCharSequence.java
index 2527fbc95a2..b0256f89270 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/util/UnescapedCharSequence.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/util/UnescapedCharSequence.java
@@ -29,11 +29,6 @@ public final class UnescapedCharSequence implements CharSequence {
/**
* Create a escaped CharSequence
- *
- * @param chars
- * @param wasEscaped
- * @param offset
- * @param length
*/
public UnescapedCharSequence(char[] chars, boolean[] wasEscaped, int offset,
int length) {
@@ -45,8 +40,6 @@ public final class UnescapedCharSequence implements CharSequence {
/**
* Create a non-escaped CharSequence
- *
- * @param text
*/
public UnescapedCharSequence(CharSequence text) {
this.chars = new char[text.length()];
@@ -59,8 +52,6 @@ public final class UnescapedCharSequence implements CharSequence {
/**
* Create a copy of an existent UnescapedCharSequence
- *
- * @param text
*/
@SuppressWarnings("unused")
private UnescapedCharSequence(UnescapedCharSequence text) {
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/messages/NLS.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/messages/NLS.java
index ba866d22086..19afdbb4418 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/messages/NLS.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/messages/NLS.java
@@ -122,9 +122,6 @@ public class NLS {
return null;
}
- /**
- * @param clazz
- */
private static void load(Class extends NLS> clazz) {
final Field[] fieldArray = clazz.getDeclaredFields();
@@ -139,10 +136,6 @@ public class NLS {
}
}
- /**
- * @param field
- * @param isFieldAccessible
- */
private static void loadfieldValue(Field field, boolean isFieldAccessible,
Class extends NLS> clazz) {
int MOD_EXPECTED = Modifier.PUBLIC | Modifier.STATIC;
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/standard/nodes/StandardBooleanQueryNode.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/standard/nodes/StandardBooleanQueryNode.java
index 07808bf3c69..2d65360ebe9 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/standard/nodes/StandardBooleanQueryNode.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/standard/nodes/StandardBooleanQueryNode.java
@@ -36,9 +36,6 @@ public class StandardBooleanQueryNode extends BooleanQueryNode {
private boolean disableCoord;
- /**
- * @param clauses
- */
public StandardBooleanQueryNode(List clauses, boolean disableCoord) {
super(clauses);
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/RewriteQuery.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/RewriteQuery.java
index 1275b7869bd..ef43d02a4a5 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/RewriteQuery.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/RewriteQuery.java
@@ -72,7 +72,9 @@ abstract class RewriteQuery extends Query {
&& srndQuery.equals(other.srndQuery);
}
- /** @throws UnsupportedOperationException */
+ /**
+ * Not supported by this query.
+ * @throws UnsupportedOperationException always: clone is not supported. */
@Override
public RewriteQuery clone() {
throw new UnsupportedOperationException();
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/CoreParser.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/CoreParser.java
index c1929f9ebe9..d7238e2694b 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/CoreParser.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/CoreParser.java
@@ -45,7 +45,6 @@ public class CoreParser implements QueryBuilder {
* Construct an XML parser that uses a single instance QueryParser for handling
* UserQuery tags - all parse operations are synchronised on this parser
*
- * @param analyzer
* @param parser A QueryParser which will be synchronized on during parse calls.
*/
public CoreParser(Analyzer analyzer, QueryParser parser) {
@@ -56,7 +55,6 @@ public class CoreParser implements QueryBuilder {
* Constructs an XML parser that creates a QueryParser for each UserQuery request.
*
* @param defaultField The default field name used by QueryParsers constructed for UserQuery tags
- * @param analyzer
*/
public CoreParser(String defaultField, Analyzer analyzer) {
this(defaultField, analyzer, null);
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/CorePlusExtensionsParser.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/CorePlusExtensionsParser.java
index cc90d3ced3b..8d69d62a738 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/CorePlusExtensionsParser.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/CorePlusExtensionsParser.java
@@ -32,7 +32,6 @@ public class CorePlusExtensionsParser extends CoreParser {
* Construct an XML parser that uses a single instance QueryParser for handling
* UserQuery tags - all parse operations are synchronized on this parser
*
- * @param analyzer
* @param parser A QueryParser which will be synchronized on during parse calls.
*/
public CorePlusExtensionsParser(Analyzer analyzer, QueryParser parser) {
@@ -43,7 +42,6 @@ public class CorePlusExtensionsParser extends CoreParser {
* Constructs an XML parser that creates a QueryParser for each UserQuery request.
*
* @param defaultField The default field name used by QueryParsers constructed for UserQuery tags
- * @param analyzer
*/
public CorePlusExtensionsParser(String defaultField, Analyzer analyzer) {
this(defaultField, analyzer, null);
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/DOMUtils.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/DOMUtils.java
index 27e268302e9..9e895b66572 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/DOMUtils.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/DOMUtils.java
@@ -89,8 +89,6 @@ public class DOMUtils {
/**
* Returns an attribute value from this node, or first parent node with this attribute defined
*
- * @param element
- * @param attributeName
* @return A non-zero-length value if defined, otherwise null
*/
public static String getAttributeWithInheritance(Element element, String attributeName) {
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/ParserException.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/ParserException.java
index d902bdad0b2..96b261f6923 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/ParserException.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/ParserException.java
@@ -25,31 +25,18 @@ package org.apache.lucene.queryparser.xml;
*/
public class ParserException extends Exception {
- /**
- *
- */
public ParserException() {
super();
}
- /**
- * @param message
- */
public ParserException(String message) {
super(message);
}
- /**
- * @param message
- * @param cause
- */
public ParserException(String message, Throwable cause) {
super(message, cause);
}
- /**
- * @param cause
- */
public ParserException(Throwable cause) {
super(cause);
}
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/builders/NumericRangeFilterBuilder.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/builders/NumericRangeFilterBuilder.java
index da00a3ee6cb..4d4540a061a 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/builders/NumericRangeFilterBuilder.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/builders/NumericRangeFilterBuilder.java
@@ -107,8 +107,6 @@ public class NumericRangeFilterBuilder implements FilterBuilder {
* any documents.
*
* Defaults to false.
- *
- * @param strictMode
*/
public void setStrictMode(boolean strictMode) {
this.strictMode = strictMode;
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/builders/SpanNotBuilder.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/builders/SpanNotBuilder.java
index e9df3f36f60..6006fa66295 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/builders/SpanNotBuilder.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/builders/SpanNotBuilder.java
@@ -29,9 +29,6 @@ public class SpanNotBuilder extends SpanBuilderBase {
private final SpanQueryBuilder factory;
- /**
- * @param factory
- */
public SpanNotBuilder(SpanQueryBuilder factory) {
this.factory = factory;
}
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/builders/SpanOrTermsBuilder.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/builders/SpanOrTermsBuilder.java
index 80fa3e71b54..1c9dc60efeb 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/builders/SpanOrTermsBuilder.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/builders/SpanOrTermsBuilder.java
@@ -40,9 +40,6 @@ public class SpanOrTermsBuilder extends SpanBuilderBase {
private final Analyzer analyzer;
- /**
- * @param analyzer
- */
public SpanOrTermsBuilder(Analyzer analyzer) {
this.analyzer = analyzer;
}
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/builders/TermsFilterBuilder.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/builders/TermsFilterBuilder.java
index 3e1574a73a5..b3b0f8473d2 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/builders/TermsFilterBuilder.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/builders/TermsFilterBuilder.java
@@ -39,9 +39,6 @@ public class TermsFilterBuilder implements FilterBuilder {
private final Analyzer analyzer;
- /**
- * @param analyzer
- */
public TermsFilterBuilder(Analyzer analyzer) {
this.analyzer = analyzer;
}
diff --git a/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/builders/UserInputQueryBuilder.java b/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/builders/UserInputQueryBuilder.java
index cf75a4e1ffd..1020e4b6d34 100644
--- a/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/builders/UserInputQueryBuilder.java
+++ b/lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/builders/UserInputQueryBuilder.java
@@ -82,8 +82,6 @@ public class UserInputQueryBuilder implements QueryBuilder {
/**
* Method to create a QueryParser - designed to be overridden
*
- * @param fieldName
- * @param analyzer
* @return QueryParser
*/
protected QueryParser createQueryParser(String fieldName, Analyzer analyzer) {
diff --git a/lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/FuzzyLikeThisQuery.java b/lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/FuzzyLikeThisQuery.java
index 07e9d48586f..f3db434bc04 100644
--- a/lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/FuzzyLikeThisQuery.java
+++ b/lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/FuzzyLikeThisQuery.java
@@ -110,7 +110,6 @@ public class FuzzyLikeThisQuery extends Query
/**
*
* @param maxNumTerms The total number of terms clauses that will appear once rewritten as a BooleanQuery
- * @param analyzer
*/
public FuzzyLikeThisQuery(int maxNumTerms, Analyzer analyzer)
{
@@ -180,7 +179,6 @@ public class FuzzyLikeThisQuery extends Query
/**
* Adds user input for "fuzzification"
* @param queryString The string which will be parsed by the analyzer and for which fuzzy variants will be parsed
- * @param fieldName
* @param minSimilarity The minimum similarity of the term variants (see FuzzyTermsEnum)
* @param prefixLength Length of required common prefix on variant terms (see FuzzyTermsEnum)
*/
diff --git a/lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/SlowCollatedTermRangeQuery.java b/lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/SlowCollatedTermRangeQuery.java
index 229267d6581..407d38065f1 100644
--- a/lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/SlowCollatedTermRangeQuery.java
+++ b/lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/SlowCollatedTermRangeQuery.java
@@ -110,7 +110,7 @@ public class SlowCollatedTermRangeQuery extends MultiTermQuery {
lowerTerm, upperTerm, includeLower, includeUpper, collator);
}
- /** @deprecated */
+ /** @deprecated Use {@link #getField()} instead. */
@Deprecated
public String field() {
return getField();
diff --git a/lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/SlowCollatedTermRangeTermsEnum.java b/lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/SlowCollatedTermRangeTermsEnum.java
index 6933701e2e3..91030c99569 100644
--- a/lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/SlowCollatedTermRangeTermsEnum.java
+++ b/lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/SlowCollatedTermRangeTermsEnum.java
@@ -50,7 +50,7 @@ public class SlowCollatedTermRangeTermsEnum extends FilteredTermsEnum {
* (you can't select all but the first or last term without
* explicitly specifying the term to exclude.)
*
- * @param tenum
+ * @param tenum source of the terms to enumerate.
* @param lowerTermText
* The term text at the lower end of the range
* @param upperTermText
diff --git a/lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/SlowFuzzyTermsEnum.java b/lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/SlowFuzzyTermsEnum.java
index 95721ec37fd..de8539e6670 100644
--- a/lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/SlowFuzzyTermsEnum.java
+++ b/lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/SlowFuzzyTermsEnum.java
@@ -83,7 +83,7 @@ public final class SlowFuzzyTermsEnum extends FuzzyTermsEnum {
* After calling the constructor the enumeration is already pointing to the first
* valid term if such a term exists.
*
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
public LinearFuzzyTermsEnum() throws IOException {
super(terms.iterator(null));
diff --git a/lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/regex/RegexQuery.java b/lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/regex/RegexQuery.java
index 6420447c7e6..5ac67f43b92 100644
--- a/lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/regex/RegexQuery.java
+++ b/lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/regex/RegexQuery.java
@@ -51,18 +51,10 @@ public class RegexQuery extends MultiTermQuery implements RegexQueryCapable {
return term;
}
- /**
- * Defines which {@link RegexCapabilities} implementation is used by this instance.
- *
- * @param impl
- */
public void setRegexImplementation(RegexCapabilities impl) {
this.regexImpl = impl;
}
- /**
- * @return The implementation used by this instance.
- */
public RegexCapabilities getRegexImplementation() {
return regexImpl;
}
diff --git a/lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/regex/RegexQueryCapable.java b/lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/regex/RegexQueryCapable.java
index 1b2c2535ca9..10e0c5fad0b 100644
--- a/lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/regex/RegexQueryCapable.java
+++ b/lucene/sandbox/src/java/org/apache/lucene/sandbox/queries/regex/RegexQueryCapable.java
@@ -23,6 +23,14 @@ package org.apache.lucene.sandbox.queries.regex;
*/
public interface RegexQueryCapable {
+ /**
+ * Defines which {@link RegexCapabilities} implementation is used by this instance.
+ * @see #getRegexImplementation()
+ */
void setRegexImplementation(RegexCapabilities impl);
+ /**
+ * Returns the implementation used by this instance.
+ * @see #setRegexImplementation(RegexCapabilities)
+ */
RegexCapabilities getRegexImplementation();
}
diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/query/SpatialArgs.java b/lucene/spatial/src/java/org/apache/lucene/spatial/query/SpatialArgs.java
index 7dad6f382ae..e3f2a4975e9 100644
--- a/lucene/spatial/src/java/org/apache/lucene/spatial/query/SpatialArgs.java
+++ b/lucene/spatial/src/java/org/apache/lucene/spatial/query/SpatialArgs.java
@@ -73,7 +73,6 @@ public class SpatialArgs {
* Gets the error distance that specifies how precise the query shape is. This
* looks at {@link #getDistErr()}, {@link #getDistErrPct()}, and {@code
* defaultDistErrPct}.
- * @param ctx
* @param defaultDistErrPct 0 to 0.5
* @return >= 0
*/
diff --git a/lucene/suggest/src/java/org/apache/lucene/search/spell/DirectSpellChecker.java b/lucene/suggest/src/java/org/apache/lucene/search/spell/DirectSpellChecker.java
index 28d31ed5a9d..f7095416cdb 100644
--- a/lucene/suggest/src/java/org/apache/lucene/search/spell/DirectSpellChecker.java
+++ b/lucene/suggest/src/java/org/apache/lucene/search/spell/DirectSpellChecker.java
@@ -313,7 +313,7 @@ public class DirectSpellChecker {
* @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
+ * @throws IOException If there is a low-level I/O error.
*/
public SuggestWord[] suggestSimilar(Term term, int numSug, IndexReader ir,
SuggestMode suggestMode, float accuracy) throws IOException {
diff --git a/lucene/suggest/src/java/org/apache/lucene/search/spell/SpellChecker.java b/lucene/suggest/src/java/org/apache/lucene/search/spell/SpellChecker.java
index 66aecb3db54..162ff926672 100755
--- a/lucene/suggest/src/java/org/apache/lucene/search/spell/SpellChecker.java
+++ b/lucene/suggest/src/java/org/apache/lucene/search/spell/SpellChecker.java
@@ -449,7 +449,7 @@ public class SpellChecker implements java.io.Closeable {
/**
* Removes all terms from the spell check index.
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
* @throws AlreadyClosedException if the Spellchecker is already closed
*/
public void clearIndex() throws IOException {
@@ -467,8 +467,8 @@ public class SpellChecker implements java.io.Closeable {
/**
* Check whether the word exists in the index.
- * @param word
- * @throws IOException
+ * @param word word to check
+ * @throws IOException If there is a low-level I/O error.
* @throws AlreadyClosedException if the Spellchecker is already closed
* @return true if the word exists in the index
*/
@@ -490,7 +490,7 @@ public class SpellChecker implements java.io.Closeable {
* @param config {@link IndexWriterConfig} to use
* @param fullMerge whether or not the spellcheck index should be fully merged
* @throws AlreadyClosedException if the Spellchecker is already closed
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
public final void indexDictionary(Dictionary dict, IndexWriterConfig config, boolean fullMerge) throws IOException {
synchronized (modifyCurrentIndexLock) {
diff --git a/lucene/suggest/src/java/org/apache/lucene/search/spell/WordBreakSpellChecker.java b/lucene/suggest/src/java/org/apache/lucene/search/spell/WordBreakSpellChecker.java
index d9675a17471..50e4cd867be 100644
--- a/lucene/suggest/src/java/org/apache/lucene/search/spell/WordBreakSpellChecker.java
+++ b/lucene/suggest/src/java/org/apache/lucene/search/spell/WordBreakSpellChecker.java
@@ -82,16 +82,13 @@ public class WordBreakSpellChecker {
* lower score is generally preferred over a higher score.
*
*
- * @param term
- * @param maxSuggestions
- * @param ir
* @param suggestMode
* - default = {@link SuggestMode#SUGGEST_WHEN_NOT_IN_INDEX}
* @param sortMethod
* - default =
* {@link BreakSuggestionSortMethod#NUM_CHANGES_THEN_MAX_FREQUENCY}
* @return one or more arrays of words formed by breaking up the original term
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
public SuggestWord[][] suggestWordBreaks(Term term, int maxSuggestions,
IndexReader ir, SuggestMode suggestMode,
@@ -159,12 +156,8 @@ public class WordBreakSpellChecker {
* included term.
*
*
- * @param terms
- * @param maxSuggestions
- * @param ir
- * @param suggestMode
* @return an array of words generated by combining original terms
- * @throws IOException
+ * @throws IOException If there is a low-level I/O error.
*/
public CombineSuggestion[] suggestWordCombinations(Term[] terms,
int maxSuggestions, IndexReader ir, SuggestMode suggestMode)
diff --git a/lucene/test-framework/src/java/org/apache/lucene/index/DocHelper.java b/lucene/test-framework/src/java/org/apache/lucene/index/DocHelper.java
index da4627da216..bd6c7d3ac84 100644
--- a/lucene/test-framework/src/java/org/apache/lucene/index/DocHelper.java
+++ b/lucene/test-framework/src/java/org/apache/lucene/index/DocHelper.java
@@ -257,9 +257,6 @@ class DocHelper {
* Writes the document to the directory using a segment
* named "test"; returns the SegmentInfo describing the new
* segment
- * @param dir
- * @param doc
- * @throws IOException
*/
public static SegmentInfoPerCommit writeDoc(Random random, Directory dir, Document doc) throws IOException
{
@@ -270,11 +267,6 @@ class DocHelper {
* Writes the document to the directory using the analyzer
* and the similarity score; returns the SegmentInfo
* describing the new segment
- * @param dir
- * @param analyzer
- * @param similarity
- * @param doc
- * @throws IOException
*/
public static SegmentInfoPerCommit writeDoc(Random random, Directory dir, Analyzer analyzer, Similarity similarity, Document doc) throws IOException {
IndexWriter writer = new IndexWriter(dir, new IndexWriterConfig( /* LuceneTestCase.newIndexWriterConfig(random, */
diff --git a/solr/contrib/clustering/src/java/org/apache/solr/handler/clustering/SearchClusteringEngine.java b/solr/contrib/clustering/src/java/org/apache/solr/handler/clustering/SearchClusteringEngine.java
index 5be8e7349f2..38193a915b1 100644
--- a/solr/contrib/clustering/src/java/org/apache/solr/handler/clustering/SearchClusteringEngine.java
+++ b/solr/contrib/clustering/src/java/org/apache/solr/handler/clustering/SearchClusteringEngine.java
@@ -45,7 +45,6 @@ public abstract class SearchClusteringEngine extends ClusteringEngine {
* Returns the set of field names to load.
* Concrete classes can override this method if needed.
* Default implementation returns null, that is, all stored fields are loaded.
- * @param sreq
* @return set of field names to load
*/
protected Set getFieldsToLoad(SolrQueryRequest sreq){
diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/Context.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/Context.java
index 7604e65c33c..a86c13c3096 100644
--- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/Context.java
+++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/Context.java
@@ -198,12 +198,10 @@ public abstract class Context {
public abstract String getScriptLanguage();
/**delete a document by id
- * @param id
*/
public abstract void deleteDoc(String id);
/**delete documents by query
- * @param query
*/
public abstract void deleteDocByQuery(String query);
@@ -214,7 +212,6 @@ public abstract class Context {
public abstract Object resolve(String var);
/** Resolve variables in a template
- * @param template
*
* @return The string w/ variables resolved
*/
diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/DIHCache.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/DIHCache.java
index 2b6ae9a9663..5c8f715709b 100644
--- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/DIHCache.java
+++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/DIHCache.java
@@ -68,8 +68,6 @@ public interface DIHCache extends Iterable
- *
- * @param rec
*/
public void add(Map rec);
@@ -93,8 +91,6 @@ public interface DIHCache extends Iterable
- * @param optimize
*/
public void commit(boolean optimize);
@@ -53,7 +52,6 @@ public interface DIHWriter {
*
* Delete from the writer's underlying data store based the passed-in writer-specific query. (Optional Operation)
*
- * @param q
*/
public void deleteByQuery(String q);
@@ -68,7 +66,6 @@ public interface DIHWriter {
*
* Delete from the writer's underlying data store based on the passed-in Primary Key
*
- * @param key
*/
public void deleteDoc(Object key);
@@ -78,7 +75,6 @@ public interface DIHWriter {
*
* Add a document to this writer's underlying data store.
*
- * @param doc
* @return true on success, false on failure
*/
public boolean upload(SolrInputDocument doc);
@@ -89,7 +85,6 @@ public interface DIHWriter {
*
* Provide context information for this writer. init() should be called before using the writer.
*
- * @param context
*/
public void init(Context context) ;
@@ -98,7 +93,6 @@ public interface DIHWriter {
*
* Specify the keys to be modified by a delta update (required by writers that can store duplicate keys)
*
- * @param deltaKeys
*/
public void setDeltaKeys(Set