Addded documentation for imagick. One new method and improved the previous ones

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@275287 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mikko Koppanen 2009-02-06 13:38:19 +00:00
parent b917ed474f
commit 055b453ec1
4 changed files with 107 additions and 7 deletions

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.imagick-pingimageblob">
<refnamediv>
<refname>Imagick::pingImageBlob</refname>
@ -15,7 +15,8 @@
&warn.undocumented.func;
<para>
This method can be used to query image width, height, size, and
format without reading the whole image to memory.
format without reading the whole image to memory. This method is available
if Imagick has been compiled against ImageMagick version 6.2.9 or newer.
</para>
</refsect1>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- $Revision: 1.9 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.imagick-pingimagefile">
<refnamediv>
<refname>Imagick::pingImageFile</refname>
@ -13,10 +13,11 @@
<methodparam><type>resource</type><parameter>filehandle</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>fileName</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
This method can be used to query image width, height, size, and
format without reading the whole image to memory.
format without reading the whole image to memory. This method is available
if Imagick has been compiled against ImageMagick version 6.2.9 or newer.
</para>
</refsect1>
@ -51,6 +52,33 @@
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Using <function>Imagick::pingImageFile</function></title>
<para>
Opening a remote location
</para>
<programlisting role="php">
<![CDATA[
<?php
/* fopen a remote location */
$fp = fopen("http://example.com/test.jpg");
/* create new imagick object */
$im = new Imagick();
/* pass the handle to imagick */
$im->pingImageFile($fp);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -0,0 +1,60 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.imagick-transposeimage">
<refnamediv>
<refname>Imagick::transposeImage</refname>
<refpurpose>Creates a vertical mirror image</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>Imagick::transposeImage</methodname>
<void/>
</methodsynopsis>
<para>
Creates a vertical mirror image by reflecting the pixels
around the central x-axis while rotating them 90-degrees.
This method is available if Imagick has been compiled against
ImageMagick version 6.2.9 or newer.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&imagick.return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>Imagick::transverseImage</function></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
-->

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.imagick-transverseimage">
<refnamediv>
<refname>Imagick::transverseImage</refname>
@ -12,10 +12,12 @@
<type>bool</type><methodname>Imagick::transverseImage</methodname>
<void/>
</methodsynopsis>
&warn.undocumented.func;
<para>
Creates a horizontal mirror image by reflecting the pixels around the
central y-axis while rotating them 270-degrees.
This method is available if Imagick has been compiled against
ImageMagick version 6.2.9 or newer.
</para>
</refsect1>
@ -26,6 +28,15 @@
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>Imagick::transposeImage</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file