Fix intendation and doc blocks of preview providers

lib/private/preview.php

@@ -16,11 +16,6 @@ namespace OC;
 use OC\Preview\Provider;
 use OCP\Files\NotFoundException;
 
-require_once 'preview/image.php';
-require_once 'preview/movie.php';
-require_once 'preview/mp3.php';
-require_once 'preview/svg.php';
-require_once 'preview/txt.php';
 require_once 'preview/office-cl.php';
 require_once 'preview/bitmap.php';
 

lib/private/preview/image.php

@@ -9,11 +9,16 @@
 namespace OC\Preview;
 
 class Image extends Provider {
-
+	/**
+	 * {@inheritDoc}
+	 */
 	public function getMimeType() {
 		return '/image\/(?!tiff$)(?!svg.*).*/';
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
 	public function getThumbnail($path, $maxX, $maxY, $scalingup, $fileview) {
 		//get fileinfo
 		$fileInfo = $fileview->getFileInfo($path);

lib/private/preview/markdown.php

@@ -0,0 +1,18 @@
+<?php
+/**
+ * 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.
+ */
+namespace OC\Preview;
+
+class MarkDown extends TXT {
+	/**
+	 * {@inheritDoc}
+	 */
+	public function getMimeType() {
+		return '/text\/(x-)?markdown/';
+	}
+
+}

lib/private/preview/movie.php

@@ -8,14 +8,20 @@
  */
 namespace OC\Preview;
 
-		class Movie extends Provider {
+class Movie extends Provider {
 	public static $avconvBinary;
 	public static $ffmpegBinary;
 
+	/**
+	 * {@inheritDoc}
+	 */
 	public function getMimeType() {
 		return '/video\/.*/';
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
 	public function getThumbnail($path, $maxX, $maxY, $scalingup, $fileview) {
 		// TODO: use proc_open() and stream the source file ?
 
@@ -54,12 +60,10 @@ namespace OC\Preview;
 	 * @param int $maxX
 	 * @param int $maxY
 	 * @param string $absPath
-			 * @param string $tmpPath
 	 * @param int $second
 	 * @return bool|\OC_Image
 	 */
-			private function generateThumbNail($maxX, $maxY, $absPath, $second)
-			{
+	private function generateThumbNail($maxX, $maxY, $absPath, $second) {
 		$tmpPath = \OC_Helper::tmpFile();
 
 		if (self::$avconvBinary) {
@@ -87,4 +91,4 @@ namespace OC\Preview;
 		unlink($tmpPath);
 		return false;
 	}
-		}
+}

lib/private/preview/mp3.php

@@ -8,11 +8,16 @@
 namespace OC\Preview;
 
 class MP3 extends Provider {
-
+	/**
+	 * {@inheritDoc}
+	 */
 	public function getMimeType() {
 		return '/audio\/mpeg/';
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
 	public function getThumbnail($path, $maxX, $maxY, $scalingup, $fileview) {
 		$getID3 = new \getID3();
 
@@ -31,6 +36,12 @@ class MP3 extends Provider {
 		return $this->getNoCoverThumbnail();
 	}
 
+	/**
+	 * Generates a default image when the file has no cover
+	 *
+	 * @return false|\OC_Image	False if the default image is missing or invalid,
+	 *							otherwise the image is returned as \OC_Image
+	 */
 	private function getNoCoverThumbnail() {
 		$icon = \OC::$SERVERROOT . '/core/img/filetypes/audio.png';
 

lib/private/preview/provider.php

@@ -29,7 +29,7 @@ abstract class Provider {
 	 * @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
+	 * @param \OC\Files\View $fileview fileview object of user folder
 	 * @return mixed
 	 * 		false if no preview was generated
 	 *		OC_Image object of the preview

lib/private/preview/svg.php

@@ -7,17 +7,20 @@
  */
 namespace OC\Preview;
 
-use Imagick;
-
-		class SVG extends Provider {
-
+class SVG extends Provider {
+	/**
+	 * {@inheritDoc}
+	 */
 	public function getMimeType() {
 		return '/image\/svg\+xml/';
 	}
 
-			public function getThumbnail($path,$maxX,$maxY,$scalingup,$fileview) {
+	/**
+	 * {@inheritDoc}
+	 */
+	public function getThumbnail($path, $maxX, $maxY, $scalingup, $fileview) {
 		try{
-					$svg = new Imagick();
+			$svg = new \Imagick();
 			$svg->setBackgroundColor(new \ImagickPixel('transparent'));
 
 			$content = stream_get_contents($fileview->fopen($path, 'r'));
@@ -37,11 +40,10 @@ use Imagick;
 			return false;
 		}
 
-
 		//new image object
 		$image = new \OC_Image();
 		$image->loadFromData($svg);
 		//check if image object is valid
 		return $image->valid() ? $image : false;
 	}
-		}
+}

lib/private/preview/txt.php

@@ -26,7 +26,6 @@ class TXT extends Provider {
 	 * {@inheritDoc}
 	 */
 	public function getThumbnail($path, $maxX, $maxY, $scalingup, $fileview) {
-
 		$content = $fileview->fopen($path, 'r');
 		$content = stream_get_contents($content,3000);
 
@@ -73,10 +72,3 @@ class TXT extends Provider {
 		return $image->valid() ? $image : false;
 	}
 }
-
-class MarkDown extends TXT {
-	public function getMimeType() {
-		return '/text\/(x-)?markdown/';
-	}
-
-}