Index: src/java/org/apache/lucene/document/NumericField.java =================================================================== --- src/java/org/apache/lucene/document/NumericField.java (revision 834552) +++ src/java/org/apache/lucene/document/NumericField.java (working copy) @@ -69,8 +69,7 @@ * NumericField, use {@link NumericRangeQuery} or {@link * NumericRangeFilter}. To sort according to a * NumericField, use the normal numeric sort types, eg - * {@link SortField#INT} (note that {@link SortField#AUTO} - * will not work with these fields). NumericField values + * {@link SortField#INT}. NumericField values * can also be loaded directly from {@link FieldCache}.

* *

By default, a NumericField's value is not stored but Index: src/java/org/apache/lucene/index/IndexDeletionPolicy.java =================================================================== --- src/java/org/apache/lucene/index/IndexDeletionPolicy.java (revision 834552) +++ src/java/org/apache/lucene/index/IndexDeletionPolicy.java (working copy) @@ -84,7 +84,7 @@ *

This method is only called when {@link * IndexWriter#commit} or {@link IndexWriter#close} is * called, or possibly not at all if the {@link - * IndexWriter#abort} is called. + * IndexWriter#rollback} is called. * *

Note: the last CommitPoint is the most recent one, * i.e. the "front index state". Be careful not to delete it, Index: src/java/org/apache/lucene/index/IndexReader.java =================================================================== --- src/java/org/apache/lucene/index/IndexReader.java (revision 834552) +++ src/java/org/apache/lucene/index/IndexReader.java (working copy) @@ -36,7 +36,7 @@

Concrete subclasses of IndexReader are usually constructed with a call to one of the static open() methods, e.g. {@link - #open(String, boolean)}. + #open(Directory, boolean)}.

For efficiency, in this API documents are often referred to via document numbers, non-negative integers which each name a unique @@ -1109,7 +1109,7 @@ * one commit point. But if you're using a custom {@link * IndexDeletionPolicy} then there could be many commits. * Once you have a given commit, you can open a reader on - * it by calling {@link IndexReader#open(IndexCommit)} + * it by calling {@link IndexReader#open(IndexCommit,boolean)} * There must be at least one commit in * the Directory, else this method throws {@link * java.io.IOException}. Note that if a commit is in Index: src/java/org/apache/lucene/index/IndexWriter.java =================================================================== --- src/java/org/apache/lucene/index/IndexWriter.java (revision 834552) +++ src/java/org/apache/lucene/index/IndexWriter.java (working copy) @@ -46,13 +46,13 @@ An IndexWriter creates and maintains an index.

The create argument to the {@link - #IndexWriter(Directory, Analyzer, boolean) constructor} determines + #IndexWriter(Directory, Analyzer, boolean, MaxFieldLength) constructor} determines whether a new index is created, or whether an existing index is opened. Note that you can open an index with create=true even while readers are using the index. The old readers will continue to search the "point in time" snapshot they had opened, and won't see the newly created index until they re-open. There are - also {@link #IndexWriter(Directory, Analyzer) constructors} + also {@link #IndexWriter(Directory, Analyzer, MaxFieldLength) constructors} with no create argument which will create a new index if there is not already an index at the provided path and otherwise open the existing index.

Index: src/java/org/apache/lucene/search/BooleanQuery.java =================================================================== --- src/java/org/apache/lucene/search/BooleanQuery.java (revision 834552) +++ src/java/org/apache/lucene/search/BooleanQuery.java (working copy) @@ -118,13 +118,8 @@ * any specific clauses are required (or prohibited). This number will * only be compared against the number of matching optional clauses. *

- *

- * EXPERT NOTE: Using this method may force collecting docs in order, - * regardless of whether setAllowDocsOutOfOrder(true) has been called. - *

* * @param min the number of optional clauses that must match - * @see #setAllowDocsOutOfOrder */ public void setMinimumNumberShouldMatch(int min) { this.minNrShouldMatch = min; Index: src/java/org/apache/lucene/search/DocIdSetIterator.java =================================================================== --- src/java/org/apache/lucene/search/DocIdSetIterator.java (revision 834552) +++ src/java/org/apache/lucene/search/DocIdSetIterator.java (working copy) @@ -32,7 +32,7 @@ /** * When returned by {@link #nextDoc()}, {@link #advance(int)} and - * {@link #doc()} it means there are no more docs in the iterator. + * {@link #docID()} it means there are no more docs in the iterator. */ public static final int NO_MORE_DOCS = Integer.MAX_VALUE; Index: src/java/org/apache/lucene/search/MultiSearcher.java =================================================================== --- src/java/org/apache/lucene/search/MultiSearcher.java (revision 834552) +++ src/java/org/apache/lucene/search/MultiSearcher.java (working copy) @@ -35,8 +35,8 @@ /** Implements search over a set of Searchables. * - *

Applications usually need only call the inherited {@link #search(Query)} - * or {@link #search(Query,Filter)} methods. + *

Applications usually need only call the inherited {@link #search(Query,int)} + * or {@link #search(Query,Filter,int)} methods. */ public class MultiSearcher extends Searcher { Index: src/java/org/apache/lucene/search/package.html =================================================================== --- src/java/org/apache/lucene/search/package.html (revision 834552) +++ src/java/org/apache/lucene/search/package.html (working copy) @@ -36,8 +36,8 @@ Search over indices. Applications usually call {@link -org.apache.lucene.search.Searcher#search(Query)} or {@link -org.apache.lucene.search.Searcher#search(Query,Filter)}. +org.apache.lucene.search.Searcher#search(Query,int)} or {@link +org.apache.lucene.search.Searcher#search(Query,Filter,int)}.

Index: src/java/org/apache/lucene/search/ParallelMultiSearcher.java =================================================================== --- src/java/org/apache/lucene/search/ParallelMultiSearcher.java (revision 834552) +++ src/java/org/apache/lucene/search/ParallelMultiSearcher.java (working copy) @@ -36,8 +36,8 @@ /** Implements parallel search over a set of Searchables. * - *

Applications usually need only call the inherited {@link #search(Query)} - * or {@link #search(Query,Filter)} methods. + *

Applications usually need only call the inherited {@link #search(Query,int)} + * or {@link #search(Query,Filter,int)} methods. */ public class ParallelMultiSearcher extends MultiSearcher { @@ -131,7 +131,7 @@ * *

Applications should only use this if they need all of the * matching documents. The high-level search API ({@link - * Searcher#search(Query)}) is usually more efficient, as it skips + * Searcher#search(Query,int)}) is usually more efficient, as it skips * non-high-scoring hits. * *

This method cannot be parallelized, because {@link Collector} Index: src/java/org/apache/lucene/search/payloads/PayloadNearQuery.java =================================================================== --- src/java/org/apache/lucene/search/payloads/PayloadNearQuery.java (revision 834552) +++ src/java/org/apache/lucene/search/payloads/PayloadNearQuery.java (working copy) @@ -43,13 +43,12 @@ * {@link org.apache.lucene.search.spans.TermSpans} occurs. *

* In order to take advantage of this, you must override - * {@link org.apache.lucene.search.Similarity#scorePayload(String, byte[],int,int)} + * {@link org.apache.lucene.search.Similarity#scorePayload} * which returns 1 by default. *

* Payload scores are aggregated using a pluggable {@link PayloadFunction}. * - * @see org.apache.lucene.search.Similarity#scorePayload(String, byte[], int, - * int) + * @see org.apache.lucene.search.Similarity#scorePayload */ public class PayloadNearQuery extends SpanNearQuery { protected String fieldName; Index: src/java/org/apache/lucene/search/Scorer.java =================================================================== --- src/java/org/apache/lucene/search/Scorer.java (revision 834552) +++ src/java/org/apache/lucene/search/Scorer.java (working copy) @@ -36,8 +36,6 @@ * not valid scores. Certain collectors (eg {@link * TopScoreDocCollector}) will not properly collect hits * with these scores. - * - * @see BooleanQuery#setAllowDocsOutOfOrder */ public abstract class Scorer extends DocIdSetIterator { private Similarity similarity; @@ -90,7 +88,7 @@ } /** Returns the score of the current document matching the query. - * Initially invalid, until {@link #next()} or {@link #skipTo(int)} + * Initially invalid, until {@link #nextDoc()} or {@link #advance(int)} * is called the first time, or when called from within * {@link Collector#collect}. */ Index: src/java/org/apache/lucene/search/Searchable.java =================================================================== --- src/java/org/apache/lucene/search/Searchable.java (revision 834552) +++ src/java/org/apache/lucene/search/Searchable.java (working copy) @@ -53,7 +53,7 @@ * *

* Applications should only use this if they need all of the matching - * documents. The high-level search API ({@link Searcher#search(Query)}) is + * documents. The high-level search API ({@link Searcher#search(Query,int)}) is * usually more efficient, as it skips non-high-scoring hits. * * @param weight @@ -93,8 +93,8 @@ /** Expert: Low-level search implementation. Finds the top n * hits for query, applying filter if non-null. * - *

Applications should usually call {@link Searcher#search(Query)} or - * {@link Searcher#search(Query,Filter)} instead. + *

Applications should usually call {@link Searcher#search(Query,int)} or + * {@link Searcher#search(Query,Filter,int)} instead. * @throws BooleanQuery.TooManyClauses */ TopDocs search(Weight weight, Filter filter, int n) throws IOException; Index: src/java/org/apache/lucene/search/Similarity.java =================================================================== --- src/java/org/apache/lucene/search/Similarity.java (revision 834552) +++ src/java/org/apache/lucene/search/Similarity.java (working copy) @@ -660,7 +660,7 @@ /** Computes a score factor based on a term or phrase's frequency in a - * document. This value is multiplied by the {@link #idf(Term, Searcher)} + * document. This value is multiplied by the {@link #idf(int, int)} * factor for each term in the query and these products are then summed to * form the initial score for a document. * @@ -694,7 +694,7 @@ public abstract float sloppyFreq(int distance); /** Computes a score factor based on a term or phrase's frequency in a - * document. This value is multiplied by the {@link #idf(Term, Searcher)} + * document. This value is multiplied by the {@link #idf(int, int)} * factor for each term in the query and these products are then summed to * form the initial score for a document. * Index: src/java/org/apache/lucene/search/Sort.java =================================================================== --- src/java/org/apache/lucene/search/Sort.java (revision 834552) +++ src/java/org/apache/lucene/search/Sort.java (working copy) @@ -103,7 +103,7 @@ /** * Represents sorting by computed relevance. Using this sort criteria returns * the same results as calling - * {@link Searcher#search(Query) Searcher#search()}without a sort criteria, + * {@link Searcher#search(Query,int) Searcher#search()}without a sort criteria, * only with slightly more overhead. */ public static final Sort RELEVANCE = new Sort(); @@ -116,7 +116,7 @@ /** * Sorts by computed relevance. This is the same sort criteria as calling - * {@link Searcher#search(Query) Searcher#search()}without a sort criteria, + * {@link Searcher#search(Query,int) Searcher#search()}without a sort criteria, * only with slightly more overhead. */ public Sort() { Index: src/java/org/apache/lucene/store/Directory.java =================================================================== --- src/java/org/apache/lucene/store/Directory.java (revision 834552) +++ src/java/org/apache/lucene/store/Directory.java (working copy) @@ -47,9 +47,8 @@ protected LockFactory lockFactory; /** Returns an array of strings, one for each file in the - * directory. Unlike {@link #list} this method does no - * filtering of the contents in a directory, and it will - * never return null (throws IOException instead). + * directory. + * @throws IOException */ public abstract String[] listAll() throws IOException; Index: src/java/org/apache/lucene/store/NoLockFactory.java =================================================================== --- src/java/org/apache/lucene/store/NoLockFactory.java (revision 834552) +++ src/java/org/apache/lucene/store/NoLockFactory.java (working copy) @@ -21,7 +21,6 @@ /** * Use this {@link LockFactory} to disable locking entirely. - * This LockFactory is used when you call {@link FSDirectory#setDisableLocks}. * Only one instance of this lock is created. You should call {@link * #getNoLockFactory()} to get the instance. * Index: src/java/org/apache/lucene/store/SimpleFSLockFactory.java =================================================================== --- src/java/org/apache/lucene/store/SimpleFSLockFactory.java (revision 834552) +++ src/java/org/apache/lucene/store/SimpleFSLockFactory.java (working copy) @@ -38,7 +38,7 @@ * is hit when trying to create a writer, in which case you * need to explicitly clear the lock file first. You can * either manually remove the file, or use the {@link - * org.apache.lucene.index.IndexReader#unlock(Directory)} + * org.apache.lucene.index.IndexWriter#unlock(Directory)} * API. But, first be certain that no writer is in fact * writing to the index otherwise you can easily corrupt * your index.