From 3789a703c24395edfd0d1a3414a36748f52bb9d8 Mon Sep 17 00:00:00 2001
From: Mikko Koppanen <mkoppanen@php.net>
Date: Wed, 12 Sep 2007 22:20:01 +0000
Subject: [PATCH] Added documentation for Imagick::getImageLength()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@242477 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/imagick/imagick.xml                |   3 +-
 reference/imagick/imagick/getimagelength.xml | 132 +++++++++++++++++++
 2 files changed, 134 insertions(+), 1 deletion(-)
 create mode 100644 reference/imagick/imagick/getimagelength.xml

diff --git a/reference/imagick/imagick.xml b/reference/imagick/imagick.xml
index 00b2be9c37..09760b879a 100644
--- a/reference/imagick/imagick.xml
+++ b/reference/imagick/imagick.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.11 $ -->
+<!-- $Revision: 1.12 $ -->
 <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc.
 -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagick.imagick">
@@ -1046,6 +1046,7 @@
 &reference.imagick.imagick.getimageextrema;
 &reference.imagick.imagick.getimagefilename;
 &reference.imagick.imagick.getimagesize;
+&reference.imagick.imagick.getimagelength;
 &reference.imagick.imagick.getimageformat;
 &reference.imagick.imagick.getimagegamma;
 &reference.imagick.imagick.getimagegeometry;
diff --git a/reference/imagick/imagick/getimagelength.xml b/reference/imagick/imagick/getimagelength.xml
new file mode 100644
index 0000000000..095a1a8ed7
--- /dev/null
+++ b/reference/imagick/imagick/getimagelength.xml
@@ -0,0 +1,132 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.imagick-getimagelength">
+ <refnamediv>
+  <refname>Imagick::getImageLength</refname>
+  <refpurpose>Returns the image length in bytes</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>int</type><methodname>Imagick::getImageLength</methodname>
+   <void/>
+  </methodsynopsis>
+  &warn.undocumented.func;
+  &warn.experimental.func;
+  <para>
+   Returns the image length in bytes
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+  </para>
+
+ </refsect1>
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns an int containing the current image size.
+  </para>
+ </refsect1>
+
+ <!-- Use when ERRORS exist
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   When does this function throw E_* level errors, or exceptions?
+  </para>
+ </refsect1>
+ -->
+
+ <!-- Use when a CHANGELOG exists
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <para>
+   <informaltable>
+    <tgroup cols="2">
+     <thead>
+      <row>
+       <entry>&Version;</entry>
+       <entry>&Description;</entry>
+      </row>
+     </thead>
+     <tbody>
+      <row>
+       <entry>Enter the PHP version of change here</entry>
+       <entry>Description of change</entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </informaltable>
+  </para>
+ </refsect1>
+ -->
+
+ <!-- Use when examples exist
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>A <function>Imagick::getImageLength</function> example</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
+    </para>
+    <programlisting role="php">
+<![CDATA[
+<?php
+if ($anexample === true) {
+    echo 'Use the PEAR Coding Standards';
+}
+?>
+]]>
+    </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>
+   </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
+-->