Author: schor
Date: Wed Jul 18 18:17:37 2018
New Revision: 1836212
URL: http://svn.apache.org/viewvc?rev=1836212&view=rev
Log:
[UIMA-5829] clarify docs for select between
Modified:
uima/uv3/uimaj-v3/trunk/uima-docbook-v3-users-guide/src/docbook/uv3.select.xml
Modified:
uima/uv3/uimaj-v3/trunk/uima-docbook-v3-users-guide/src/docbook/uv3.select.xml
URL:
http://svn.apache.org/viewvc/uima/uv3/uimaj-v3/trunk/uima-docbook-v3-users-guide/src/docbook/uv3.select.xml?rev=1836212&r1=1836211&r2=1836212&view=diff
==============================================================================
---
uima/uv3/uimaj-v3/trunk/uima-docbook-v3-users-guide/src/docbook/uv3.select.xml
(original)
+++
uima/uv3/uimaj-v3/trunk/uima-docbook-v3-users-guide/src/docbook/uv3.select.xml
Wed Jul 18 18:17:37 2018
@@ -389,7 +389,7 @@ FSIterator<Token> token_iterator =
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis role=""></emphasis>startAt</term>
+ <term><emphasis role="">startAt</emphasis></term>
<listitem>
<para>position the starting point of any iteration.
<code>startAt(xxx)</code> takes two forms, each
of which has, in turn 2 subforms.
@@ -476,10 +476,11 @@ startAt(begin, end, shifted) // same as
<term><emphasis role="strong">between</emphasis></term>
<listitem>
<para>uses two Annotations, and returns Annotations that are in
between
- the two bounds. If the bounds are
backwards, then they are automatically used in reverse order.
+ the two bounds, specified by Annotations.
If the bounds are backwards, then they are automatically used in reverse
order,
+ and the results are returned in reverse order.
The meaning of between is that an
included Annotation's begin has to be >= the earlier bound's
<code>end</code>,
and the Annotation's end has to be <=
the later bound's <code>begin</code>.
- </para>
+ </para>
</listitem>
</varlistentry>
</variablelist>
