Add @return phpdoc to ReturnTypeWillChange methods (#846)

php-imagine · Apr 17, 2023 · af19547 · af19547
1 parent c10ea7f
commit af19547
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 1 deletion.
diff --git a/src/Gd/Layers.php b/src/Gd/Layers.php
@@ -106,6 +106,8 @@ public function animate($format, $delay, $loops)
      * {@inheritdoc}
      *
      * @see \Iterator::current()
+     *
+     * @return mixed
      */
     #[\ReturnTypeWillChange]
     public function current()
@@ -117,6 +119,8 @@ public function current()
      * {@inheritdoc}
      *
      * @see \Iterator::key()
+     *
+     * @return mixed
      */
     #[\ReturnTypeWillChange]
     public function key()
@@ -128,6 +132,8 @@ public function key()
      * {@inheritdoc}
      *
      * @see \Iterator::next()
+     *
+     * @return mixed
      */
     #[\ReturnTypeWillChange]
     public function next()
@@ -139,6 +145,8 @@ public function next()
      * {@inheritdoc}
      *
      * @see \Iterator::rewind()
+     *
+     * @return void
      */
     #[\ReturnTypeWillChange]
     public function rewind()
@@ -150,6 +158,8 @@ public function rewind()
      * {@inheritdoc}
      *
      * @see \Iterator::valid()
+     *
+     * @return bool
      */
     #[\ReturnTypeWillChange]
     public function valid()
@@ -161,6 +171,8 @@ public function valid()
      * {@inheritdoc}
      *
      * @see \Countable::count()
+     *
+     * @return int
      */
     #[\ReturnTypeWillChange]
     public function count()
@@ -172,6 +184,8 @@ public function count()
      * {@inheritdoc}
      *
      * @see \ArrayAccess::offsetExists()
+     *
+     * @return bool
      */
     #[\ReturnTypeWillChange]
     public function offsetExists($offset)
@@ -183,6 +197,8 @@ public function offsetExists($offset)
      * {@inheritdoc}
      *
      * @see \ArrayAccess::offsetGet()
+     *
+     * @return mixed
      */
     #[\ReturnTypeWillChange]
     public function offsetGet($offset)
@@ -198,6 +214,8 @@ public function offsetGet($offset)
      * {@inheritdoc}
      *
      * @see \ArrayAccess::offsetSet()
+     *
+     * @return void
      */
     #[\ReturnTypeWillChange]
     public function offsetSet($offset, $value)
@@ -209,6 +227,8 @@ public function offsetSet($offset, $value)
      * {@inheritdoc}
      *
      * @see \ArrayAccess::offsetUnset()
+     *
+     * @return void
      */
     #[\ReturnTypeWillChange]
     public function offsetUnset($offset)

diff --git a/src/Gmagick/Layers.php b/src/Gmagick/Layers.php
@@ -142,6 +142,8 @@ public function animate($format, $delay, $loops)
      * {@inheritdoc}
      *
      * @see \Iterator::current()
+     *
+     * @return mixed
      */
     #[\ReturnTypeWillChange]
     public function current()
@@ -176,6 +178,8 @@ private function extractAt($offset)
      * {@inheritdoc}
      *
      * @see \Iterator::key()
+     *
+     * @return mixed
      */
     #[\ReturnTypeWillChange]
     public function key()
@@ -187,6 +191,8 @@ public function key()
      * {@inheritdoc}
      *
      * @see \Iterator::next()
+     *
+     * @return mixed
      */
     #[\ReturnTypeWillChange]
     public function next()
@@ -198,6 +204,8 @@ public function next()
      * {@inheritdoc}
      *
      * @see \Iterator::rewind()
+     *
+     * @return void
      */
     #[\ReturnTypeWillChange]
     public function rewind()
@@ -209,6 +217,8 @@ public function rewind()
      * {@inheritdoc}
      *
      * @see \Iterator::valid()
+     *
+     * @return bool
      */
     #[\ReturnTypeWillChange]
     public function valid()
@@ -220,6 +230,8 @@ public function valid()
      * {@inheritdoc}
      *
      * @see \Countable::count()
+     *
+     * @return int
      */
     #[\ReturnTypeWillChange]
     public function count()
@@ -235,6 +247,8 @@ public function count()
      * {@inheritdoc}
      *
      * @see \ArrayAccess::offsetExists()
+     *
+     * @return bool
      */
     #[\ReturnTypeWillChange]
     public function offsetExists($offset)
@@ -246,6 +260,8 @@ public function offsetExists($offset)
      * {@inheritdoc}
      *
      * @see \ArrayAccess::offsetGet()
+     *
+     * @return mixed
      */
     #[\ReturnTypeWillChange]
     public function offsetGet($offset)
@@ -257,6 +273,8 @@ public function offsetGet($offset)
      * {@inheritdoc}
      *
      * @see \ArrayAccess::offsetSet()
+     *
+     * @return void
      */
     #[\ReturnTypeWillChange]
     public function offsetSet($offset, $image)
@@ -309,6 +327,8 @@ public function offsetSet($offset, $image)
      * {@inheritdoc}
      *
      * @see \ArrayAccess::offsetUnset()
+     *
+     * @return void
      */
     #[\ReturnTypeWillChange]
     public function offsetUnset($offset)

diff --git a/src/Image/Histogram/Bucket.php b/src/Image/Histogram/Bucket.php
@@ -51,7 +51,9 @@ public function add($value)
     }
 
     /**
-     * @return int the number of elements in the bucket
+     * Get the number of elements in the bucket.
+     *
+     * @return int
      */
     #[\ReturnTypeWillChange]
     public function count()

