svn commit: r1670418 - /lucene/dev/branches/lucene6271/lucene/core/src/java/org/apache/lucene/index/TermsEnum.java

[rm...@apache.org]

Author: rmuir
Date: Tue Mar 31 18:29:43 2015
New Revision: 1670418

URL: http://svn.apache.org/r1670418
Log:
LUCENE-6271: fix javadocs, don't @see yourself, and make it clear you don't get positions unless you ask

Modified:
    lucene/dev/branches/lucene6271/lucene/core/src/java/org/apache/lucene/index/TermsEnum.java

Modified: lucene/dev/branches/lucene6271/lucene/core/src/java/org/apache/lucene/index/TermsEnum.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene6271/lucene/core/src/java/org/apache/lucene/index/TermsEnum.java?rev=1670418&r1=1670417&r2=1670418&view=diff
==============================================================================
--- lucene/dev/branches/lucene6271/lucene/core/src/java/org/apache/lucene/index/TermsEnum.java (original)
+++ lucene/dev/branches/lucene6271/lucene/core/src/java/org/apache/lucene/index/TermsEnum.java Tue Mar 31 18:29:43 2015
@@ -141,10 +141,17 @@ public abstract class TermsEnum implemen
   /** Get {@link PostingsEnum} for the current term.  Do not
    *  call this when the enum is unpositioned.  This method
    *  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
    * 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 implemen
    * @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;
 
   /**