You are viewing a plain text version of this content. The canonical link for it is here.

Posted to commits@lucene.apache.org by rm...@apache.org on 2015/03/31 20:32:14 UTC

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

Author: rmuir
Date: Tue Mar 31 18:32:13 2015
New Revision: 1670419

URL: http://svn.apache.org/r1670419
Log:
LUCENE-6271: add verbosity to sugar method on LeafReader too

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

Modified: lucene/dev/branches/lucene6271/lucene/core/src/java/org/apache/lucene/index/LeafReader.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene6271/lucene/core/src/java/org/apache/lucene/index/LeafReader.java?rev=1670419&r1=1670418&r2=1670419&view=diff
==============================================================================
--- lucene/dev/branches/lucene6271/lucene/core/src/java/org/apache/lucene/index/LeafReader.java (original)
+++ lucene/dev/branches/lucene6271/lucene/core/src/java/org/apache/lucene/index/LeafReader.java Tue Mar 31 18:32:13 2015
@@ -223,7 +223,14 @@ public abstract class LeafReader extends
   }
 
   /** Returns {@link PostingsEnum} for the specified term
-   *  with {@link PostingsEnum#FREQS}. */
+   *  with {@link PostingsEnum#FREQS}.
+   *  <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(Term, int) postings(term, PostingsEnum.FREQS)}
+   *  @see #postings(Term, int)
+   */
   public final PostingsEnum postings(Term term) throws IOException {
     return postings(term, PostingsEnum.FREQS);
   }