Merge pull request #7114 from owncloud/scrutinizer_documentation_patches

polish documentation based on scrutinizer patches

1 files changed, 17 insertions, 18 deletions

diff --git a/lib/private/archive/tar.php b/lib/private/archive/tar.php
index a1c0535b1c3..5538e027ab4 100644
--- a/lib/private/archive/tar.php
+++ b/lib/private/archive/tar.php
@@ -30,8 +30,8 @@ class OC_Archive_TAR extends OC_Archive{
 
 	/**
 	 * try to detect the type of tar compression
-	 * @param string file
-	 * @return str
+	 * @param string $file
+	 * @return integer
 	 */
 	static public function getTarType($file) {
 		if(strpos($file, '.')) {
@@ -53,7 +53,7 @@ class OC_Archive_TAR extends OC_Archive{
 
 	/**
 	 * add an empty folder to the archive
-	 * @param string path
+	 * @param string $path
 	 * @return bool
 	 */
 	function addFolder($path) {
@@ -80,8 +80,8 @@ class OC_Archive_TAR extends OC_Archive{
 	}
 	/**
 	 * add a file to the archive
-	 * @param string path
-	 * @param string source either a local file or string data
+	 * @param string $path
+	 * @param string $source either a local file or string data
 	 * @return bool
 	 */
 	function addFile($path, $source='') {
@@ -103,8 +103,8 @@ class OC_Archive_TAR extends OC_Archive{
 
 	/**
 	 * rename a file or folder in the archive
-	 * @param string source
-	 * @param string dest
+	 * @param string $source
+	 * @param string $dest
 	 * @return bool
 	 */
 	function rename($source, $dest) {
@@ -139,7 +139,7 @@ class OC_Archive_TAR extends OC_Archive{
 
 	/**
 	 * get the uncompressed size of a file in the archive
-	 * @param string path
+	 * @param string $path
 	 * @return int
 	 */
 	function filesize($path) {
@@ -158,7 +158,7 @@ class OC_Archive_TAR extends OC_Archive{
 
 	/**
 	 * get the files in a folder
-	 * @param path
+	 * @param string $path
 	 * @return array
 	 */
 	function getFolder($path) {
@@ -201,7 +201,7 @@ class OC_Archive_TAR extends OC_Archive{
 	}
 	/**
 	 * get the content of a file
-	 * @param string path
+	 * @param string $path
 	 * @return string
 	 */
 	function getFile($path) {
@@ -209,8 +209,8 @@ class OC_Archive_TAR extends OC_Archive{
 	}
 	/**
 	 * extract a single file from the archive
-	 * @param string path
-	 * @param string dest
+	 * @param string $path
+	 * @param string $dest
 	 * @return bool
 	 */
 	function extractFile($path, $dest) {
@@ -231,8 +231,7 @@ class OC_Archive_TAR extends OC_Archive{
 	}
 	/**
 	 * extract the archive
-	 * @param string path
-	 * @param string dest
+	 * @param string $dest
 	 * @return bool
 	 */
 	function extract($dest) {
@@ -240,7 +239,7 @@ class OC_Archive_TAR extends OC_Archive{
 	}
 	/**
 	 * check if a file or folder exists in the archive
-	 * @param string path
+	 * @param string $path
 	 * @return bool
 	 */
 	function fileExists($path) {
@@ -268,7 +267,7 @@ class OC_Archive_TAR extends OC_Archive{
 
 	/**
 	 * remove a file or folder from the archive
-	 * @param string path
+	 * @param string $path
 	 * @return bool
 	 */
 	function remove($path) {
@@ -289,8 +288,8 @@ class OC_Archive_TAR extends OC_Archive{
 	}
 	/**
 	 * get a file handler
-	 * @param string path
-	 * @param string mode
+	 * @param string $path
+	 * @param string $mode
 	 * @return resource
 	 */
 	function getStream($path, $mode) {