cvs: phpdoc(REF_STRUCT_DEV) /en/reference/imagick/imagick queryfontmetrics.xml
| From: | Mikko Koppanen | Date: | Tue, 23 Oct 2007 07:40:21 +0000 |
| Subject: | cvs: phpdoc(REF_STRUCT_DEV) /en/reference/imagick/imagick queryfontmetrics.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-259@lists.php.net to get a copy of this message | ||
mkoppanen Tue Oct 23 07:40:21 2007 UTC
Modified files: (Branch: REF_STRUCT_DEV)
/phpdoc/en/reference/imagick/imagick queryfontmetrics.xml
Log:
Added an example, fixed the description, removed tab indent
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imagick/imagick/queryfontmetrics.xml?r1=1.2&r2=1.2.2.1&diff_format=u
Index: phpdoc/en/reference/imagick/imagick/queryfontmetrics.xml
diff -u phpdoc/en/reference/imagick/imagick/queryfontmetrics.xml:1.2
phpdoc/en/reference/imagick/imagick/queryfontmetrics.xml:1.2.2.1
--- phpdoc/en/reference/imagick/imagick/queryfontmetrics.xml:1.2 Thu Aug 23 09:04:26 2007
+++ phpdoc/en/reference/imagick/imagick/queryfontmetrics.xml Tue Oct 23 07:40:21 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.2.2.1 $ -->
<refentry xmlns="http://docbook.org/ns/docbook"
xml:id="function.imagick-queryfontmetrics">
<refnamediv>
<refname>Imagick::queryFontMetrics</refname>
@@ -17,7 +17,7 @@
&warn.undocumented.func;
&warn.experimental.func;
<para>
- Returns a 13 element array representing the font metrics.
+ Returns a multi-dimensional array representing the font metrics.
</para>
</refsect1>
@@ -29,7 +29,7 @@
<term><parameter>properties</parameter></term>
<listitem>
<para>
- ImagickDraw containing font properties
+ ImagickDraw object containing font properties
</para>
</listitem>
</varlistentry>
@@ -37,7 +37,7 @@
<term><parameter>text</parameter></term>
<listitem>
<para>
- The text
+ The text
</para>
</listitem>
</varlistentry>
@@ -45,7 +45,7 @@
<term><parameter>multiline</parameter></term>
<listitem>
<para>
- Multiline parameter. If left empty it is autodetected
+ Multiline parameter. If left empty it is autodetected
</para>
</listitem>
</varlistentry>
@@ -95,36 +95,34 @@
</refsect1>
-->
- <!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
- <title>A <function>Imagick::queryFontMetrics</function> example</title>
+ <title>Using <function>Imagick::queryFontMetrics</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
+ Query the metrics for the text and dump the results on the screen.
</para>
<programlisting role="php">
<![CDATA[
<?php
-if ($anexample === true) {
- echo 'Use the PEAR Coding Standards';
-}
+/* Create a new Imagick object */
+$im = new Imagick();
+
+/* Create an ImagickDraw object */
+$draw = new ImagickDraw();
+
+/* Set the font */
+$draw->setFont('/path/to/font.ttf');
+
+/* Dump the font metrics, autodetect multiline */
+var_dump($im->queryFontMetrics($draw, "Hello World!"));
?>
]]>
</programlisting>
- &example.outputs;
- <screen>
-<![CDATA[
-Use the PEAR Coding Standards
-]]>
- </screen>
</example>
</para>
</refsect1>
- -->
<!-- Use when adding See Also links
<refsect1 role="seealso">