Doc #63986 [Opn->Nab]: Documentation needs improving
| From: | googleguy@php.net | Date: | Wed, 16 Jan 2013 12:15:56 +0000 |
| Subject: | Doc #63986 [Opn->Nab]: Documentation needs improving | ||
| References: | 1 | Groups: | php.doc.bugs |
| Request: | Send a blank email to doc-bugs+get-9419@lists.php.net to get a copy of this message | ||
Edit report at https://bugs.php.net/bug.php?id=63986&edit=1
ID: 63986
Updated by: googleguy@php.net
Reported by: stuart at m2n dot co dot uk
Summary: Documentation needs improving
-Status: Open
+Status: Not a bug
Type: Documentation Problem
Package: Documentation problem
Operating System: N/A
PHP Version: Irrelevant
Block user comment: N
Private report: N
New Comment:
The description of the Imagick::shadeImage method is taken directly from the ImageMagick
API documentation found at http://www.imagemagick.org/api/effect.php which
states the
following:
"ShadeImage() shines a distant light on an image to create a three-dimensional effect. You
control the positioning of the light with azimuth and elevation; azimuth is measured in
degrees off the x axis and elevation is measured in pixels above the Z axis."
This seems to make PHP's documentation inline with the ImageMagick API docs.
The only thing I see lacking here is that we do not document what Errors/Exceptions the
method throws. That much I can fix.
Previous Comments:
------------------------------------------------------------------------
[2013-01-14 14:22:27] stuart at m2n dot co dot uk
Description:
------------
---
From manual page: http://www.php.net/imagick.shadeimage#refsect1-imagick.shadeimage-parameters
---
The azimuth is the number of degrees.
The elevation is the distance along the Z axis in pixels. So 20 is 20 pixels above the surface of
the image.
------------------------------------------------------------------------
--
Edit this bug report at https://bugs.php.net/bug.php?id=63986&edit=1