Fix #370: Update ImageInterface docblocks

php-imagine · Nov 8, 2014 · e9842b8 · e9842b8
1 parent 10e9522
commit e9842b8
Show file tree

Hide file tree

Showing 4 changed files with 74 additions and 0 deletions.
diff --git a/lib/Imagine/Gd/Image.php b/lib/Imagine/Gd/Image.php
@@ -84,6 +84,8 @@ public function getGdResource()
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     final public function copy()
     {
@@ -99,6 +101,8 @@ final public function copy()
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     final public function crop(PointInterface $start, BoxInterface $size)
     {
@@ -124,6 +128,8 @@ final public function crop(PointInterface $start, BoxInterface $size)
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     final public function paste(ImageInterface $image, PointInterface $start)
     {
@@ -151,6 +157,8 @@ final public function paste(ImageInterface $image, PointInterface $start)
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     final public function resize(BoxInterface $size, $filter = ImageInterface::FILTER_UNDEFINED)
     {
@@ -182,6 +190,8 @@ final public function resize(BoxInterface $size, $filter = ImageInterface::FILTE
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     final public function rotate($angle, ColorInterface $background = null)
     {
@@ -200,6 +210,8 @@ final public function rotate($angle, ColorInterface $background = null)
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     final public function save($path = null, array $options = array())
     {
@@ -225,6 +237,8 @@ final public function save($path = null, array $options = array())
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function show($format, array $options = array())
     {
@@ -256,6 +270,8 @@ public function __toString()
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     final public function flipHorizontally()
     {
@@ -279,6 +295,8 @@ final public function flipHorizontally()
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     final public function flipVertically()
     {
@@ -302,6 +320,8 @@ final public function flipVertically()
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     final public function strip()
     {
@@ -335,6 +355,8 @@ public function getSize()
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function applyMask(ImageInterface $mask)
     {
@@ -367,6 +389,8 @@ public function applyMask(ImageInterface $mask)
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function fill(FillInterface $fill)
     {

diff --git a/lib/Imagine/Gmagick/Image.php b/lib/Imagine/Gmagick/Image.php
@@ -88,6 +88,8 @@ public function getGmagick()
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function copy()
     {
@@ -96,6 +98,8 @@ public function copy()
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function crop(PointInterface $start, BoxInterface $size)
     {
@@ -114,6 +118,8 @@ public function crop(PointInterface $start, BoxInterface $size)
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function flipHorizontally()
     {
@@ -128,6 +134,8 @@ public function flipHorizontally()
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function flipVertically()
     {
@@ -142,6 +150,8 @@ public function flipVertically()
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function strip()
     {
@@ -157,6 +167,8 @@ public function strip()
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function paste(ImageInterface $image, PointInterface $start)
     {
@@ -179,6 +191,8 @@ public function paste(ImageInterface $image, PointInterface $start)
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function resize(BoxInterface $size, $filter = ImageInterface::FILTER_UNDEFINED)
     {
@@ -216,6 +230,8 @@ public function resize(BoxInterface $size, $filter = ImageInterface::FILTER_UNDE
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function rotate($angle, ColorInterface $background = null)
     {
@@ -301,6 +317,8 @@ private function applyImageOptions(\Gmagick $image, array $options, $path)
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function save($path = null, array $options = array())
     {
@@ -323,6 +341,8 @@ public function save($path = null, array $options = array())
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function show($format, array $options = array())
     {
@@ -420,6 +440,8 @@ public function getSize()
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function applyMask(ImageInterface $mask)
     {
@@ -462,6 +484,8 @@ public function mask()
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function fill(FillInterface $fill)
     {

diff --git a/lib/Imagine/Image/AbstractImage.php b/lib/Imagine/Image/AbstractImage.php
@@ -23,6 +23,8 @@ abstract class AbstractImage implements ImageInterface
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function thumbnail(BoxInterface $size, $mode = ImageInterface::THUMBNAIL_INSET, $filter = ImageInterface::FILTER_UNDEFINED)
     {

diff --git a/lib/Imagine/Imagick/Image.php b/lib/Imagine/Imagick/Image.php
@@ -99,6 +99,8 @@ public function getImagick()
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function copy()
     {
@@ -117,6 +119,8 @@ public function copy()
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function crop(PointInterface $start, BoxInterface $size)
     {
@@ -137,6 +141,8 @@ public function crop(PointInterface $start, BoxInterface $size)
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function flipHorizontally()
     {
@@ -151,6 +157,8 @@ public function flipHorizontally()
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function flipVertically()
     {
@@ -165,6 +173,8 @@ public function flipVertically()
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function strip()
     {
@@ -180,6 +190,8 @@ public function strip()
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function paste(ImageInterface $image, PointInterface $start)
     {
@@ -202,6 +214,8 @@ public function paste(ImageInterface $image, PointInterface $start)
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function resize(BoxInterface $size, $filter = ImageInterface::FILTER_UNDEFINED)
     {
@@ -216,6 +230,8 @@ public function resize(BoxInterface $size, $filter = ImageInterface::FILTER_UNDE
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function rotate($angle, ColorInterface $background = null)
     {
@@ -237,6 +253,8 @@ public function rotate($angle, ColorInterface $background = null)
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function save($path = null, array $options = array())
     {
@@ -257,6 +275,8 @@ public function save($path = null, array $options = array())
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function show($format, array $options = array())
     {
@@ -375,6 +395,8 @@ public function getSize()
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function applyMask(ImageInterface $mask)
     {
@@ -425,6 +447,8 @@ public function mask()
 
     /**
      * {@inheritdoc}
+     *
+     * @return ImageInterface
      */
     public function fill(FillInterface $fill)
     {