diff options
author | Morris Jobke <hey@morrisjobke.de> | 2015-04-16 17:00:08 +0200 |
---|---|---|
committer | Morris Jobke <hey@morrisjobke.de> | 2015-04-16 17:00:08 +0200 |
commit | 7644950b48b094bfe5675348aefb7cf5747d325b (patch) | |
tree | a1792e21239a86f471da99b454134a5d8533ef77 /lib/public/iimage.php | |
parent | 8653da6c16597959c7bd0f0b202747ff96204575 (diff) | |
download | nextcloud-server-7644950b48b094bfe5675348aefb7cf5747d325b.tar.gz nextcloud-server-7644950b48b094bfe5675348aefb7cf5747d325b.zip |
Add @since tags to all methods in public namespace
* enhance the app development experience - you can look up the
method introduction right inside the code without searching
via git blame
* easier to write apps for multiple versions
Diffstat (limited to 'lib/public/iimage.php')
-rw-r--r-- | lib/public/iimage.php | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/lib/public/iimage.php b/lib/public/iimage.php index 36e5492138c..202adeaba54 100644 --- a/lib/public/iimage.php +++ b/lib/public/iimage.php @@ -23,12 +23,14 @@ namespace OCP; /** * Class for basic image manipulation + * @since 8.1.0 */ interface IImage { /** * Determine whether the object contains an image resource. * * @return bool + * @since 8.1.0 */ public function valid(); @@ -36,6 +38,7 @@ interface IImage { * Returns the MIME type of the image or an empty string if no image is loaded. * * @return string + * @since 8.1.0 */ public function mimeType(); @@ -43,6 +46,7 @@ interface IImage { * Returns the width of the image or -1 if no image is loaded. * * @return int + * @since 8.1.0 */ public function width(); @@ -50,6 +54,7 @@ interface IImage { * Returns the height of the image or -1 if no image is loaded. * * @return int + * @since 8.1.0 */ public function height(); @@ -57,6 +62,7 @@ interface IImage { * Returns the width when the image orientation is top-left. * * @return int + * @since 8.1.0 */ public function widthTopLeft(); @@ -64,6 +70,7 @@ interface IImage { * Returns the height when the image orientation is top-left. * * @return int + * @since 8.1.0 */ public function heightTopLeft(); @@ -72,6 +79,7 @@ interface IImage { * * @param string $mimeType * @return bool + * @since 8.1.0 */ public function show($mimeType = null); @@ -81,16 +89,19 @@ interface IImage { * @param string $filePath * @param string $mimeType * @return bool + * @since 8.1.0 */ public function save($filePath = null, $mimeType = null); /** * @return resource Returns the image resource in any. + * @since 8.1.0 */ public function resource(); /** * @return string Returns the raw image data. + * @since 8.1.0 */ public function data(); @@ -99,6 +110,7 @@ interface IImage { * Get the orientation based on EXIF data. * * @return int The orientation or -1 if no EXIF data is available. + * @since 8.1.0 */ public function getOrientation(); @@ -106,7 +118,8 @@ interface IImage { * (I'm open for suggestions on better method name ;) * Fixes orientation based on EXIF data. * - * @return bool. + * @return bool + * @since 8.1.0 */ public function fixOrientation(); @@ -115,6 +128,7 @@ interface IImage { * * @param integer $maxSize The maximum size of either the width or height. * @return bool + * @since 8.1.0 */ public function resize($maxSize); @@ -122,6 +136,7 @@ interface IImage { * @param int $width * @param int $height * @return bool + * @since 8.1.0 */ public function preciseResize($width, $height); @@ -130,6 +145,7 @@ interface IImage { * * @param int $size maximum size for the result (optional) * @return bool for success or failure + * @since 8.1.0 */ public function centerCrop($size = 0); @@ -141,6 +157,7 @@ interface IImage { * @param int $w Width * @param int $h Height * @return bool for success or failure + * @since 8.1.0 */ public function crop($x, $y, $w, $h); @@ -150,6 +167,7 @@ interface IImage { * @param integer $maxWidth * @param integer $maxHeight * @return bool + * @since 8.1.0 */ public function fitIn($maxWidth, $maxHeight); } |