Author: schor Date: Tue Jul 17 21:41:22 2018 New Revision: 1836136 URL: http://svn.apache.org/viewvc?rev=1836136&view=rev Log: [UIMA-5828] update doc to specify iteration order for preceding as being forwards (by default)
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=1836136&r1=1836135&r2=1836136&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 Tue Jul 17 21:41:22 2018 @@ -638,10 +638,10 @@ startAt(begin, end, shifted) // same as <title>Following or Preceding</title> <para>For an Annotation Index, you can specify all Feature Structures following or preceding a position. - The position can be specified either as a Feature Structure, or by specifying an annotation begin index and - an optional offset. Note that the positioning arguments differ from the <code>startAt</code> specification, + The position can be specified either as an Annotation or by specifying an annotation begin index. + Both of these can have an additional shift offset amount as a 2nd parameter. + Note that the positioning arguments differ from the <code>startAt</code> specification, which uses both begin and end values. - by using begin and end values. </para> <variablelist> @@ -666,7 +666,7 @@ startAt(begin, end, shifted) // same as the positioning Annotation's <code>begin</code>value. </para> <para>If the position is specified as an int, treat this as the begin value.</para> - + <para>Once positioned, the actual iteration starts at the beginning and ends at the last position.</para> </listitem> </varlistentry> </variablelist>