From f803440602fe09680c2d35b86fb0e22a9f54173f Mon Sep 17 00:00:00 2001
From: Mikko Koppanen <mkoppanen@php.net>
Date: Tue, 11 Sep 2007 20:28:10 +0000
Subject: [PATCH] Added documentation for Imagick::setImage()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@242421 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/imagick/imagick.xml          |   3 +-
 reference/imagick/imagick/setimage.xml | 141 +++++++++++++++++++++++++
 2 files changed, 143 insertions(+), 1 deletion(-)
 create mode 100644 reference/imagick/imagick/setimage.xml

diff --git a/reference/imagick/imagick.xml b/reference/imagick/imagick.xml
index 688bf1ee96..00b2be9c37 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.10 $ -->
+<!-- $Revision: 1.11 $ -->
 <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc.
 -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagick.imagick">
@@ -1111,6 +1111,7 @@
 &reference.imagick.imagick.motionblurimage;
 &reference.imagick.imagick.negateimage;
 &reference.imagick.imagick.newimage;
+&reference.imagick.imagick.setimage;
 &reference.imagick.imagick.newpseudoimage;
 &reference.imagick.imagick.nextimage;
 &reference.imagick.imagick.normalizeimage;
diff --git a/reference/imagick/imagick/setimage.xml b/reference/imagick/imagick/setimage.xml
new file mode 100644
index 0000000000..76d669c41d
--- /dev/null
+++ b/reference/imagick/imagick/setimage.xml
@@ -0,0 +1,141 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.imagick-setimage">
+ <refnamediv>
+  <refname>Imagick::setImage</refname>
+  <refpurpose>Replaces image in the object</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>Imagick::setImage</methodname>
+   <methodparam><type>Imagick</type><parameter>replace</parameter></methodparam>
+  </methodsynopsis>
+  &warn.undocumented.func;
+  &warn.experimental.func;
+  <para>
+   Replaces the current image sequence with the image from replace object.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>replace</parameter></term>
+     <listitem>
+      <para>
+       The replace Imagick object
+      </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>
+ -->
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>A <function>Imagick::setImage</function> example</title>
+    <para>
+     An example of using Imagick::setImage()
+    </para>
+    <programlisting role="php">
+<![CDATA[
+<?php
+/* Create the objects */
+$image = new Imagick('source.jpg');
+$replace = new Imagick('replace.jpg');
+
+/* source.jpg is replaced with replace.jpg */
+$image->setImage($replace);
+
+/* output the image */
+header('Content-type: image/jpeg');
+echo $image;
+
+?>
+]]>
+    </programlisting>
+   </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
+-->