You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by rm...@apache.org on 2012/09/20 02:30:07 UTC
svn commit: r1387828 - in /lucene/dev/branches/branch_4x: ./ lucene/
lucene/analysis/common/src/java/org/apache/lucene/analysis/compound/
lucene/core/ lucene/core/src/java/org/apache/lucene/document/
lucene/core/src/java/org/apache/lucene/index/ lucene...
Author: rmuir
Date: Thu Sep 20 00:30:06 2012
New Revision: 1387828
URL: http://svn.apache.org/viewvc?rev=1387828&view=rev
Log:
fix javadocs bugs found by my IDE
Modified:
lucene/dev/branches/branch_4x/ (props changed)
lucene/dev/branches/branch_4x/lucene/ (props changed)
lucene/dev/branches/branch_4x/lucene/analysis/common/src/java/org/apache/lucene/analysis/compound/HyphenationCompoundWordTokenFilter.java
lucene/dev/branches/branch_4x/lucene/core/ (props changed)
lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/document/Field.java
lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/document/FieldType.java
lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/DocsAndPositionsEnum.java
lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/DocsEnum.java
lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SingleTermsEnum.java
lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/util/packed/PackedInts.java
lucene/dev/branches/branch_4x/solr/ (props changed)
lucene/dev/branches/branch_4x/solr/contrib/analysis-extras/src/test/org/apache/solr/analysis/TestICUCollationKeyRangeQueries.java
lucene/dev/branches/branch_4x/solr/core/ (props changed)
lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/cloud/LeaderElector.java
lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/cloud/ZkController.java
lucene/dev/branches/branch_4x/solr/core/src/test/org/apache/solr/analysis/TestCollationKeyRangeQueries.java
lucene/dev/branches/branch_4x/solr/solrj/ (props changed)
lucene/dev/branches/branch_4x/solr/solrj/src/java/org/apache/solr/common/cloud/SolrZkClient.java
Modified: lucene/dev/branches/branch_4x/lucene/analysis/common/src/java/org/apache/lucene/analysis/compound/HyphenationCompoundWordTokenFilter.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/analysis/common/src/java/org/apache/lucene/analysis/compound/HyphenationCompoundWordTokenFilter.java?rev=1387828&r1=1387827&r2=1387828&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/analysis/common/src/java/org/apache/lucene/analysis/compound/HyphenationCompoundWordTokenFilter.java (original)
+++ lucene/dev/branches/branch_4x/lucene/analysis/common/src/java/org/apache/lucene/analysis/compound/HyphenationCompoundWordTokenFilter.java Thu Sep 20 00:30:06 2012
@@ -132,7 +132,7 @@ public class HyphenationCompoundWordToke
*
* @param hyphenationFilename the filename of the XML grammar to load
* @return An object representing the hyphenation patterns
- * @throws Exception
+ * @throws IOException
*/
public static HyphenationTree getHyphenationTree(String hyphenationFilename)
throws IOException {
@@ -144,7 +144,7 @@ public class HyphenationCompoundWordToke
*
* @param hyphenationFile the file of the XML grammar to load
* @return An object representing the hyphenation patterns
- * @throws Exception
+ * @throws IOException
*/
public static HyphenationTree getHyphenationTree(File hyphenationFile)
throws IOException {
@@ -156,7 +156,7 @@ public class HyphenationCompoundWordToke
*
* @param hyphenationSource the InputSource pointing to the XML grammar
* @return An object representing the hyphenation patterns
- * @throws Exception
+ * @throws IOException
*/
public static HyphenationTree getHyphenationTree(InputSource hyphenationSource)
throws IOException {
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/document/Field.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/document/Field.java?rev=1387828&r1=1387827&r2=1387828&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/document/Field.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/document/Field.java Thu Sep 20 00:30:06 2012
@@ -606,7 +606,7 @@ public class Field implements IndexableF
/** Creates a new TokenStream that returns a String as single token.
* <p>Warning: Does not initialize the value, you must call
- * {@link #setValue()} afterwards!
+ * {@link #setValue(String)} afterwards!
*/
StringTokenStream() {
}
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/document/FieldType.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/document/FieldType.java?rev=1387828&r1=1387827&r2=1387828&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/document/FieldType.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/document/FieldType.java Thu Sep 20 00:30:06 2012
@@ -281,7 +281,7 @@ public class FieldType implements Indexa
* {@inheritDoc}
* <p>
* The default is {@link IndexOptions#DOCS_AND_FREQS_AND_POSITIONS}.
- * @see #setIndexOptions(FieldInfo.IndexOptions)
+ * @see #setIndexOptions(org.apache.lucene.index.FieldInfo.IndexOptions)
*/
public IndexOptions indexOptions() {
return this.indexOptions;
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/DocsAndPositionsEnum.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/DocsAndPositionsEnum.java?rev=1387828&r1=1387827&r2=1387828&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/DocsAndPositionsEnum.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/DocsAndPositionsEnum.java Thu Sep 20 00:30:06 2012
@@ -19,6 +19,7 @@ package org.apache.lucene.index;
import java.io.IOException;
+import org.apache.lucene.util.Bits; // javadocs
import org.apache.lucene.util.BytesRef;
/** Also iterates through positions. */
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/DocsEnum.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/DocsEnum.java?rev=1387828&r1=1387827&r2=1387828&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/DocsEnum.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/DocsEnum.java Thu Sep 20 00:30:06 2012
@@ -21,6 +21,7 @@ import java.io.IOException;
import org.apache.lucene.search.DocIdSetIterator;
import org.apache.lucene.util.AttributeSource;
+import org.apache.lucene.util.Bits; // javadocs
/** Iterates through the documents and term freqs.
* NOTE: you must first call {@link #nextDoc} before using
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SingleTermsEnum.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SingleTermsEnum.java?rev=1387828&r1=1387827&r2=1387828&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SingleTermsEnum.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SingleTermsEnum.java Thu Sep 20 00:30:06 2012
@@ -26,7 +26,7 @@ import org.apache.lucene.util.BytesRef;
* For example, this can be used by {@link MultiTermQuery}s
* that need only visit one term, but want to preserve
* MultiTermQuery semantics such as {@link
- * MultiTermQuery#rewriteMethod}.
+ * MultiTermQuery#getRewriteMethod}.
*/
public final class SingleTermsEnum extends FilteredTermsEnum {
private final BytesRef singleRef;
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/util/packed/PackedInts.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/util/packed/PackedInts.java?rev=1387828&r1=1387827&r2=1387828&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/util/packed/PackedInts.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/util/packed/PackedInts.java Thu Sep 20 00:30:06 2012
@@ -780,7 +780,6 @@ public class PackedInts {
* @param bitsPerValue the number of bits per value
* @param mem how much memory the iterator is allowed to use to read-ahead (likely to speed up iteration)
* @return a ReaderIterator
- * @throws IOException
* @see PackedInts#getWriterNoHeader(DataOutput, Format, int, int, int)
* @lucene.internal
*/
@@ -822,7 +821,6 @@ public class PackedInts {
* @param valueCount how many values the stream holds
* @param bitsPerValue the number of bits per value
* @return a direct Reader
- * @throws IOException
* @lucene.internal
*/
public static Reader getDirectReaderNoHeader(IndexInput in, Format format,
@@ -953,7 +951,6 @@ public class PackedInts {
* @param bitsPerValue the number of bits per value
* @param mem how much memory (in bytes) can be used to speed up serialization
* @return a Writer
- * @throws IOException
* @see PackedInts#getReaderIteratorNoHeader(DataInput, Format, int, int, int, int)
* @see PackedInts#getReaderNoHeader(DataInput, Format, int, int, int)
* @lucene.internal
Modified: lucene/dev/branches/branch_4x/solr/contrib/analysis-extras/src/test/org/apache/solr/analysis/TestICUCollationKeyRangeQueries.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/solr/contrib/analysis-extras/src/test/org/apache/solr/analysis/TestICUCollationKeyRangeQueries.java?rev=1387828&r1=1387827&r2=1387828&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/solr/contrib/analysis-extras/src/test/org/apache/solr/analysis/TestICUCollationKeyRangeQueries.java (original)
+++ lucene/dev/branches/branch_4x/solr/contrib/analysis-extras/src/test/org/apache/solr/analysis/TestICUCollationKeyRangeQueries.java Thu Sep 20 00:30:06 2012
@@ -17,6 +17,7 @@
package org.apache.solr.analysis;
+import org.apache.lucene.collation.ICUCollationKeyFilterFactory; // javadocs
import org.apache.solr.SolrTestCaseJ4;
import org.junit.BeforeClass;
Modified: lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/cloud/LeaderElector.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/cloud/LeaderElector.java?rev=1387828&r1=1387827&r2=1387828&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/cloud/LeaderElector.java (original)
+++ lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/cloud/LeaderElector.java Thu Sep 20 00:30:06 2012
@@ -191,7 +191,6 @@ public class LeaderElector {
/**
* Returns int list given list of form n_0000000001, n_0000000003, etc.
*
- * @param string seqs
* @return int seqs
*/
private List<Integer> getSeqs(List<String> seqs) {
Modified: lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/cloud/ZkController.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/cloud/ZkController.java?rev=1387828&r1=1387827&r2=1387828&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/cloud/ZkController.java (original)
+++ lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/cloud/ZkController.java Thu Sep 20 00:30:06 2012
@@ -728,7 +728,6 @@ public final class ZkController {
* @param collection
* @param slice
* @return leader props
- * @throws KeeperException
* @throws InterruptedException
*/
public ZkCoreNodeProps getLeaderProps(final String collection,
Modified: lucene/dev/branches/branch_4x/solr/core/src/test/org/apache/solr/analysis/TestCollationKeyRangeQueries.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/solr/core/src/test/org/apache/solr/analysis/TestCollationKeyRangeQueries.java?rev=1387828&r1=1387827&r2=1387828&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/solr/core/src/test/org/apache/solr/analysis/TestCollationKeyRangeQueries.java (original)
+++ lucene/dev/branches/branch_4x/solr/core/src/test/org/apache/solr/analysis/TestCollationKeyRangeQueries.java Thu Sep 20 00:30:06 2012
@@ -17,6 +17,7 @@
package org.apache.solr.analysis;
+import org.apache.lucene.collation.CollationKeyFilterFactory; // javadocs
import org.apache.solr.SolrTestCaseJ4;
import org.junit.BeforeClass;
Modified: lucene/dev/branches/branch_4x/solr/solrj/src/java/org/apache/solr/common/cloud/SolrZkClient.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/solr/solrj/src/java/org/apache/solr/common/cloud/SolrZkClient.java?rev=1387828&r1=1387827&r2=1387828&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/solr/solrj/src/java/org/apache/solr/common/cloud/SolrZkClient.java (original)
+++ lucene/dev/branches/branch_4x/solr/solrj/src/java/org/apache/solr/common/cloud/SolrZkClient.java Thu Sep 20 00:30:06 2012
@@ -79,9 +79,6 @@ public class SolrZkClient {
/**
* @param zkServerAddress
* @param zkClientTimeout
- * @throws InterruptedException
- * @throws TimeoutException
- * @throws IOException
*/
public SolrZkClient(String zkServerAddress, int zkClientTimeout) {
this(zkServerAddress, zkClientTimeout, new DefaultConnectionStrategy(), null);
@@ -96,9 +93,6 @@ public class SolrZkClient {
* @param zkClientTimeout
* @param strat
* @param onReconnect
- * @throws InterruptedException
- * @throws TimeoutException
- * @throws IOException
*/
public SolrZkClient(String zkServerAddress, int zkClientTimeout,
ZkClientConnectionStrategy strat, final OnReconnect onReconnect) {
@@ -111,9 +105,6 @@ public class SolrZkClient {
* @param strat
* @param onReconnect
* @param clientConnectTimeout
- * @throws InterruptedException
- * @throws TimeoutException
- * @throws IOException
*/
public SolrZkClient(String zkServerAddress, int zkClientTimeout,
ZkClientConnectionStrategy strat, final OnReconnect onReconnect, int clientConnectTimeout) {
@@ -660,9 +651,6 @@ public class SolrZkClient {
return prettyPrint(input, 2);
}
- /**
- * @throws InterruptedException
- */
public void close() {
if (isClosed) return; // it's okay if we over close - same as solrcore
isClosed = true;