Add PHPDoc

Signed-off-by: Morris Jobke <hey@morrisjobke.de>

diff --git a/lib/private/Preview/Generator.php b/lib/private/Preview/Generator.php
index 0fb284259aa8bf477d5e4d256f9d1f2d0261a092..5a264c2bbd5432b34034e19385f422a4e4339ec8 100644 (file)
--- a/lib/private/Preview/Generator.php
+++ b/lib/private/Preview/Generator.php
@@ -84,6 +84,7 @@ class Generator {
         * @param string $mimeType
         * @return ISimpleFile
         * @throws NotFoundException
+        * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid)
         */
        public function getPreview(File $file, $width = -1, $height = -1, $crop = false, $mode = IPreview::MODE_FILL, $mimeType = null) {
                $this->eventDispatcher->dispatch(
@@ -299,6 +300,7 @@ class Generator {
         * @param int $maxHeight
         * @return ISimpleFile
         * @throws NotFoundException
+        * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid)
         */
        private function generatePreview(ISimpleFolder $previewFolder, ISimpleFile $maxPreview, $width, $height, $crop, $maxWidth, $maxHeight) {
                $preview = $this->helper->getImage($maxPreview);

diff --git a/lib/private/PreviewManager.php b/lib/private/PreviewManager.php
index 8c5a7ad29f1aa9f862c70b6cec0b940bd60fd58c..12fcc292c6399e9477f10e52081f996e5dbe0cc2 100644 (file)
--- a/lib/private/PreviewManager.php
+++ b/lib/private/PreviewManager.php
@@ -182,7 +182,8 @@ class PreviewManager implements IPreview {
         * @param string $mimeType
         * @return ISimpleFile
         * @throws NotFoundException
-        * @since 11.0.0
+        * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid)
+        * @since 11.0.0 - \InvalidArgumentException was added in 12.0.0
         */
        public function getPreview(File $file, $width = -1, $height = -1, $crop = false, $mode = IPreview::MODE_FILL, $mimeType = null) {
                if ($this->generator === null) {

diff --git a/lib/public/IPreview.php b/lib/public/IPreview.php
index 207539b1170f95d285d73baa57ff80b822c6116c..7705df61a170b7d840acf95fd5646d53c6c468ef 100644 (file)
--- a/lib/public/IPreview.php
+++ b/lib/public/IPreview.php
@@ -104,7 +104,8 @@ interface IPreview {
         * @param string $mimeType To force a given mimetype for the file (files_versions needs this)
         * @return ISimpleFile
         * @throws NotFoundException
-        * @since 11.0.0
+        * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid)
+        * @since 11.0.0 - \InvalidArgumentException was added in 12.0.0
         */
        public function getPreview(File $file, $width = -1, $height = -1, $crop = false, $mode = IPreview::MODE_FILL, $mimeType = null);