...

...

@@ -1,4 +1,4 @@

1

-

<?xml version='1.0' encoding='iso-8859-1'?>

1

+

<?xml version="1.0" encoding="utf-8"?>

2

2

<!-- $Revision$ -->

3

3

<refentry xml:id="limititerator.seek" xmlns="http://docbook.org/ns/docbook">

4

4

<refnamediv>

...

...

@@ -7,13 +7,13 @@

7

7

</refnamediv>

8

8

<refsect1 role="description">

9

9

&reftitle.description;

10

-

<methodsynopsis>

11

-

<type>void</type><methodname>LimitIterator::seek</methodname>

12

-

<methodparam><type>int</type><parameter>position</parameter></methodparam>

10

+

<methodsynopsis role="LimitIterator">

11

+

<modifier>public</modifier> <type>int</type><methodname>LimitIterator::seek</methodname>

12

+

<methodparam><type>int</type><parameter>offset</parameter></methodparam>

13

13

</methodsynopsis>

14

-

15

-

&warn.undocumented.func;

16

-

14

+

<para>

15

+

Moves the iterator to the offset specified by <parameter>offset</parameter>.

16

+

</para>

17

17

</refsect1>

18

18

19

19

<refsect1 role="parameters">

...

...

@@ -21,10 +21,10 @@

21

21

<para>

22

22

<variablelist>

23

23

<varlistentry>

24

-

<term><parameter>position</parameter></term>

24

+

<term><parameter>offset</parameter></term>

25

25

<listitem>

26

26

<para>

27

-

The position being seeked to.

27

+

The position to seek to.

28

28

</para>

29

29

</listitem>

30

30

</varlistentry>

...

...

@@ -35,12 +35,32 @@

35

35

<refsect1 role="returnvalues">

36

36

&reftitle.returnvalues;

37

37

<para>

38

-

&return.void;

38

+

Returns the offset position after seeking.

39

39

</para>

40

40

</refsect1>

41

41

42

-

</refentry>

42

+

<refsect1 role="errors">

43

+

&reftitle.errors;

44

+

<para>

45

+

Throws an <classname>OutOfBoundsException</classname> if the position is

46

+

outside of the limits specified in <methodname>LimitIterator::__construct</methodname>.

47

+

</para>

48

+

</refsect1>

49

+

50

+

<refsect1 role="seealso">

51

+

&reftitle.seealso;

52

+

<para>

53

+

<simplelist>

54

+

<member><methodname>LimitIterator::current</methodname></member>

55

+

<member><methodname>LimitIterator::key</methodname></member>

56

+

<member><methodname>LimitIterator::rewind</methodname></member>

57

+

<member><methodname>LimitIterator::next</methodname></member>

58

+

<member><methodname>LimitIterator::valid</methodname></member>

59

+

</simplelist>

60

+

</para>

61

+

</refsect1>

43

62

63

+

</refentry>

44

64

<!-- Keep this comment at the end of the file

45

65

Local variables:

46

66

mode: sgml

47

67