cvs: phpdoc /en/reference/imagick imagick.xml /en/reference/imagick/imagick compareimages.xml

From: Date: Sat, 06 Oct 2007 15:39:59 +0000
Subject: cvs: phpdoc /en/reference/imagick imagick.xml /en/reference/imagick/imagick compareimages.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-154@lists.php.net to get a copy of this message
mkoppanen Sat Oct 6 15:39:59 2007 UTC Added files: /phpdoc/en/reference/imagick/imagick compareimages.xml Modified files: /phpdoc/en/reference/imagick imagick.xml Log: Added documentation for Imagick::compareImages http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imagick/imagick.xml?r1=1.16&r2=1.17&diff_format=u Index: phpdoc/en/reference/imagick/imagick.xml diff -u phpdoc/en/reference/imagick/imagick.xml:1.16 phpdoc/en/reference/imagick/imagick.xml:1.17 --- phpdoc/en/reference/imagick/imagick.xml:1.16 Sat Oct 6 15:31:03 2007 +++ phpdoc/en/reference/imagick/imagick.xml Sat Oct 6 15:39:59 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.16 $ --> +<!-- $Revision: 1.17 $ --> <!-- 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.modulateimage; &reference.imagick.imagick.montageimage; &reference.imagick.imagick.morphimages; +&reference.imagick.imagick.compareimages; &reference.imagick.imagick.mosaicimages; &reference.imagick.imagick.motionblurimage; &reference.imagick.imagick.negateimage; http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imagick/imagick/compareimages.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/imagick/imagick/compareimages.xml +++ phpdoc/en/reference/imagick/imagick/compareimages.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.imagick-compareimages"> <refnamediv> <refname>Imagick::compareImages</refname> <refpurpose>Compares an image to a reconstructed image</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>array</type><methodname>Imagick::compareImages</methodname> <methodparam><type>Imagick</type><parameter>compare</parameter></methodparam> <methodparam><type>int</type><parameter>metric</parameter></methodparam> </methodsynopsis> &warn.undocumented.func; &warn.experimental.func; <para> Returns an array containing a reconstructed image and the difference between images. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>compare</parameter></term> <listitem> <para> An image to compare to. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>metric</parameter></term> <listitem> <para> Provide a valid metric type constant. Refer to this list of <link linkend="imagick.constants.metric">metic constants</link>. </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>Using <function>Imagick::compareImages</function>:</title> <para> Compare images and display the reconstructed image </para> <programlisting role="php"> <![CDATA[ <?php $image1 = new imagick("image1.png"); $image2 = new imagick("image2.png"); $result = $image1->compareImage($image2, Imagick::METRIC_MEANSQUAREERROR); $result[0]->setImageFormat("png"); header("Content-Type: image/png"); echo $result[0]; ?> ]]> </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 -->

« previous php.doc.cvs (#154) next »