Skip to content

Commit

Permalink
Add return types in user guide comments
Browse files Browse the repository at this point in the history
  • Loading branch information
natanfelles committed Mar 29, 2023
1 parent 96b1fea commit 978d649
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Gets the image resolution.

.. code-block:: php
$resolution = $image->getResolution(); // int[]
$resolution = $image->getResolution(); // array of integers
The $resolution value will be an array like the following:

Expand All @@ -92,7 +92,7 @@ Gets the image quality/compression level.

.. code-block:: php
$quality = $image->getQuality(); // int|null
$quality = $image->getQuality(); // int or null
- Returns an integer for PNG and JPEG types or null for GIF.

Expand All @@ -114,7 +114,7 @@ Gets a file extension based in the image type.

.. code-block:: php
$extension = $image->getExtension(); // string|false
$extension = $image->getExtension(); // string or false
- Returns a string with the extension (e.g. *.png*) or false on fail.

Expand Down Expand Up @@ -304,7 +304,11 @@ Adds a watermark to the image.
$watermark->scale(100);
$horizontalPosition = -10;
$verticalPosition = -10;
$image->watermark($watermark, $horizontalPosition, $verticalPosition); // static
$image->watermark(
$watermark,
$horizontalPosition,
$verticalPosition
); // static
- Watermark must be an Image instance.
- Horizontal position direction is left-to-right when the value is positive, otherwise is right-to-left.
Expand Down

0 comments on commit 978d649

Please sign in to comment.