cvs commit: jakarta-lucene/src/java/org/apache/lucene/index TermPositions.java

[otis]

otis        2002/06/05 10:12:59

  Modified:    src/java/org/apache/lucene/index TermPositions.java
  Log:
  - Fixed class Javadoc (spelling, missing words), reformatted a bit.
  
  Revision  Changes    Path
  1.3       +19 -14    
jakarta-lucene/src/java/org/apache/lucene/index/TermPositions.java
  
  Index: TermPositions.java
  ===================================================================
  RCS file: 
/home/cvs/jakarta-lucene/src/java/org/apache/lucene/index/TermPositions.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- TermPositions.java        25 Dec 2001 19:27:04 -0000      1.2
  +++ TermPositions.java        5 Jun 2002 17:12:59 -0000       1.3
  @@ -58,18 +58,23 @@
   import org.apache.lucene.document.Document;
   
   
  -/** TermPositions provides an interface for enumerating the <document,
  -  frequency, &lt;position&gt;* &gt; tuples for a term.  <p> The document and
  -  frequency are as for a TermDocs.  The positions portion lists the ordinal
  -  positions of each occurence of a term in a document.
  -  @see IndexReader#termPositions
  -  */
  +/**
  + * TermPositions provides an interface for enumerating the &lt;document,
  + * frequency, &lt;position&gt;* &gt; tuples for a term.  <p> The document and
  + * frequency are the same as for a TermDocs.  The positions portion lists the 
ordinal
  + * positions of each occurrence of a term in a document.
  + *
  + * @see IndexReader#termPositions
  + */
   
  -public interface TermPositions extends TermDocs {
  -  /** Returns next position in the current document.  It is an error to call
  -    this more than {@link #freq()} times
  -    without calling {@link #next()}<p> This is
  -    invalid until {@link #next()} is called for
  -    the first time.*/
  -  int nextPosition() throws IOException;
  -}  
  +public interface TermPositions
  +    extends TermDocs
  +{
  +    /** Returns next position in the current document.  It is an error to call
  +     this more than {@link #freq()} times
  +     without calling {@link #next()}<p> This is
  +     invalid until {@link #next()} is called for
  +     the first time.
  +    */
  +    int nextPosition() throws IOException;
  +}
  
  
  

--
To unsubscribe, e-mail:   <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>