cvs: phpdoc(REF_STRUCT_DEV) /en/reference/imagick/imagick trimimage.xml

mkoppanen Fri Nov 2 10:40:25 2007 UTC Modified files: (Branch: REF_STRUCT_DEV) /phpdoc/en/reference/imagick/imagick trimimage.xml Log: Added an example and parameter description. http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imagick/imagick/trimimage.xml?r1=1.6&r2=1.6.2.1&diff_format=u Index: phpdoc/en/reference/imagick/imagick/trimimage.xml diff -u phpdoc/en/reference/imagick/imagick/trimimage.xml:1.6 phpdoc/en/reference/imagick/imagick/trimimage.xml:1.6.2.1 --- phpdoc/en/reference/imagick/imagick/trimimage.xml:1.6 Tue Aug 28 02:02:52 2007 +++ phpdoc/en/reference/imagick/imagick/trimimage.xml Fri Nov 2 10:40:24 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.6.2.1 $ --> <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.imagick-trimimage"> <refnamediv> <refname>Imagick::trimImage</refname> @@ -27,6 +27,10 @@ <term><parameter>fuzz</parameter></term> <listitem> <para> + By default target must match a particular pixel color exactly. + However, in many cases two colors may differ by a small amount. + The fuzz member of image defines how much tolerance is acceptable + to consider two colors as the same. </para> </listitem> </varlistentry> @@ -74,36 +78,32 @@ </refsect1> --> - <!-- Use when examples exist - <refsect1 role="examples"> + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>A <function>Imagick::trimImage</function> example</title> + <title>Using <function>Imagick::trimImage</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 + Trim an image, then display to the browser. </para> <programlisting role="php"> <![CDATA[ <?php -if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; -} +/* Create the object and read the image in */ +$im = new Imagick( "image.jpg" ); + +/* Trim the image. */ +$im->trimImage( 0 ); + +/* Ouput the image */ +header( "Content-Type: image/" . $im->getImageFormat() ); +echo $im; ?> ]]> </programlisting> - &example.outputs; - <screen> -<![CDATA[ -Use the PEAR Coding Standards -]]> - </screen> </example> </para> </refsect1> - --> <!-- Use when adding See Also links <refsect1 role="seealso">