Added documentation and examples

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@279690 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mikko Koppanen 2009-05-01 22:48:41 +00:00
parent 3b8e047a6f
commit bd2b7e40f7
2 changed files with 76 additions and 4 deletions

View file

@ -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

View file

@ -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