Update Imagick method synopses (#4118)

The argument names where wrong for a lot of methods.
php · Nov 22, 2024 · 3580683 · 3580683
1 parent 3e5fb06
commit 3580683
Show file tree

Hide file tree

Showing 511 changed files with 1,352 additions and 1,938 deletions.
diff --git a/reference/imagick/imagick/adaptiveblurimage.xml b/reference/imagick/imagick/adaptiveblurimage.xml
@@ -1,14 +1,14 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagick.adaptiveblurimage">
+<refentry xml:id="imagick.adaptiveblurimage" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>Imagick::adaptiveBlurImage</refname>
   <refpurpose>Adds adaptive blur filter to image</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
+  <methodsynopsis role="Imagick">
    <modifier>public</modifier> <type>bool</type><methodname>Imagick::adaptiveBlurImage</methodname>
    <methodparam><type>float</type><parameter>radius</parameter></methodparam>
    <methodparam><type>float</type><parameter>sigma</parameter></methodparam>
@@ -113,7 +113,6 @@ echo $image;
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/imagick/imagick/adaptiveresizeimage.xml b/reference/imagick/imagick/adaptiveresizeimage.xml
@@ -1,14 +1,14 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagick.adaptiveresizeimage">
+<refentry xml:id="imagick.adaptiveresizeimage" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>Imagick::adaptiveResizeImage</refname>
   <refpurpose>Adaptively resize image with data dependent triangulation</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
+  <methodsynopsis role="Imagick">
    <modifier>public</modifier> <type>bool</type><methodname>Imagick::adaptiveResizeImage</methodname>
    <methodparam><type>int</type><parameter>columns</parameter></methodparam>
    <methodparam><type>int</type><parameter>rows</parameter></methodparam>
@@ -144,7 +144,6 @@ echo $image;
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/imagick/imagick/adaptivesharpenimage.xml b/reference/imagick/imagick/adaptivesharpenimage.xml
@@ -1,14 +1,14 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagick.adaptivesharpenimage">
+<refentry xml:id="imagick.adaptivesharpenimage" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>Imagick::adaptiveSharpenImage</refname>
   <refpurpose>Adaptively sharpen the image</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
+  <methodsynopsis role="Imagick">
    <modifier>public</modifier> <type>bool</type><methodname>Imagick::adaptiveSharpenImage</methodname>
    <methodparam><type>float</type><parameter>radius</parameter></methodparam>
    <methodparam><type>float</type><parameter>sigma</parameter></methodparam>
@@ -97,7 +97,6 @@ echo $image;
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/imagick/imagick/adaptivethresholdimage.xml b/reference/imagick/imagick/adaptivethresholdimage.xml
@@ -1,14 +1,14 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagick.adaptivethresholdimage">
+<refentry xml:id="imagick.adaptivethresholdimage" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>Imagick::adaptiveThresholdImage</refname>
   <refpurpose>Selects a threshold for each pixel based on a range of intensity</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
+  <methodsynopsis role="Imagick">
    <modifier>public</modifier> <type>bool</type><methodname>Imagick::adaptiveThresholdImage</methodname>
    <methodparam><type>int</type><parameter>width</parameter></methodparam>
    <methodparam><type>int</type><parameter>height</parameter></methodparam>
@@ -87,7 +87,6 @@ function adaptiveThresholdImage($imagePath, $width, $height, $adaptiveOffset) {
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/imagick/imagick/addimage.xml b/reference/imagick/imagick/addimage.xml
@@ -1,16 +1,16 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagick.addimage">
+<refentry xml:id="imagick.addimage" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>Imagick::addImage</refname>
   <refpurpose>Adds new image to Imagick object image list</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
+  <methodsynopsis role="Imagick">
    <modifier>public</modifier> <type>bool</type><methodname>Imagick::addImage</methodname>
-   <methodparam><type>Imagick</type><parameter>source</parameter></methodparam>
+   <methodparam><type>Imagick</type><parameter>image</parameter></methodparam>
   </methodsynopsis>
   <para>
    Adds new image to Imagick object from the current position of the source object.
@@ -23,7 +23,7 @@
   <para>
    <variablelist>
     <varlistentry>
-     <term><parameter>source</parameter></term>
+     <term><parameter>image</parameter></term>
      <listitem>
       <para>
        The source Imagick object
@@ -49,7 +49,6 @@
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/imagick/imagick/addnoiseimage.xml b/reference/imagick/imagick/addnoiseimage.xml
@@ -1,16 +1,16 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagick.addnoiseimage">
+<refentry xml:id="imagick.addnoiseimage" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>Imagick::addNoiseImage</refname>
   <refpurpose>Adds random noise to the image</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
+  <methodsynopsis role="Imagick">
    <modifier>public</modifier> <type>bool</type><methodname>Imagick::addNoiseImage</methodname>
-   <methodparam><type>int</type><parameter>noise_type</parameter></methodparam>
+   <methodparam><type>int</type><parameter>noise</parameter></methodparam>
    <methodparam choice="opt"><type>int</type><parameter>channel</parameter><initializer>Imagick::CHANNEL_DEFAULT</initializer></methodparam>
   </methodsynopsis>
   <para>
@@ -23,7 +23,7 @@
   <para>
    <variablelist>
     <varlistentry>
-     <term><parameter>noise_type</parameter></term>
+     <term><parameter>noise</parameter></term>
      <listitem>
       <para>
        The type of the noise. Refer to this list of
@@ -75,7 +75,6 @@ function addNoiseImage($noiseType, $imagePath, $channel) {
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/imagick/imagick/affinetransformimage.xml b/reference/imagick/imagick/affinetransformimage.xml
@@ -1,16 +1,16 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagick.affinetransformimage">
+<refentry xml:id="imagick.affinetransformimage" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>Imagick::affineTransformImage</refname>
   <refpurpose>Transforms an image</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
+  <methodsynopsis role="Imagick">
    <modifier>public</modifier> <type>bool</type><methodname>Imagick::affineTransformImage</methodname>
-   <methodparam><type>ImagickDraw</type><parameter>matrix</parameter></methodparam>
+   <methodparam><type>ImagickDraw</type><parameter>settings</parameter></methodparam>
   </methodsynopsis>
   <para>
    Transforms an image as dictated by the affine matrix.
@@ -22,7 +22,7 @@
   <para>
    <variablelist>
     <varlistentry>
-     <term><parameter>matrix</parameter></term>
+     <term><parameter>settings</parameter></term>
      <listitem>
       <para>
        The affine matrix
@@ -78,7 +78,6 @@ function affineTransformImage($imagePath) {
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/imagick/imagick/animateimages.xml b/reference/imagick/imagick/animateimages.xml
@@ -1,14 +1,14 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagick.animateimages">
+<refentry xml:id="imagick.animateimages" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>Imagick::animateImages</refname>
   <refpurpose>Animates an image or images</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
+  <methodsynopsis role="Imagick">
    <modifier>public</modifier> <type>bool</type><methodname>Imagick::animateImages</methodname>
    <methodparam><type>string</type><parameter>x_server</parameter></methodparam>
   </methodsynopsis>
@@ -53,7 +53,6 @@
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/imagick/imagick/annotateimage.xml b/reference/imagick/imagick/annotateimage.xml
@@ -1,16 +1,16 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagick.annotateimage">
+<refentry xml:id="imagick.annotateimage" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>Imagick::annotateImage</refname>
   <refpurpose>Annotates an image with text</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
+  <methodsynopsis role="Imagick">
    <modifier>public</modifier> <type>bool</type><methodname>Imagick::annotateImage</methodname>
-   <methodparam><type>ImagickDraw</type><parameter>draw_settings</parameter></methodparam>
+   <methodparam><type>ImagickDraw</type><parameter>settings</parameter></methodparam>
    <methodparam><type>float</type><parameter>x</parameter></methodparam>
    <methodparam><type>float</type><parameter>y</parameter></methodparam>
    <methodparam><type>float</type><parameter>angle</parameter></methodparam>
@@ -26,7 +26,7 @@
   <para>
    <variablelist>
     <varlistentry>
-     <term><parameter>draw_settings</parameter></term>
+     <term><parameter>settings</parameter></term>
      <listitem>
       <para>
        The ImagickDraw object that contains settings for drawing the text
@@ -130,7 +130,6 @@ echo $image;
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/imagick/imagick/appendimages.xml b/reference/imagick/imagick/appendimages.xml
@@ -1,14 +1,14 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagick.appendimages">
+<refentry xml:id="imagick.appendimages" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>Imagick::appendImages</refname>
   <refpurpose>Append a set of images</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
+  <methodsynopsis role="Imagick">
    <modifier>public</modifier> <type>Imagick</type><methodname>Imagick::appendImages</methodname>
    <methodparam><type>bool</type><parameter>stack</parameter></methodparam>
   </methodsynopsis>
@@ -89,7 +89,6 @@ echo $combined;
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/imagick/imagick/autolevelimage.xml b/reference/imagick/imagick/autolevelimage.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-
 <refentry xml:id="imagick.autolevelimage" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Imagick::autoLevelImage</refname>
@@ -9,7 +8,7 @@
 
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
+  <methodsynopsis role="Imagick">
    <modifier>public</modifier> <type>bool</type><methodname>Imagick::autoLevelImage</methodname>
    <methodparam choice="opt"><type>int</type><parameter>channel</parameter><initializer>Imagick::CHANNEL_DEFAULT</initializer></methodparam>
   </methodsynopsis>
@@ -63,7 +62,6 @@ function autoLevelImage($imagePath) {
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/imagick/imagick/averageimages.xml b/reference/imagick/imagick/averageimages.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagick.averageimages">
+<refentry xml:id="imagick.averageimages" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>Imagick::averageImages</refname>
   <refpurpose>Average a set of images</refpurpose>
@@ -12,7 +12,7 @@
 
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
+  <methodsynopsis role="Imagick">
    <modifier>public</modifier> <type>Imagick</type><methodname>Imagick::averageImages</methodname>
    <void/>
   </methodsynopsis>
@@ -41,7 +41,6 @@
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/imagick/imagick/blackthresholdimage.xml b/reference/imagick/imagick/blackthresholdimage.xml
@@ -1,16 +1,16 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagick.blackthresholdimage">
+<refentry xml:id="imagick.blackthresholdimage" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>Imagick::blackThresholdImage</refname>
   <refpurpose>Forces all pixels below the threshold into black</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
+  <methodsynopsis role="Imagick">
    <modifier>public</modifier> <type>bool</type><methodname>Imagick::blackThresholdImage</methodname>
-   <methodparam><type>mixed</type><parameter>threshold</parameter></methodparam>
+   <methodparam><type class="union"><type>ImagickPixel</type><type>string</type></type><parameter>threshold_color</parameter></methodparam>
   </methodsynopsis>
   <para>
    Is like Imagick::thresholdImage() but forces all pixels below the threshold
@@ -23,7 +23,7 @@
   <para>
    <variablelist>
     <varlistentry>
-     <term><parameter>threshold</parameter></term>
+     <term><parameter>threshold_color</parameter></term>
      <listitem>
       <para>
        The threshold below which everything turns black
@@ -91,7 +91,6 @@ function blackThresholdImage($imagePath, $thresholdColor) {
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml