From e1abcce992476ac5bf50372256839aaded88c71e Mon Sep 17 00:00:00 2001
From: Mikko Koppanen <mkoppanen@php.net>
Date: Mon, 10 Sep 2007 21:07:03 +0000
Subject: [PATCH] Added documentation for Imagick::setIteratorIndex and
 Imagick::getIteratorIndex

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@242388 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/imagick/imagick.xml                 |   4 +-
 .../imagick/imagick/getiteratorindex.xml      | 133 ++++++++++++++++
 .../imagick/imagick/setiteratorindex.xml      | 142 ++++++++++++++++++
 3 files changed, 278 insertions(+), 1 deletion(-)
 create mode 100644 reference/imagick/imagick/getiteratorindex.xml
 create mode 100644 reference/imagick/imagick/setiteratorindex.xml

diff --git a/reference/imagick/imagick.xml b/reference/imagick/imagick.xml
index 4c70cc7983..688bf1ee96 100644
--- a/reference/imagick/imagick.xml
+++ b/reference/imagick/imagick.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.9 $ -->
+<!-- $Revision: 1.10 $ -->
 <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc.
 -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagick.imagick">
@@ -1053,6 +1053,7 @@
 &reference.imagick.imagick.getimageheight;
 &reference.imagick.imagick.getimagehistogram;
 &reference.imagick.imagick.getimageindex;
+&reference.imagick.imagick.getiteratorindex;
 &reference.imagick.imagick.getimageinterlacescheme;
 &reference.imagick.imagick.getimageinterpolatemethod;
 &reference.imagick.imagick.getimageiterations;
@@ -1166,6 +1167,7 @@
 &reference.imagick.imagick.setimagegamma;
 &reference.imagick.imagick.setimagegreenprimary;
 &reference.imagick.imagick.setimageindex;
+&reference.imagick.imagick.setiteratorindex;
 &reference.imagick.imagick.setimageinterlacescheme;
 &reference.imagick.imagick.setimageinterpolatemethod;
 &reference.imagick.imagick.setimageiterations;
diff --git a/reference/imagick/imagick/getiteratorindex.xml b/reference/imagick/imagick/getiteratorindex.xml
new file mode 100644
index 0000000000..2def582623
--- /dev/null
+++ b/reference/imagick/imagick/getiteratorindex.xml
@@ -0,0 +1,133 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.imagick-getiteratorindex">
+ <refnamediv>
+  <refname>Imagick::getIteratorIndex</refname>
+  <refpurpose>Gets the index of the current active image</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>int</type><methodname>Imagick::getIteratorIndex</methodname>
+   <void/>
+  </methodsynopsis>
+  &warn.undocumented.func;
+  &warn.experimental.func;
+  <para>
+   Returns the index of the current active image within the Imagick object.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+  </para>
+
+ </refsect1>
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns an integer containing the index of the image in the stack,
+   throwing ImagickException on error.
+  </para>
+ </refsect1>
+
+ <!-- Use when ERRORS exist
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   When does this function throw E_* level errors, or exceptions?
+  </para>
+ </refsect1>
+ -->
+
+ <!-- Use when a CHANGELOG exists
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <para>
+   <informaltable>
+    <tgroup cols="2">
+     <thead>
+      <row>
+       <entry>&Version;</entry>
+       <entry>&Description;</entry>
+      </row>
+     </thead>
+     <tbody>
+      <row>
+       <entry>Enter the PHP version of change here</entry>
+       <entry>Description of change</entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </informaltable>
+  </para>
+ </refsect1>
+ -->
+
+ <!-- Use when examples exist
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>A <function>Imagick::getIteratorIndex</function> example</title>
+    <para>
+     Any text that describes the purpose of the example, or
+     what goes on in the example should go here (inside the
+     <example> tag, not out
+    </para>
+    <programlisting role="php">
+<![CDATA[
+<?php
+if ($anexample === true) {
+    echo 'Use the PEAR Coding Standards';
+}
+?>
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+Use the PEAR Coding Standards
+]]>
+    </screen>
+   </example>
+  </para>
+ </refsect1>
+ -->
+
+ <!-- Use when adding See Also links
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function></function></member>
+    <member>Or <link linkend="somethingelse">something else</link></member>
+   </simplelist>
+  </para>
+ </refsect1>
+ -->
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/imagick/imagick/setiteratorindex.xml b/reference/imagick/imagick/setiteratorindex.xml
new file mode 100644
index 0000000000..31b3c21ea3
--- /dev/null
+++ b/reference/imagick/imagick/setiteratorindex.xml
@@ -0,0 +1,142 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.imagick-setiteratorindex">
+ <refnamediv>
+  <refname>Imagick::setIteratorIndex</refname>
+  <refpurpose>Returns the index of the current active image</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>Imagick::setIteratorIndex</methodname>
+   <methodparam><type>int</type><parameter>index</parameter></methodparam>
+  </methodsynopsis>
+  &warn.undocumented.func;
+  &warn.experimental.func;
+  <para>
+   Returns the index of the current active image within the Imagick object.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>index</parameter></term>
+     <listitem>
+      <para>
+	  The image number to set the index to
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &imagick.return.success;
+  </para>
+ </refsect1>
+
+ <!-- Use when ERRORS exist
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   When does this function throw E_* level errors, or exceptions?
+  </para>
+ </refsect1>
+ -->
+
+ <!-- Use when a CHANGELOG exists
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <para>
+   <informaltable>
+    <tgroup cols="2">
+     <thead>
+      <row>
+       <entry>&Version;</entry>
+       <entry>&Description;</entry>
+      </row>
+     </thead>
+     <tbody>
+      <row>
+       <entry>Enter the PHP version of change here</entry>
+       <entry>Description of change</entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </informaltable>
+  </para>
+ </refsect1>
+ -->
+
+ <!-- Use when examples exist
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>A <function>Imagick::setIteratorIndex</function> example</title>
+    <para>
+     Any text that describes the purpose of the example, or
+     what goes on in the example should go here (inside the
+     <example> tag, not out
+    </para>
+    <programlisting role="php">
+<![CDATA[
+<?php
+if ($anexample === true) {
+    echo 'Use the PEAR Coding Standards';
+}
+?>
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+Use the PEAR Coding Standards
+]]>
+    </screen>
+   </example>
+  </para>
+ </refsect1>
+ -->
+
+ <!-- Use when adding See Also links
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function></function></member>
+    <member>Or <link linkend="somethingelse">something else</link></member>
+   </simplelist>
+  </para>
+ </refsect1>
+ -->
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->