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

LUCENE-6271: fix javadocs, don't @see yourself, and make it clear you don't get positions unless you ask 

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/branches/lucene6271@1670418 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Robert Muir 2015-03-31 18:29:43 +00:00
parent 087781fc9c
commit 78c1239c98
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
lucene/core/src/java/org/apache/lucene/index/TermsEnum.java
View File

@ -141,10 +141,17 @@ public abstract class TermsEnum implements BytesRefIterator {
/** Get {@link PostingsEnum} for the current term. Do not /** Get {@link PostingsEnum} for the current term. Do not
* call this when the enum is unpositioned. This method * call this when the enum is unpositioned. This method
* will not return null. * will not return null.
* <p>
* Use this method if you only require documents and frequencies,
* and do not need any proximity data.
* This method is equivalent to
* {@link #postings(Bits, PostingsEnum, int) postings(liveDocs, reuse, PostingsEnum.FREQS)}
* *
* @param liveDocs unset bits are documents that should not * @param liveDocs unset bits are documents that should not
* be returned * be returned
* @param reuse pass a prior PostingsEnum for possible reuse */ * @param reuse pass a prior PostingsEnum for possible reuse
* @see #postings(Bits, PostingsEnum, int)
*/
public final PostingsEnum postings(Bits liveDocs, PostingsEnum reuse) throws IOException { public final PostingsEnum postings(Bits liveDocs, PostingsEnum reuse) throws IOException {
return postings(liveDocs, reuse, PostingsEnum.FREQS); return postings(liveDocs, reuse, PostingsEnum.FREQS);
} }
@ -160,7 +167,7 @@ public abstract class TermsEnum implements BytesRefIterator {
* @param reuse pass a prior PostingsEnum for possible reuse * @param reuse pass a prior PostingsEnum for possible reuse
* @param flags specifies which optional per-document values * @param flags specifies which optional per-document values
* you require; see {@link PostingsEnum#FREQS} * you require; see {@link PostingsEnum#FREQS}
* @see #postings(Bits, PostingsEnum, int) */ */
public abstract PostingsEnum postings(Bits liveDocs, PostingsEnum reuse, int flags) throws IOException; public abstract PostingsEnum postings(Bits liveDocs, PostingsEnum reuse, int flags) throws IOException;
/** /**