diff options
Diffstat (limited to 'lib/public/ipreview.php')
| -rw-r--r-- | lib/public/ipreview.php | 39 |
1 files changed, 32 insertions, 7 deletions
diff --git a/lib/public/ipreview.php b/lib/public/ipreview.php index b01e7f5b539..f74472ad368 100644 --- a/lib/public/ipreview.php +++ b/lib/public/ipreview.php @@ -1,11 +1,36 @@ <?php + /** - * Copyright (c) 2013 Frank Karlitschek frank@owncloud.org - * Copyright (c) 2013 Georg Ehrke georg@ownCloud.com - * This file is licensed under the Affero General Public License version 3 or - * later. - * See the COPYING-README file. + * ownCloud + * + * @author Frank Karlitschek + * @author Georg Ehrke + * @copyright 2013 Frank Karlitschek frank@owncloud.org + * @copyright 2013 Georg Ehrke georg@owncloud.com + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE + * License as published by the Free Software Foundation; either + * version 3 of the License, or any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU AFFERO GENERAL PUBLIC LICENSE for more details. + * + * You should have received a copy of the GNU Affero General Public + * License along with this library. If not, see <http://www.gnu.org/licenses/>. + * */ + +/** + * Public interface of ownCloud for apps to use. + * Preview interface + * + */ + +// use OCP namespace for all classes that are considered public. +// This means that they should be used by apps instead of the internal ownCloud classes namespace OCP; /** @@ -15,7 +40,7 @@ interface IPreview { /** - * @brief return a preview of a file + * Return a preview of a file * @param string $file The path to the file where you want a thumbnail from * @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 @@ -26,7 +51,7 @@ interface IPreview /** - * @brief returns true if the passed mime type is supported + * Returns true if the passed mime type is supported * @param string $mimeType * @return boolean */ |