From 47190d3323e22e6a62f3d63e112f1e0d33427e0e Mon Sep 17 00:00:00 2001 From: Steven Rowe Date: Thu, 31 Mar 2011 14:36:05 +0000 Subject: [PATCH] LUCENE-3006: die javadoc warnings die git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1087319 13f79535-47bb-0310-9956-ffa450edef68 --- lucene/build.xml | 10 ++++++++ .../org/apache/lucene/index/FieldInfos.java | 11 +++++---- .../org/apache/lucene/util/PriorityQueue.java | 23 +++++++++++-------- solr/build.xml | 1 + 4 files changed, 31 insertions(+), 14 deletions(-) diff --git a/lucene/build.xml b/lucene/build.xml index cd471a9f3ce..1d12084cf76 100644 --- a/lucene/build.xml +++ b/lucene/build.xml @@ -195,6 +195,16 @@ + + + + + + + + + + diff --git a/lucene/src/java/org/apache/lucene/index/FieldInfos.java b/lucene/src/java/org/apache/lucene/index/FieldInfos.java index 56fe2e17381..5540f5f507c 100644 --- a/lucene/src/java/org/apache/lucene/index/FieldInfos.java +++ b/lucene/src/java/org/apache/lucene/index/FieldInfos.java @@ -28,6 +28,7 @@ import java.util.SortedMap; import java.util.TreeMap; import java.util.Map.Entry; +import org.apache.lucene.index.SegmentCodecs; // Required for Java 1.5 javadocs import org.apache.lucene.index.SegmentCodecs.SegmentCodecsBuilder; import org.apache.lucene.index.codecs.CodecProvider; import org.apache.lucene.store.Directory; @@ -218,12 +219,13 @@ public final class FieldInfos implements Iterable { /** * Creates a new {@link FieldInfos} instance with a private - * {@link FieldNumberBiMap} and a default {@link SegmentCodecsBuilder} + * {@link org.apache.lucene.index.FieldInfos.FieldNumberBiMap} and a default {@link SegmentCodecsBuilder} * initialized with {@link CodecProvider#getDefault()}. *

* Note: this ctor should not be used during indexing use * {@link FieldInfos#FieldInfos(FieldInfos)} or - * {@link FieldInfos#FieldInfos(FieldNumberBiMap)} instead. + * {@link FieldInfos#FieldInfos(FieldNumberBiMap,org.apache.lucene.index.SegmentCodecs.SegmentCodecsBuilder)} + * instead. */ public FieldInfos() { this(new FieldNumberBiMap(), SegmentCodecsBuilder.create(CodecProvider.getDefault())); @@ -552,9 +554,10 @@ public final class FieldInfos implements Iterable { /** * Returns true iff this instance is not backed by a - * {@link FieldNumberBiMap}. Instances read from a directory via + * {@link org.apache.lucene.index.FieldInfos.FieldNumberBiMap}. Instances read from a directory via * {@link FieldInfos#FieldInfos(Directory, String)} will always be read-only - * since no {@link FieldNumberBiMap} is supplied, otherwise false. + * since no {@link org.apache.lucene.index.FieldInfos.FieldNumberBiMap} is supplied, otherwise + * false. */ public final boolean isReadOnly() { return globalFieldNumbers == null; diff --git a/lucene/src/java/org/apache/lucene/util/PriorityQueue.java b/lucene/src/java/org/apache/lucene/util/PriorityQueue.java index eebc7996256..38252bfa03c 100644 --- a/lucene/src/java/org/apache/lucene/util/PriorityQueue.java +++ b/lucene/src/java/org/apache/lucene/util/PriorityQueue.java @@ -21,8 +21,10 @@ package org.apache.lucene.util; * least element can always be found in constant time. Put()'s and pop()'s * require log(size) time. * - *

NOTE: This class pre-allocates a full array of - * length maxSize+1, in {@link #initialize}. + *

NOTE: This class will pre-allocate a full array of + * length maxSize+1 if instantiated via the + * {@link #PriorityQueue(int,boolean)} constructor with + * prepopulate set to true. * * @lucene.internal */ @@ -83,9 +85,10 @@ public abstract class PriorityQueue { /** * This method can be overridden by extending classes to return a sentinel - * object which will be used by {@link #initialize(int)} to fill the queue, so - * that the code which uses that queue can always assume it's full and only - * change the top without attempting to insert any new object.
+ * object which will be used by the {@link PriorityQueue#PriorityQueue(int,boolean)} + * constructor to fill the queue, so that the code which uses that queue can always + * assume it's full and only change the top without attempting to insert any new + * object.
* * Those sentinel values should always compare worse than any non-sentinel * value (i.e., {@link #lessThan} should always favor the @@ -111,11 +114,11 @@ public abstract class PriorityQueue { * * * NOTE: if this method returns a non-null value, it will be called by - * {@link #initialize(int)} {@link #size()} times, relying on a new object to - * be returned and will not check if it's null again. Therefore you should - * ensure any call to this method creates a new instance and behaves - * consistently, e.g., it cannot return null if it previously returned - * non-null. + * the {@link PriorityQueue#PriorityQueue(int,boolean)} constructor + * {@link #size()} times, relying on a new object to be returned and will not + * check if it's null again. Therefore you should ensure any call to this + * method creates a new instance and behaves consistently, e.g., it cannot + * return null if it previously returned non-null. * * @return the sentinel object to use to pre-populate the queue, or null if * sentinel objects are not supported. diff --git a/solr/build.xml b/solr/build.xml index 9370217be5c..5821f9953e6 100644 --- a/solr/build.xml +++ b/solr/build.xml @@ -187,6 +187,7 @@ +