summaryrefslogtreecommitdiffstats
path: root/lib/public/ipreview.php
diff options
context:
space:
mode:
authorMorris Jobke <hey@morrisjobke.de>2015-04-16 17:00:08 +0200
committerMorris Jobke <hey@morrisjobke.de>2015-04-16 17:00:08 +0200
commit7644950b48b094bfe5675348aefb7cf5747d325b (patch)
treea1792e21239a86f471da99b454134a5d8533ef77 /lib/public/ipreview.php
parent8653da6c16597959c7bd0f0b202747ff96204575 (diff)
downloadnextcloud-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/ipreview.php')
-rw-r--r--lib/public/ipreview.php7
1 files changed, 7 insertions, 0 deletions
diff --git a/lib/public/ipreview.php b/lib/public/ipreview.php
index d0a7972714c..fc81da976b9 100644
--- a/lib/public/ipreview.php
+++ b/lib/public/ipreview.php
@@ -34,6 +34,7 @@ namespace OCP;
/**
* This class provides functions to render and show thumbnails and previews of files
+ * @since 6.0.0
*/
interface IPreview {
/**
@@ -45,18 +46,21 @@ interface IPreview {
* @param string $mimeTypeRegex Regex with the mime types that are supported by this provider
* @param \Closure $callable
* @return void
+ * @since 8.1.0
*/
public function registerProvider($mimeTypeRegex, \Closure $callable);
/**
* Get all providers
* @return array
+ * @since 8.1.0
*/
public function getProviders();
/**
* Does the manager have any providers
* @return bool
+ * @since 8.1.0
*/
public function hasProviders();
@@ -67,6 +71,7 @@ interface IPreview {
* @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image
* @param boolean $scaleUp Scale smaller images up to the thumbnail size or not. Might look ugly
* @return \OCP\IImage
+ * @since 6.0.0
*/
public function createPreview($file, $maxX = 100, $maxY = 75, $scaleUp = false);
@@ -75,6 +80,7 @@ interface IPreview {
* Returns true if the passed mime type is supported
* @param string $mimeType
* @return boolean
+ * @since 6.0.0
*/
public function isMimeSupported($mimeType = '*');
@@ -83,6 +89,7 @@ interface IPreview {
*
* @param \OCP\Files\FileInfo $file
* @return bool
+ * @since 8.0.0
*/
public function isAvailable(\OCP\Files\FileInfo $file);
}