From bd2b7e40f795868856449e2ad32c806c13803241 Mon Sep 17 00:00:00 2001
From: Mikko Koppanen <mkoppanen@php.net>
Date: Fri, 1 May 2009 22:48:41 +0000
Subject: [PATCH] Added documentation and examples

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@279690 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../imagick/imagick/getiteratorindex.xml      | 40 ++++++++++++++++++-
 .../imagick/imagick/setiteratorindex.xml      | 40 ++++++++++++++++++-
 2 files changed, 76 insertions(+), 4 deletions(-)

diff --git a/reference/imagick/imagick/getiteratorindex.xml b/reference/imagick/imagick/getiteratorindex.xml
index 74878ca4cf..5b9ca5439f 100644
--- a/reference/imagick/imagick/getiteratorindex.xml
+++ b/reference/imagick/imagick/getiteratorindex.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.imagick-getiteratorindex">
  <refnamediv>
   <refname>Imagick::getIteratorIndex</refname>
@@ -12,7 +12,7 @@
    <type>int</type><methodname>Imagick::getIteratorIndex</methodname>
    <void/>
   </methodsynopsis>
-  &warn.undocumented.func;
+
   <para>
    Returns the index of the current active image within the Imagick object.
   </para>
@@ -26,6 +26,42 @@
   </para>
  </refsect1>
 
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>Using <function>Imagick::getIteratorIndex</function>:</title>
+    <para>
+     Create images, set and get the iterator index
+    </para>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$im = new Imagick();
+$im->newImage(100, 100, new ImagickPixel("red"));
+$im->newImage(100, 100, new ImagickPixel("green"));
+$im->newImage(100, 100, new ImagickPixel("blue"));
+
+$im->setIteratorIndex(1);
+echo $im->getIteratorIndex();
+?>
+]]>
+    </programlisting>
+   </example>
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>Imagick::setIteratorIndex</function></member>
+    <member><function>Imagick::getImageIndex</function></member>
+    <member><function>Imagick::setImageIndex</function></member>
+   </simplelist>
+  </para>
+ </refsect1>
+
 </refentry>
 
 <!-- Keep this comment at the end of the file
diff --git a/reference/imagick/imagick/setiteratorindex.xml b/reference/imagick/imagick/setiteratorindex.xml
index d52d0dcf46..e964f9a490 100644
--- a/reference/imagick/imagick/setiteratorindex.xml
+++ b/reference/imagick/imagick/setiteratorindex.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.imagick-setiteratorindex">
  <refnamediv>
   <refname>Imagick::setIteratorIndex</refname>
@@ -12,7 +12,7 @@
    <type>bool</type><methodname>Imagick::setIteratorIndex</methodname>
    <methodparam><type>int</type><parameter>index</parameter></methodparam>
   </methodsynopsis>
-  &warn.undocumented.func;
+
   <para>
   Set the iterator to the position in the image list specified with the index parameter
   </para>
@@ -41,6 +41,42 @@
   </para>
  </refsect1>
 
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>Using <function>Imagick::setIteratorIndex</function>:</title>
+    <para>
+     Create images, set and get the iterator index
+    </para>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$im = new Imagick();
+$im->newImage(100, 100, new ImagickPixel("red"));
+$im->newImage(100, 100, new ImagickPixel("green"));
+$im->newImage(100, 100, new ImagickPixel("blue"));
+
+$im->setIteratorIndex(1);
+echo $im->getIteratorIndex();
+?>
+]]>
+    </programlisting>
+   </example>
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>Imagick::getIteratorIndex</function></member>
+    <member><function>Imagick::getImageIndex</function></member>
+    <member><function>Imagick::setImageIndex</function></member>
+   </simplelist>
+  </para>
+ </refsect1>
+
 </refentry>
 
 <!-- Keep this comment at the end of the file