From 78c1239c985c7968eb3f37527bfa9851dd6a5de7 Mon Sep 17 00:00:00 2001 From: Robert Muir Date: Tue, 31 Mar 2015 18:29:43 +0000 Subject: [PATCH] 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 --- .../src/java/org/apache/lucene/index/TermsEnum.java | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/lucene/core/src/java/org/apache/lucene/index/TermsEnum.java b/lucene/core/src/java/org/apache/lucene/index/TermsEnum.java index a822da69479..7844bd38ff6 100644 --- a/lucene/core/src/java/org/apache/lucene/index/TermsEnum.java +++ b/lucene/core/src/java/org/apache/lucene/index/TermsEnum.java @@ -141,10 +141,17 @@ public abstract class TermsEnum implements BytesRefIterator { /** Get {@link PostingsEnum} for the current term. Do not * call this when the enum is unpositioned. This method * will not return null. + *

+ * 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 * 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 { 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 flags specifies which optional per-document values * you require; see {@link PostingsEnum#FREQS} - * @see #postings(Bits, PostingsEnum, int) */ + */ public abstract PostingsEnum postings(Bits liveDocs, PostingsEnum reuse, int flags) throws IOException; /**