cvs: phpdoc /en/reference/imagick/imagick commentimage.xml
| From: | Mikko Koppanen | Date: | Sun, 07 Oct 2007 20:33:03 +0000 |
| Subject: | cvs: phpdoc /en/reference/imagick/imagick commentimage.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-173@lists.php.net to get a copy of this message | ||
mkoppanen Sun Oct 7 20:33:03 2007 UTC
Modified files:
/phpdoc/en/reference/imagick/imagick commentimage.xml
Log:
Added an example
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imagick/imagick/commentimage.xml?r1=1.5&r2=1.6&diff_format=u
Index: phpdoc/en/reference/imagick/imagick/commentimage.xml
diff -u phpdoc/en/reference/imagick/imagick/commentimage.xml:1.5
phpdoc/en/reference/imagick/imagick/commentimage.xml:1.6
--- phpdoc/en/reference/imagick/imagick/commentimage.xml:1.5 Tue Aug 21 07:24:14 2007
+++ phpdoc/en/reference/imagick/imagick/commentimage.xml Sun Oct 7 20:33:03 2007
@@ -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-commentimage">
<refnamediv>
<refname>Imagick::commentImage</refname>
@@ -75,36 +75,36 @@
</refsect1>
-->
- <!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
- <title>A <function>Imagick::commentImage</function> example</title>
+ <title>Using <function>Imagick::commentImage</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
+ Commenting an image and retrieving the comment:
</para>
<programlisting role="php">
<![CDATA[
<?php
-if ($anexample === true) {
- echo 'Use the PEAR Coding Standards';
-}
+
+/* Create new Imagick object */
+$im = new imagick();
+
+/* Create an empty image */
+$im->newImage(100, 100, new ImagickPixel("red"));
+
+/* Add comment to the image */
+$im->commentImage("Hello World!");
+
+/* Display the comment */
+echo $im->getImageProperty("comment");
+
?>
]]>
</programlisting>
- &example.outputs;
- <screen>
-<![CDATA[
-Use the PEAR Coding Standards
-]]>
- </screen>
</example>
</para>
</refsect1>
- -->
<!-- Use when adding See Also links
<refsect1 role="seealso">