diff --git a/src/Imagick/Layers.php b/src/Imagick/Layers.php
@@ -154,6 +154,8 @@ public function coalesce()
      * {@inheritdoc}
      *
      * @see \Iterator::current()
+     *
+     * @return mixed
      */
     #[\ReturnTypeWillChange]
     public function current()
@@ -188,6 +190,8 @@ private function extractAt($offset)
      * {@inheritdoc}
      *
      * @see \Iterator::key()
+     *
+     * @return mixed
      */
     #[\ReturnTypeWillChange]
     public function key()
@@ -199,6 +203,8 @@ public function key()
      * {@inheritdoc}
      *
      * @see \Iterator::next()
+     *
+     * @return mixed
      */
     #[\ReturnTypeWillChange]
     public function next()
@@ -210,6 +216,8 @@ public function next()
      * {@inheritdoc}
      *
      * @see \Iterator::rewind()
+     *
+     * @return void
      */
     #[\ReturnTypeWillChange]
     public function rewind()
@@ -221,6 +229,8 @@ public function rewind()
      * {@inheritdoc}
      *
      * @see \Iterator::valid()
+     *
+     * @return bool
      */
     #[\ReturnTypeWillChange]
     public function valid()
@@ -232,6 +242,8 @@ public function valid()
      * {@inheritdoc}
      *
      * @see \Countable::count()
+     *
+     * @return int
      */
     #[\ReturnTypeWillChange]
     public function count()
@@ -247,6 +259,8 @@ public function count()
      * {@inheritdoc}
      *
      * @see \ArrayAccess::offsetExists()
+     *
+     * @return bool
      */
     #[\ReturnTypeWillChange]
     public function offsetExists($offset)
@@ -258,6 +272,8 @@ public function offsetExists($offset)
      * {@inheritdoc}
      *
      * @see \ArrayAccess::offsetGet()
+     *
+     * @return mixed
      */
     #[\ReturnTypeWillChange]
     public function offsetGet($offset)
@@ -269,6 +285,8 @@ public function offsetGet($offset)
      * {@inheritdoc}
      *
      * @see \ArrayAccess::offsetSet()
+     *
+     * @return void
      */
     #[\ReturnTypeWillChange]
     public function offsetSet($offset, $image)
@@ -312,6 +330,8 @@ public function offsetSet($offset, $image)
      * {@inheritdoc}
      *
      * @see \ArrayAccess::offsetUnset()
+     *
+     * @return void
      */
     #[\ReturnTypeWillChange]
     public function offsetUnset($offset)