[prev in list] [next in list] [prev in thread] [next in thread] 

List:       php-doc-cvs
Subject:    [DOC-CVS] =?utf-8?Q?[doc-en]_master:_Fix_return_type_(int_=E2=86=92_bool)_(#1359)?=
From:       Martin Samesch via GitHub <noreply () php ! net>
Date:       2022-03-29 20:18:00
Message-ID: WLVMKQs1AUaOdn1ELeypAWjK49yiSGoPESu0M55V8 () main ! php ! net
[Download RAW message or body]

Author: Martin Samesch (msamesch)
Committer: GitHub (web-flow)
Pusher: msamesch
Date: 2022-03-29T20:15:14Z

Commit: https://github.com/php/doc-en/commit/48754af1a118879dbc96d253a7448557dcb3e918
Raw diff: https://github.com/php/doc-en/commit/48754af1a118879dbc96d253a7448557dcb3e918.diff


Fix return type (int → bool) (#1359)

* Fix return type (int → bool)

Mentioned in doc-de #67 by Daijobou (thanks).
Changelog entry?

* added changelog (thanks saundefined)

* Section returnvalues adjusted

* Forgot to adjust description.

* Update reference/imagick/imagick/getimagealphachannel.xml

Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>

* Correct purpose

Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>

Changed paths:
  M  reference/imagick/imagick/getimagealphachannel.xml


Diff:

diff --git a/reference/imagick/imagick/getimagealphachannel.xml \
b/reference/imagick/imagick/getimagealphachannel.xml index 5d2a7991869..d65fe158b16 \
                100644
--- a/reference/imagick/imagick/getimagealphachannel.xml
+++ b/reference/imagick/imagick/getimagealphachannel.xml
@@ -3,20 +3,18 @@
 <refentry xmlns="http://docbook.org/ns/docbook" \
xml:id="imagick.getimagealphachannel">  <refnamediv>
   <refname>Imagick::getImageAlphaChannel</refname>
-  <refpurpose>Gets the image alpha channel</refpurpose>
+  <refpurpose>Checks if the image has an alpha channel</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> \
<type>int</type><methodname>Imagick::getImageAlphaChannel</methodname> +   \
<modifier>public</modifier> \
<type>bool</type><methodname>Imagick::getImageAlphaChannel</methodname>  <void />
   </methodsynopsis>
 
   <para>
-   Gets the image alpha channel value. The returned value is one of the 
-   <link linkend="imagick.constants.alphachannel">alpha channel constants</link>.
-   &imagick.method.available.0x640;
+   Returns whether the image has an alpha channel.
   </para>
  </refsect1>
 
@@ -28,11 +26,34 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns a constant defining the current alpha channel value. Refer to this
-   list of <link linkend="imagick.constants.alphachannel">alpha channel \
constants</link>. +   Returns &true; if the image has an alpha channel value and \
&false; if not, +   i.e. the image is <acronym>RGB</acronym> rather than \
<acronym>RGBA</acronym> +   or <acronym>CMYK</acronym> rather than \
<acronym>CMYKA</acronym>.  </para>
  </refsect1>
 
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <informaltable>
+   <tgroup cols="2">
+    <thead>
+     <row>
+      <entry>&Version;</entry>
+      <entry>&Description;</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry>imagick 3.6.0</entry>
+      <entry>
+       Returns a &boolean; now; previously, an &integer; was returned.
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
  <refsect1 role="errors">
   &reftitle.errors;
   <para>

-- 
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php


[prev in list] [next in list] [prev in thread] [next in thread]