Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

LUCENE-1900: Improve Searchable Javadoc 

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@812963 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Mark Robert Miller 2009-09-09 13:53:20 +00:00
parent c5c363e540
commit 8f96a290b8
2 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGES.txt
View File

@ -852,6 +852,9 @@ Documentation
update changes-to-html script to handle the new format. update changes-to-html script to handle the new format.
(Steven Rowe, Mark Miller) (Steven Rowe, Mark Miller)
* LUCENE-1900: Improve Searchable Javadoc.
(Nadav Har'El, Doron Cohen, Marvin Humphrey, Mark Miller)
Build Build
* LUCENE-1440: Add new targets to build.xml that allow downloading * LUCENE-1440: Add new targets to build.xml that allow downloading

11
src/java/org/apache/lucene/search/Searchable.java
View File

@ -92,7 +92,7 @@ public interface Searchable {
void close() throws IOException; void close() throws IOException;
/** Expert: Returns the number of documents containing <code>term</code>. /** Expert: Returns the number of documents containing <code>term</code>.
* Called by search code to compute term weights. *
* @see org.apache.lucene.index.IndexReader#docFreq(Term) * @see org.apache.lucene.index.IndexReader#docFreq(Term)
*/ */
int docFreq(Term term) throws IOException; int docFreq(Term term) throws IOException;
@ -104,7 +104,7 @@ public interface Searchable {
int[] docFreqs(Term[] terms) throws IOException; int[] docFreqs(Term[] terms) throws IOException;
/** Expert: Returns one greater than the largest possible document number. /** Expert: Returns one greater than the largest possible document number.
* Called by search code to compute term weights. *
* @see org.apache.lucene.index.IndexReader#maxDoc() * @see org.apache.lucene.index.IndexReader#maxDoc()
*/ */
int maxDoc() throws IOException; int maxDoc() throws IOException;
@ -112,8 +112,6 @@ public interface Searchable {
/** Expert: Low-level search implementation. Finds the top <code>n</code> /** Expert: Low-level search implementation. Finds the top <code>n</code>
* hits for <code>query</code>, applying <code>filter</code> if non-null. * hits for <code>query</code>, applying <code>filter</code> if non-null.
* *
* <p>Called by {@link Hits}.
*
* <p>Applications should usually call {@link Searcher#search(Query)} or * <p>Applications should usually call {@link Searcher#search(Query)} or
* {@link Searcher#search(Query,Filter)} instead. * {@link Searcher#search(Query,Filter)} instead.
* @throws BooleanQuery.TooManyClauses * @throws BooleanQuery.TooManyClauses
@ -121,8 +119,9 @@ public interface Searchable {
*/ */
TopDocs search(Weight weight, Filter filter, int n) throws IOException; TopDocs search(Weight weight, Filter filter, int n) throws IOException;
/** Expert: Returns the stored fields of document <code>i</code>. /**
* Called by {@link HitCollector} implementations. * Returns the stored fields of document <code>i</code>.
*
* @see org.apache.lucene.index.IndexReader#document(int) * @see org.apache.lucene.index.IndexReader#document(int)
* @throws CorruptIndexException if the index is corrupt * @throws CorruptIndexException if the index is corrupt
* @throws IOException if there is a low-level IO error * @throws IOException if there is a low-level IO error