- * Note also that this metric differs in subtle ways from {@link LevenshteinDistance}: + * Note also that this metric differs in subtle ways from {@link LevensteinDistance}: *
searcher.docFreq(term) as the docFreq.
*/
public IDFExplanation idfExplain(final Term term, final Searcher searcher) throws IOException {
diff --git a/lucene/src/java/org/apache/lucene/search/SortField.java b/lucene/src/java/org/apache/lucene/search/SortField.java
index b61a1d8cd9a..58c4582c0e3 100644
--- a/lucene/src/java/org/apache/lucene/search/SortField.java
+++ b/lucene/src/java/org/apache/lucene/search/SortField.java
@@ -199,7 +199,6 @@ implements Serializable {
* Sort by a cached entry value
* @param creator
* @param reverse
- * @param sortMissingLast
*/
public SortField( CachedArrayCreator creator, boolean reverse )
{
diff --git a/lucene/src/java/org/apache/lucene/util/BytesRefHash.java b/lucene/src/java/org/apache/lucene/util/BytesRefHash.java
index df2aa6b57d3..a34ad775178 100644
--- a/lucene/src/java/org/apache/lucene/util/BytesRefHash.java
+++ b/lucene/src/java/org/apache/lucene/util/BytesRefHash.java
@@ -35,9 +35,8 @@ import static org.apache.lucene.util.ByteBlockPool.BYTE_BLOCK_SHIFT;
*
* * Note: The maximum capacity {@link BytesRef} instance passed to - * {@link #add(BytesRef)} must not be longer than {@link #BYTES_BLOCK_SIZE}-2 ( - * {@value #BYTES_BLOCK_SIZE}-2. The internal storage is limited to 2GB total - * byte storage. + * {@link #add(BytesRef)} must not be longer than {@link ByteBlockPool#BYTE_BLOCK_SIZE}-2. + * The internal storage is limited to 2GB totalbyte storage. *
* * @lucene.internal @@ -244,8 +243,7 @@ public final class BytesRefHash { } /** - * Clears the {@link BytesRef} and returns an {@link Entry} which maps to the - * given {@link BytesRef} + * Clears the {@link BytesRef} which maps to the given {@link BytesRef} */ public void clear(boolean resetPool) { lastCount = count; @@ -306,8 +304,8 @@ public final class BytesRefHash { * haven't been hashed before. * * @throws MaxBytesLengthExceededException - * if the given bytes are > 2 + - * {@link ByteBlockPool#BYTE_BLOCK_SIZE} + * if the given bytes are > + * {@link ByteBlockPool#BYTE_BLOCK_SIZE} - 2 */ public int add(BytesRef bytes, int code) { assert bytesStart != null : "Bytesstart is null - not initialized"; @@ -496,7 +494,7 @@ public final class BytesRefHash { /** * Thrown if a {@link BytesRef} exceeds the {@link BytesRefHash} limit of - * {@link #BYTES_BLOCK_SIZE}-2 ({@value #BYTES_BLOCK_SIZE}-2). + * {@link ByteBlockPool#BYTE_BLOCK_SIZE}-2. */ @SuppressWarnings("serial") public static class MaxBytesLengthExceededException extends RuntimeException { diff --git a/lucene/src/java/org/apache/lucene/util/RecyclingByteBlockAllocator.java b/lucene/src/java/org/apache/lucene/util/RecyclingByteBlockAllocator.java index 2d33fea2003..5346f9fcc3a 100644 --- a/lucene/src/java/org/apache/lucene/util/RecyclingByteBlockAllocator.java +++ b/lucene/src/java/org/apache/lucene/util/RecyclingByteBlockAllocator.java @@ -70,8 +70,7 @@ public final class RecyclingByteBlockAllocator extends ByteBlockPool.Allocator { /** * Creates a new {@link RecyclingByteBlockAllocator} with a block size of - * {@link ByteBlockPool#BYTE_BLOCK_SIZE} ( - * {@value ByteBlockPool#BYTE_BLOCK_SIZE}, upper buffered docs limit of + * {@link ByteBlockPool#BYTE_BLOCK_SIZE}, upper buffered docs limit of * {@link #DEFAULT_BUFFERED_BLOCKS} ({@value #DEFAULT_BUFFERED_BLOCKS}) and a * {@link DummyConcurrentLock} instance. * diff --git a/modules/analysis/common/src/java/org/apache/lucene/analysis/sinks/DateRecognizerSinkFilter.java b/modules/analysis/common/src/java/org/apache/lucene/analysis/sinks/DateRecognizerSinkFilter.java index 63142468cec..948f9b9cc45 100644 --- a/modules/analysis/common/src/java/org/apache/lucene/analysis/sinks/DateRecognizerSinkFilter.java +++ b/modules/analysis/common/src/java/org/apache/lucene/analysis/sinks/DateRecognizerSinkFilter.java @@ -25,7 +25,7 @@ import org.apache.lucene.analysis.tokenattributes.CharTermAttribute; import org.apache.lucene.util.AttributeSource; /** - * Attempts to parse the {@link org.apache.lucene.analysis.Token#termBuffer()} as a Date using a {@link java.text.DateFormat}. + * Attempts to parse the {@link CharTermAttribute#buffer()} as a Date using a {@link java.text.DateFormat}. * If the value is a Date, it will add it to the sink. * * diff --git a/modules/analysis/common/src/java/org/apache/lucene/analysis/standard/ASCIITLD.jflex-macro b/modules/analysis/common/src/java/org/apache/lucene/analysis/standard/ASCIITLD.jflex-macro index b30dc206383..32b23906aa9 100644 --- a/modules/analysis/common/src/java/org/apache/lucene/analysis/standard/ASCIITLD.jflex-macro +++ b/modules/analysis/common/src/java/org/apache/lucene/analysis/standard/ASCIITLD.jflex-macro @@ -15,8 +15,8 @@ */ // Generated from IANA Root Zone DatabaseMany applications have specific tokenizer needs. If this tokenizer does diff --git a/modules/analysis/common/src/java/org/apache/lucene/analysis/standard/StandardTokenizerImpl.java b/modules/analysis/common/src/java/org/apache/lucene/analysis/standard/StandardTokenizerImpl.java index f9744361f20..8449e1267e1 100644 --- a/modules/analysis/common/src/java/org/apache/lucene/analysis/standard/StandardTokenizerImpl.java +++ b/modules/analysis/common/src/java/org/apache/lucene/analysis/standard/StandardTokenizerImpl.java @@ -1,4 +1,4 @@ -/* The following code was generated by JFlex 1.5.0-SNAPSHOT on 10/2/10 6:07 PM */ +/* The following code was generated by JFlex 1.5.0-SNAPSHOT on 10/3/10 9:07 AM */ package org.apache.lucene.analysis.standard; @@ -42,8 +42,8 @@ import org.apache.lucene.analysis.tokenattributes.CharTermAttribute; * characters (characters above the Basic Multilingual Plane, which contains * those up to and including U+FFFF), this scanner will not recognize them * properly. If you need to be able to process text containing supplementary - * characters, consider using the ICU4J-backed implementation in contrib/icu - * ({@link org.apache.lucene.analysis.icu.segmentation.ICUTokenizer}) + * characters, consider using the ICU4J-backed implementation in modules/analysis/icu + * (org.apache.lucene.analysis.icu.segmentation.ICUTokenizer) * instead of this class, since the ICU4J-backed implementation does not have * this limitation. */ @@ -2388,7 +2388,8 @@ public final class StandardTokenizerImpl implements StandardTokenizerInterface { * scripts (Thai, Lao, Myanmar, Khmer, etc.). Sequences of these are kept * together as as a single token rather than broken up, because the logic * required to break them at word boundaries is too complex for UAX#29. - * {@see Unicode Line Breaking Algorithm http://www.unicode.org/reports/tr14/#SA} + *
+ * See Unicode Line Breaking Algorithm: http://www.unicode.org/reports/tr14/#SA */ public static final int SOUTH_EAST_ASIAN_TYPE = StandardTokenizer.SOUTHEAST_ASIAN; diff --git a/modules/analysis/common/src/java/org/apache/lucene/analysis/standard/StandardTokenizerImpl.jflex b/modules/analysis/common/src/java/org/apache/lucene/analysis/standard/StandardTokenizerImpl.jflex index 181cafcff61..49eed5ac78b 100644 --- a/modules/analysis/common/src/java/org/apache/lucene/analysis/standard/StandardTokenizerImpl.jflex +++ b/modules/analysis/common/src/java/org/apache/lucene/analysis/standard/StandardTokenizerImpl.jflex @@ -40,8 +40,8 @@ import org.apache.lucene.analysis.tokenattributes.CharTermAttribute; * characters (characters above the Basic Multilingual Plane, which contains * those up to and including U+FFFF), this scanner will not recognize them * properly. If you need to be able to process text containing supplementary - * characters, consider using the ICU4J-backed implementation in contrib/icu - * ({@link org.apache.lucene.analysis.icu.segmentation.ICUTokenizer}) + * characters, consider using the ICU4J-backed implementation in modules/analysis/icu + * (org.apache.lucene.analysis.icu.segmentation.ICUTokenizer) * instead of this class, since the ICU4J-backed implementation does not have * this limitation. */ @@ -162,7 +162,8 @@ EMAIL = {EMAILlocalPart} "@" ({DomainNameStrict} | {EMAILbracketedHost}) * scripts (Thai, Lao, Myanmar, Khmer, etc.). Sequences of these are kept * together as as a single token rather than broken up, because the logic * required to break them at word boundaries is too complex for UAX#29. - * {@see Unicode Line Breaking Algorithm http://www.unicode.org/reports/tr14/#SA} + *
+ * See Unicode Line Breaking Algorithm: http://www.unicode.org/reports/tr14/#SA */ public static final int SOUTH_EAST_ASIAN_TYPE = StandardTokenizer.SOUTHEAST_ASIAN; diff --git a/modules/analysis/common/src/java/org/apache/lucene/analysis/standard/UAX29Tokenizer.java b/modules/analysis/common/src/java/org/apache/lucene/analysis/standard/UAX29Tokenizer.java index b5a8575b180..18d047f5cbd 100644 --- a/modules/analysis/common/src/java/org/apache/lucene/analysis/standard/UAX29Tokenizer.java +++ b/modules/analysis/common/src/java/org/apache/lucene/analysis/standard/UAX29Tokenizer.java @@ -1,4 +1,4 @@ -/* The following code was generated by JFlex 1.5.0-SNAPSHOT on 10/2/10 6:07 PM */ +/* The following code was generated by JFlex 1.5.0-SNAPSHOT on 10/3/10 9:07 AM */ package org.apache.lucene.analysis.standard; @@ -48,8 +48,8 @@ import org.apache.lucene.util.AttributeSource; * characters (characters above the Basic Multilingual Plane, which contains * those up to and including U+FFFF), this scanner will not recognize them * properly. If you need to be able to process text containing supplementary - * characters, consider using the ICU4J-backed implementation in contrib/icu - * ({@link org.apache.lucene.analysis.icu.segmentation.ICUTokenizer}) + * characters, consider using the ICU4J-backed implementation in modules/analysis/icu + * (org.apache.lucene.analysis.icu.segmentation.ICUTokenizer) * instead of this class, since the ICU4J-backed implementation does not have * this limitation. */ @@ -389,7 +389,8 @@ public final class UAX29Tokenizer extends Tokenizer { * scripts (Thai, Lao, Myanmar, Khmer, etc.). Sequences of these are kept * together as as a single token rather than broken up, because the logic * required to break them at word boundaries is too complex for UAX#29. - * {@see Unicode Line Breaking Algorithm http://www.unicode.org/reports/tr14/#SA} + *
+ * See Unicode Line Breaking Algorithm: http://www.unicode.org/reports/tr14/#SA
*/
public static final String SOUTH_EAST_ASIAN_TYPE = "
+ * See Unicode Line Breaking Algorithm: http://www.unicode.org/reports/tr14/#SA
*/
public static final String SOUTH_EAST_ASIAN_TYPE = "s starts with suffix
+ * @param prefix Prefix string to test
+ * @return true if s starts with prefix
*/
public static boolean startsWith(char s[], int len, String prefix) {
final int prefixLen = prefix.length();
diff --git a/modules/analysis/common/src/java/org/apache/lucene/analysis/wikipedia/WikipediaTokenizerImpl.java b/modules/analysis/common/src/java/org/apache/lucene/analysis/wikipedia/WikipediaTokenizerImpl.java
index 88cc43ed415..7927d3d59bb 100644
--- a/modules/analysis/common/src/java/org/apache/lucene/analysis/wikipedia/WikipediaTokenizerImpl.java
+++ b/modules/analysis/common/src/java/org/apache/lucene/analysis/wikipedia/WikipediaTokenizerImpl.java
@@ -1,4 +1,4 @@
-/* The following code was generated by JFlex 1.5.0-SNAPSHOT on 10/2/10 6:07 PM */
+/* The following code was generated by JFlex 1.5.0-SNAPSHOT on 10/3/10 9:07 AM */
package org.apache.lucene.analysis.wikipedia;
@@ -25,7 +25,7 @@ import org.apache.lucene.analysis.tokenattributes.CharTermAttribute;
/**
* This class is a scanner generated by
* JFlex 1.5.0-SNAPSHOT
- * on 10/2/10 6:07 PM from the specification file
+ * on 10/3/10 9:07 AM from the specification file
* C:/Users/rmuir/workspace/lucene-clean/modules/analysis/common/src/java/org/apache/lucene/analysis/wikipedia/WikipediaTokenizerImpl.jflex
*/
class WikipediaTokenizerImpl {
diff --git a/modules/analysis/common/src/java/org/apache/lucene/collation/package.html b/modules/analysis/common/src/java/org/apache/lucene/collation/package.html
index b0c6f8016a8..03a92b211f5 100644
--- a/modules/analysis/common/src/java/org/apache/lucene/collation/package.html
+++ b/modules/analysis/common/src/java/org/apache/lucene/collation/package.html
@@ -43,8 +43,8 @@