reference/intl/intlbreakiterator/getpartsiterator.xml
1976eae0d815797af97a1e16c5cd90ffc2868395
...
...
@@ -1,6 +1,5 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
4
3
<refentry xml:id="intlbreakiterator.getpartsiterator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
4
<refnamediv>
6
5
<refname>IntlBreakIterator::getPartsIterator</refname>
...
...
@@ -9,9 +8,9 @@
9
8

10
9
<refsect1 role="description">
11
10
&reftitle.description;
12
-
<methodsynopsis>
13
-
<modifier>public</modifier> <type>ReturnType</type><methodname>IntlBreakIterator::getPartsIterator</methodname>
14
-
<methodparam choice="opt"><type>string</type><parameter>"key_type"</parameter></methodparam>
11
+
<methodsynopsis role="IntlBreakIterator">
12
+
<modifier>public</modifier> <type>IntlPartsIterator</type><methodname>IntlBreakIterator::getPartsIterator</methodname>
13
+
<methodparam choice="opt"><type>string</type><parameter>type</parameter><initializer>IntlPartsIterator::KEY_SEQUENTIAL</initializer></methodparam>
15
14
</methodsynopsis>
16
15
<para>
17
16

...
...
@@ -25,10 +24,24 @@
25
24
&reftitle.parameters;
26
25
<variablelist>
27
26
<varlistentry>
28
-
<term><parameter>"key_type"</parameter></term>
27
+
<term><parameter>type</parameter></term>
29
28
<listitem>
30
29
<para>
31
-
30
+
Optional key type. Possible values are:
31
+
<simplelist>
32
+
<member>
33
+
<constant>IntlPartsIterator::KEY_SEQUENTIAL</constant>
34
+
- The default. Sequentially increasing integers used as key.
35
+
</member>
36
+
<member>
37
+
<constant>IntlPartsIterator::KEY_LEFT</constant>
38
+
- Byte offset left of current part used as key.
39
+
</member>
40
+
<member>
41
+
<constant>IntlPartsIterator::KEY_RIGHT</constant>
42
+
- Byte offset right of current part used as key.
43
+
</member>
44
+
</simplelist>
32
45
</para>
33
46
</listitem>
34
47
</varlistentry>
...
...
@@ -44,7 +57,6 @@
44
57

45
58

46
59
</refentry>
47
-
48
60
<!-- Keep this comment at the end of the file
49
61
Local variables:
50
62
mode: sgml
51
63