svn commit: r1666022 - /uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/text/AnnotationIndex.java

[sc...@apache.org]

Author: schor
Date: Wed Mar 11 21:56:36 2015
New Revision: 1666022

URL: http://svn.apache.org/r1666022
Log:
no Jira - clarify comment

Modified:
    uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/text/AnnotationIndex.java

Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/text/AnnotationIndex.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/text/AnnotationIndex.java?rev=1666022&r1=1666021&r2=1666022&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/text/AnnotationIndex.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/text/AnnotationIndex.java Wed Mar 11 21:56:36 2015
@@ -36,7 +36,7 @@ import org.apache.uima.cas.FSIterator;
  * annotations a and b, if <code>a.start &lt; b.start</code> then <code> a &lt; b</code>.</li>
  * <li>Annotations whose start offsets are equal are next sorted by <i>decreasing</i> order of
  * their end offsets. That is, if <code>a.start = b.start</code> and <code>a.end &gt; b.end</code>,
- * then <code> a &lt; b</code>. This causes annotations with larger to be sorted before
+ * then <code> a &lt; b</code>. This causes annotations with larger spans to be sorted before
  * annotations with smaller spans, which produces an iteration order similar to a preorder tree
  * traversal.</li>
  * <li>Annotations whose start offsets are equal and whose end offsets are equal are sorted based
@@ -61,8 +61,9 @@ public interface AnnotationIndex<T exten
    * <p>
    * A disambiguated iterator is defined as follows. The first annotation returned is the same as
    * would be returned by the corresponding ambiguous iterator. If the unambiguous iterator has
-   * returned a previously, it will next return the smallest b s.t. a &lt; b and a.getEnd() &lt;=
-   * b.getBegin().
+   * returned <code>a</code> previously, it will next return the smallest <code>b</code> s.t. a &lt; b and a.getEnd() &lt;=
+   * b.getBegin().  In other words, the <code>b</code> annotation's start will be large enough to not
+   * overlap the span of <code>a</code>.
    * </p>
    * 
    * @param ambiguous