summaryrefslogtreecommitdiffstats
path: root/lib/private/preview.php
diff options
context:
space:
mode:
authorMorris Jobke <hey@morrisjobke.de>2014-05-19 17:50:53 +0200
committerMorris Jobke <hey@morrisjobke.de>2014-05-19 17:50:53 +0200
commitdc36d3095314db8d88c2ec1005d99af595c119da (patch)
tree9de515019d7ebae43a545e5dc4eb522ef71dbe9c /lib/private/preview.php
parent95741f3936501e3ad6aeb26f93eeb28f9decc273 (diff)
downloadnextcloud-server-dc36d3095314db8d88c2ec1005d99af595c119da.tar.gz
nextcloud-server-dc36d3095314db8d88c2ec1005d99af595c119da.zip
Remove all occurences of @brief and @returns from PHPDoc
* test case added to avoid adding them later
Diffstat (limited to 'lib/private/preview.php')
-rwxr-xr-xlib/private/preview.php54
1 files changed, 27 insertions, 27 deletions
diff --git a/lib/private/preview.php b/lib/private/preview.php
index eb932470a47..8089379bde5 100755
--- a/lib/private/preview.php
+++ b/lib/private/preview.php
@@ -66,7 +66,7 @@ class Preview {
protected $info;
/**
- * @brief check if thumbnail or bigger version of thumbnail of file is cached
+ * check if thumbnail or bigger version of thumbnail of file is cached
* @param string $user userid - if no user is given, OC_User::getUser will be used
* @param string $root path of root
* @param string $file The path to the file where you want a thumbnail from
@@ -111,7 +111,7 @@ class Preview {
}
/**
- * @brief returns the path of the file you want a thumbnail from
+ * returns the path of the file you want a thumbnail from
* @return string
*/
public function getFile() {
@@ -119,7 +119,7 @@ class Preview {
}
/**
- * @brief returns the max width of the preview
+ * returns the max width of the preview
* @return integer
*/
public function getMaxX() {
@@ -127,7 +127,7 @@ class Preview {
}
/**
- * @brief returns the max height of the preview
+ * returns the max height of the preview
* @return integer
*/
public function getMaxY() {
@@ -135,7 +135,7 @@ class Preview {
}
/**
- * @brief returns whether or not scalingup is enabled
+ * returns whether or not scalingup is enabled
* @return bool
*/
public function getScalingUp() {
@@ -143,7 +143,7 @@ class Preview {
}
/**
- * @brief returns the name of the thumbnailfolder
+ * returns the name of the thumbnailfolder
* @return string
*/
public function getThumbnailsFolder() {
@@ -151,7 +151,7 @@ class Preview {
}
/**
- * @brief returns the max scale factor
+ * returns the max scale factor
* @return string
*/
public function getMaxScaleFactor() {
@@ -159,7 +159,7 @@ class Preview {
}
/**
- * @brief returns the max width set in ownCloud's config
+ * returns the max width set in ownCloud's config
* @return string
*/
public function getConfigMaxX() {
@@ -167,7 +167,7 @@ class Preview {
}
/**
- * @brief returns the max height set in ownCloud's config
+ * returns the max height set in ownCloud's config
* @return string
*/
public function getConfigMaxY() {
@@ -189,7 +189,7 @@ class Preview {
}
/**
- * @brief set the path of the file you want a thumbnail from
+ * set the path of the file you want a thumbnail from
* @param string $file
* @return \OC\Preview $this
*/
@@ -206,7 +206,7 @@ class Preview {
}
/**
- * @brief set mime type explicitly
+ * set mime type explicitly
* @param string $mimeType
*/
public function setMimetype($mimeType) {
@@ -214,7 +214,7 @@ class Preview {
}
/**
- * @brief set the the max width of the preview
+ * set the the max width of the preview
* @param int $maxX
* @throws \Exception
* @return \OC\Preview $this
@@ -235,7 +235,7 @@ class Preview {
}
/**
- * @brief set the the max height of the preview
+ * set the the max height of the preview
* @param int $maxY
* @throws \Exception
* @return \OC\Preview $this
@@ -256,7 +256,7 @@ class Preview {
}
/**
- * @brief set whether or not scalingup is enabled
+ * set whether or not scalingup is enabled
* @param bool $scalingUp
* @return \OC\Preview $this
*/
@@ -274,7 +274,7 @@ class Preview {
}
/**
- * @brief check if all parameters are valid
+ * check if all parameters are valid
* @return bool
*/
public function isFileValid() {
@@ -293,7 +293,7 @@ class Preview {
}
/**
- * @brief deletes previews of a file with specific x and y
+ * deletes previews of a file with specific x and y
* @return bool
*/
public function deletePreview() {
@@ -310,7 +310,7 @@ class Preview {
}
/**
- * @brief deletes all previews of a file
+ * deletes all previews of a file
* @return bool
*/
public function deleteAllPreviews() {
@@ -328,7 +328,7 @@ class Preview {
}
/**
- * @brief check if thumbnail or bigger version of thumbnail of file is cached
+ * check if thumbnail or bigger version of thumbnail of file is cached
* @param int $fileId fileId of the original image
* @return string|false path to thumbnail if it exists or false
*/
@@ -348,7 +348,7 @@ class Preview {
}
/**
- * @brief check if a bigger version of thumbnail of file is cached
+ * check if a bigger version of thumbnail of file is cached
* @param int $fileId fileId of the original image
* @return string|false path to bigger thumbnail if it exists or false
*/
@@ -380,7 +380,7 @@ class Preview {
}
/**
- * @brief get possible bigger thumbnails of the given image
+ * get possible bigger thumbnails of the given image
* @param int $fileId fileId of the original image
* @return array an array of paths to bigger thumbnails
*/
@@ -433,12 +433,12 @@ class Preview {
* @return bool
*/
private function unscalable($x, $y) {
-
+
$maxX = $this->getMaxX();
$maxY = $this->getMaxY();
$scalingUp = $this->getScalingUp();
$maxScaleFactor = $this->getMaxScaleFactor();
-
+
if ($x < $maxX || $y < $maxY) {
if ($scalingUp) {
$scalefactor = $maxX / $x;
@@ -453,7 +453,7 @@ class Preview {
}
/**
- * @brief return a preview of a file
+ * return a preview of a file
* @return \OC_Image
*/
public function getPreview() {
@@ -529,7 +529,7 @@ class Preview {
}
/**
- * @brief show preview
+ * show preview
* @return void
*/
public function showPreview($mimeType = null) {
@@ -541,7 +541,7 @@ class Preview {
}
/**
- * @brief resize, crop and fix orientation
+ * resize, crop and fix orientation
* @return void
*/
private function resizeAndCrop() {
@@ -652,7 +652,7 @@ class Preview {
}
/**
- * @brief register a new preview provider to be used
+ * register a new preview provider to be used
* @param array $options
* @return void
*/
@@ -661,7 +661,7 @@ class Preview {
}
/**
- * @brief create instances of all the registered preview providers
+ * create instances of all the registered preview providers
* @return void
*/
private static function initProviders() {