svn commit: r1836118 - /uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/cas/SelectFSs.java

[schor]

Author: schor
Date: Tue Jul 17 14:39:23 2018
New Revision: 1836118

URL: http://svn.apache.org/viewvc?rev=1836118&view=rev
Log:
[UIMA-5832] correct javadocs for select-following

Modified:
    
uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/cas/SelectFSs.java

Modified: 
uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/cas/SelectFSs.java
URL: 
http://svn.apache.org/viewvc/uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/cas/SelectFSs.java?rev=1836118&r1=1836117&r2=1836118&view=diff
==============================================================================
--- 
uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/cas/SelectFSs.java
 (original)
+++ 
uima/uv3/uimaj-v3/trunk/uimaj-core/src/main/java/org/apache/uima/cas/SelectFSs.java
 Tue Jul 17 14:39:23 2018
@@ -350,19 +350,19 @@ public interface SelectFSs<T extends Fea
   * ---------------------------------*/
   /**
    * For AnnotationIndex, position to first Annotation 
-   * whose begin &gt; fs.getEnd();
+   * whose begin &gt;= fs.getEnd();
    * @param annotation the Annotation to follow
    * @return the updated SelectFSs object
    */
   SelectFSs<T> following(Annotation annotation);
   /**
-   * For AnnotationIndex, position to first Annotation whose begin &gt; 
fs.getEnd();
+   * For AnnotationIndex, position to first Annotation whose begin &gt;= 
position;
    * @param position start following this position
    * @return the updated SelectFSs object
    */
   SelectFSs<T> following(int position);
   /**
-   * For AnnotationIndex, position to first Annotation whose begin &gt; 
fs.getEnd()
+   * For AnnotationIndex, position to first Annotation whose begin &gt;= 
fs.getEnd()
    *   and then adjust position by the offset
    * @param annotation start following this Annotation, adjusted for the offset
    * @param offset positive or negative shift amount to adjust starting 
position 
@@ -370,7 +370,7 @@ public interface SelectFSs<T extends Fea
    */
   SelectFSs<T> following(Annotation annotation, int offset);
   /**
-   * For AnnotationIndex, position to first Annotation whose begin &gt; 
position
+   * For AnnotationIndex, position to first Annotation whose begin &gt;= 
position
    *   and then adjust position by the offset.
    * @param position start following this position, adjusted for the offset
    * @param offset positive or negative shift amount to adjust starting 
position 
@@ -380,7 +380,8 @@ public interface SelectFSs<T extends Fea
 
   /**
    * For AnnotationIndex, set up a selection that will proceed backwards, 
-   * starting at the first Annotation whose end &lt;= fs.getBegin().
+   * starting at the first Annotation to the left of the specified position, 
+   * whose end &lt;= fs.getBegin().
    * Annotations whose end &gt; fs.getBegin() are skipped.
    * @param annotation the Annotation to use as the position to start before.
    * @return the updated SelectFSs object