From 683af1898157443d6562ddc4474598e0b6245c7d Mon Sep 17 00:00:00 2001
From: Mikko Koppanen <mkoppanen@php.net>
Date: Wed, 23 Oct 2013 07:44:09 +0000
Subject: [PATCH] Added resource limit documentation Added constants Added note
 about destroy being deprecated

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@331919 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/imagick/constants.xml                 | 17 +++++++++++++++++
 .../imagick/imagick/compareimagechannels.xml    |  2 +-
 .../imagick/imagick/deleteimageartifact.xml     |  2 +-
 reference/imagick/imagick/destroy.xml           |  3 ++-
 reference/imagick/imagick/getresourcelimit.xml  |  2 +-
 reference/imagick/imagick/setresourcelimit.xml  |  6 +++++-
 6 files changed, 27 insertions(+), 5 deletions(-)

diff --git a/reference/imagick/constants.xml b/reference/imagick/constants.xml
index 9acd6f5cdc..88272de837 100644
--- a/reference/imagick/constants.xml
+++ b/reference/imagick/constants.xml
@@ -3309,6 +3309,7 @@
     </term>
     <listitem>
      <simpara>
+      Set the maximum width * height of an image that can reside in the pixel cache memory.
      </simpara>
     </listitem>
    </varlistentry>
@@ -3319,6 +3320,7 @@
     </term>
     <listitem>
      <simpara>
+      Set maximum amount of disk space in bytes permitted for use by the pixel cache.
      </simpara>
     </listitem>
    </varlistentry>
@@ -3329,6 +3331,7 @@
     </term>
     <listitem>
      <simpara>
+      Set maximum number of open pixel cache files.
      </simpara>
     </listitem>
    </varlistentry>
@@ -3339,6 +3342,7 @@
     </term>
     <listitem>
      <simpara>
+      Set maximum amount of memory map in bytes to allocate for the pixel cache.
      </simpara>
     </listitem>
    </varlistentry>
@@ -3349,6 +3353,19 @@
     </term>
     <listitem>
      <simpara>
+      Set maximum amount of memory in bytes to allocate for the pixel cache from the heap.
+     </simpara>
+    </listitem>
+   </varlistentry>
+   <varlistentry xml:id="imagick.constants.resourcetype-thread">
+    <term>
+     <constant>imagick::RESOURCETYPE_THREAD</constant>
+     (<type>integer</type>)
+    </term>
+    <listitem>
+     <simpara>
+      Set maximum parallel threads.
+      &imagick.constant.available; 6.7.8 or higher.
      </simpara>
     </listitem>
    </varlistentry>
diff --git a/reference/imagick/imagick/compareimagechannels.xml b/reference/imagick/imagick/compareimagechannels.xml
index ef0cbb55b6..5736f10df6 100644
--- a/reference/imagick/imagick/compareimagechannels.xml
+++ b/reference/imagick/imagick/compareimagechannels.xml
@@ -38,7 +38,7 @@
        Provide any channel constant that is valid for your channel mode. To
        apply to more than one channel, combine channeltype constants using
        bitwise operators. Refer to this
-       list of  <link linkend="imagick.constants.channel">channel constants</link>.
+       list of <link linkend="imagick.constants.channel">channel constants</link>.
       </para>
      </listitem>
     </varlistentry>
diff --git a/reference/imagick/imagick/deleteimageartifact.xml b/reference/imagick/imagick/deleteimageartifact.xml
index 2d95cb6a2c..731d066658 100644
--- a/reference/imagick/imagick/deleteimageartifact.xml
+++ b/reference/imagick/imagick/deleteimageartifact.xml
@@ -27,7 +27,7 @@
      <term><parameter>artifact</parameter></term>
      <listitem>
       <para>
-       The name of the artifact
+       The name of the artifact to delete
       </para>
      </listitem>
     </varlistentry>
diff --git a/reference/imagick/imagick/destroy.xml b/reference/imagick/imagick/destroy.xml
index eaf40afa1e..6be17e7226 100644
--- a/reference/imagick/imagick/destroy.xml
+++ b/reference/imagick/imagick/destroy.xml
@@ -13,7 +13,8 @@
    <void/>
   </methodsynopsis>
   <para>
-   Destroys the Imagick object and frees all resources associated with it.
+   Destroys the Imagick object and frees all resources associated with it. 
+   This method is deprecated in favour of <link linkend="imagick.clear">Imagick::clear</link>.
   </para>
  </refsect1>
 
diff --git a/reference/imagick/imagick/getresourcelimit.xml b/reference/imagick/imagick/getresourcelimit.xml
index 70147e09cc..54f3dace8c 100644
--- a/reference/imagick/imagick/getresourcelimit.xml
+++ b/reference/imagick/imagick/getresourcelimit.xml
@@ -13,7 +13,7 @@
    <methodparam><type>int</type><parameter>type</parameter></methodparam>
   </methodsynopsis>
   <para>
-   Returns the specified resource limit in megabytes.
+   Returns the specified resource limit.
   </para>
  </refsect1>
 
diff --git a/reference/imagick/imagick/setresourcelimit.xml b/reference/imagick/imagick/setresourcelimit.xml
index e2b7433a3a..81efab53bd 100644
--- a/reference/imagick/imagick/setresourcelimit.xml
+++ b/reference/imagick/imagick/setresourcelimit.xml
@@ -14,7 +14,8 @@
    <methodparam><type>int</type><parameter>limit</parameter></methodparam>
   </methodsynopsis>
   <para>
-   Sets the limit for a particular resource in megabytes.
+   This method is used to modify the resource limits of the underlying ImageMagick
+   library.
   </para>
  </refsect1>
 
@@ -26,6 +27,8 @@
      <term><parameter>type</parameter></term>
      <listitem>
       <para>
+       Refer to the list of <link 
+       linkend="imagick.constants.resourcetypes">resourcetype constants</link>.
       </para>
      </listitem>
     </varlistentry>
@@ -33,6 +36,7 @@
      <term><parameter>limit</parameter></term>
      <listitem>
       <para>
+       The resource limit. The unit depends on the type of the resource being limited.
       </para>
      </listitem>
     </varlistentry>