Fixed parameter descriptions and added an example.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@241429 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mikko Koppanen 2007-08-17 10:59:26 +00:00
parent aef432a0f2
commit 0ed865e41e

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.imagick-chopimage">
<refnamediv>
<refname>Imagick::chopImage</refname>
@ -18,7 +18,7 @@
&warn.undocumented.func;
&warn.experimental.func;
<para>
Removes a region of an image and collapses the image to occupy the removed portion
Removes a region of an image and collapses the image to occupy the removed portion.
</para>
</refsect1>
@ -30,7 +30,7 @@
<term><parameter>width</parameter></term>
<listitem>
<para>
Its description
Width of the chopped area
</para>
</listitem>
</varlistentry>
@ -38,7 +38,7 @@
<term><parameter>height</parameter></term>
<listitem>
<para>
Its description
Height of the chopped area
</para>
</listitem>
</varlistentry>
@ -46,7 +46,7 @@
<term><parameter>x</parameter></term>
<listitem>
<para>
Its description
X origo of the chopped area
</para>
</listitem>
</varlistentry>
@ -54,7 +54,7 @@
<term><parameter>y</parameter></term>
<listitem>
<para>
Its description
Y origo of the chopped area
</para>
</listitem>
</varlistentry>
@ -102,48 +102,49 @@
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>Imagick::chopImage</function> example</title>
<title>Using <function>Imagick::chopImage</function>:</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
Example of using Imagick::chopImage
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
/* Create some objects */
$image = new Imagick();
$pixel = new ImagickPixel( 'gray' );
/* New image */
$image->newImage(400, 200, $pixel);
/* Chop image */
$image->chopImage(200, 200, 0, 0);
/* Give image a format */
$image->setImageFormat('png');
/* Output the image with headers */
header('Content-type: image/png');
echo $image;
?>
]]>
</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>
<member><function>Imagick::cropImage</function></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>