diff options
| author | Georg Ehrke <developer@georgehrke.com> | 2013-09-25 12:41:09 +0400 |
|---|---|---|
| committer | Morris Jobke <morris.jobke@gmail.com> | 2013-10-07 15:19:21 +0400 |
| commit | 3b5dc51be4493451b61feb1c5dc4a7eb396b7050 (patch) | |
| tree | 38912f021058170d715bf545c63bf0bbf0718c2d /lib/private/preview | |
| parent | 8a35d79a39e06229859f13d141215b443f76baa7 (diff) | |
fix doc block of OC\Preview\Provider::getThumbnail()
Diffstat (limited to 'lib/private/preview')
| -rw-r--r-- | lib/private/preview/provider.php | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/lib/private/preview/provider.php b/lib/private/preview/provider.php index e4a730bafc8..65d09705f40 100644 --- a/lib/private/preview/provider.php +++ b/lib/private/preview/provider.php @@ -11,9 +11,15 @@ abstract class Provider { abstract public function getMimeType(); /** - * search for $query - * @param string $query - * @return + * get thumbnail for file at path $path + * @param string $path Path of file + * @param int $maxX The maximum X size of the thumbnail. It can be smaller depending on the shape of the image + * @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image + * @param bool $scalingUp Disable/Enable upscaling of previews + * @param object $fileview fileview object of user folder + * @return mixed + * false if no preview was generated + * OC_Image object of the preview */ abstract public function getThumbnail($path, $maxX, $maxY, $scalingup, $fileview); } |