Fix more documentation failes

Issue #7111

10 files changed, 73 insertions, 94 deletions

diff --git a/lib/private/appconfig.php b/lib/private/appconfig.php
index 4dbbfbcf85d..5da0a7e906b 100644
--- a/lib/private/appconfig.php
+++ b/lib/private/appconfig.php
@@ -180,8 +180,6 @@ class OC_Appconfig {
 	 * @param string $app app
 	 * @param string $key key
 	 * @return bool
-	 *
-	 * Deletes a key.
 	 */
 	public static function deleteKey($app, $key) {
 		// Boring!
@@ -213,8 +211,6 @@ class OC_Appconfig {
 	/**
 	 * get multiply values, either the app or key can be used as wildcard by setting it to false
 	 *
-	 * @param app
-	 * @param key
 	 * @param boolean $app
 	 * @param string $key
 	 * @return array
diff --git a/lib/private/archive.php b/lib/private/archive.php
index 9fe553f7141..a18f8d3ffbd 100644
--- a/lib/private/archive.php
+++ b/lib/private/archive.php
@@ -9,7 +9,6 @@
 abstract class OC_Archive{
 	/**
 	 * open any of the supported archive types
-	 * @param string path
 	 * @param string $path
 	 * @return OC_Archive
 	 */
@@ -33,41 +32,39 @@ abstract class OC_Archive{
 	abstract function __construct($source);
 	/**
 	 * add an empty folder to the archive
-	 * @param string path
 	 * @param string $path
 	 * @return bool
 	 */
 	abstract function addFolder($path);
 	/**
 	 * 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
 	 */
 	abstract function addFile($path, $source='');
 	/**
 	 * rename a file or folder in the archive
-	 * @param string source
-	 * @param string dest
+	 * @param string $source
+	 * @param string $dest
 	 * @return bool
 	 */
 	abstract function rename($source, $dest);
 	/**
 	 * get the uncompressed size of a file in the archive
-	 * @param string path
+	 * @param string $path
 	 * @return int
 	 */
 	abstract function filesize($path);
 	/**
 	 * get the last modified time of a file in the archive
-	 * @param string path
+	 * @param string $path
 	 * @return int
 	 */
 	abstract function mtime($path);
 	/**
 	 * get the files in a folder
-	 * @param path
+	 * @param string $path
 	 * @return array
 	 */
 	abstract function getFolder($path);
@@ -78,47 +75,47 @@ abstract class OC_Archive{
 	abstract function getFiles();
 	/**
 	 * get the content of a file
-	 * @param string path
+	 * @param string $path
 	 * @return string
 	 */
 	abstract function getFile($path);
 	/**
 	 * extract a single file from the archive
-	 * @param string path
-	 * @param string dest
+	 * @param string $path
+	 * @param string $dest
 	 * @return bool
 	 */
 	abstract function extractFile($path, $dest);
 	/**
 	 * extract the archive
-	 * @param string path
-	 * @param string dest
+	 * @param string $path
+	 * @param string $dest
 	 * @return bool
 	 */
 	abstract function extract($dest);
 	/**
 	 * check if a file or folder exists in the archive
-	 * @param string path
+	 * @param string $path
 	 * @return bool
 	 */
 	abstract function fileExists($path);
 	/**
 	 * remove a file or folder from the archive
-	 * @param string path
+	 * @param string $path
 	 * @return bool
 	 */
 	abstract function remove($path);
 	/**
 	 * get a file handler
-	 * @param string path
-	 * @param string mode
+	 * @param string $path
+	 * @param string $mode
 	 * @return resource
 	 */
 	abstract function getStream($path, $mode);
 	/**
 	 * add a folder and all its content
 	 * @param string $path
-	 * @param string source
+	 * @param string $source
 	 * @return boolean|null
 	 */
 	function addRecursive($path, $source) {
diff --git a/lib/private/archive/tar.php b/lib/private/archive/tar.php
index 224c8b82cc7..5538e027ab4 100644
--- a/lib/private/archive/tar.php
+++ b/lib/private/archive/tar.php
@@ -30,7 +30,7 @@ class OC_Archive_TAR extends OC_Archive{
 
 	/**
 	 * try to detect the type of tar compression
-	 * @param string file
+	 * @param string $file
 	 * @return integer
 	 */
 	static public function getTarType($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,7 @@ 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
 	 */
@@ -232,8 +231,6 @@ class OC_Archive_TAR extends OC_Archive{
 	}
 	/**
 	 * extract the archive
-	 * @param string path
-	 * @param string dest
 	 * @param string $dest
 	 * @return bool
 	 */
@@ -242,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) {
@@ -270,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) {
@@ -291,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) {
diff --git a/lib/private/archive/zip.php b/lib/private/archive/zip.php
index 4cb83087e29..cd5479299a1 100644
--- a/lib/private/archive/zip.php
+++ b/lib/private/archive/zip.php
@@ -23,7 +23,7 @@ class OC_Archive_ZIP extends OC_Archive{
 	}
 	/**
 	 * add an empty folder to the archive
-	 * @param string path
+	 * @param string $path
 	 * @return bool
 	 */
 	function addFolder($path) {
@@ -31,8 +31,8 @@ class OC_Archive_ZIP 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='') {
@@ -49,8 +49,8 @@ class OC_Archive_ZIP extends OC_Archive{
 	}
 	/**
 	 * rename a file or folder in the archive
-	 * @param string source
-	 * @param string dest
+	 * @param string $source
+	 * @param string $dest
 	 * @return boolean|null
 	 */
 	function rename($source, $dest) {
@@ -60,7 +60,7 @@ class OC_Archive_ZIP extends OC_Archive{
 	}
 	/**
 	 * get the uncompressed size of a file in the archive
-	 * @param string path
+	 * @param string $path
 	 * @return int
 	 */
 	function filesize($path) {
@@ -69,7 +69,7 @@ class OC_Archive_ZIP extends OC_Archive{
 	}
 	/**
 	 * get the last modified time of a file in the archive
-	 * @param string path
+	 * @param string $path
 	 * @return int
 	 */
 	function mtime($path) {
@@ -77,7 +77,7 @@ class OC_Archive_ZIP extends OC_Archive{
 	}
 	/**
 	 * get the files in a folder
-	 * @param path
+	 * @param string $path
 	 * @return array
 	 */
 	function getFolder($path) {
@@ -107,7 +107,7 @@ class OC_Archive_ZIP extends OC_Archive{
 	}
 	/**
 	 * get the content of a file
-	 * @param string path
+	 * @param string $path
 	 * @return string
 	 */
 	function getFile($path) {
@@ -115,8 +115,7 @@ class OC_Archive_ZIP extends OC_Archive{
 	}
 	/**
 	 * extract a single file from the archive
-	 * @param string path
-	 * @param string dest
+	 * @param string $path
 	 * @param string $dest
 	 * @return boolean|null
 	 */
@@ -126,8 +125,7 @@ class OC_Archive_ZIP extends OC_Archive{
 	}
 	/**
 	 * extract the archive
-	 * @param string path
-	 * @param string dest
+	 * @param string $path
 	 * @param string $dest
 	 * @return bool
 	 */
@@ -136,7 +134,7 @@ class OC_Archive_ZIP extends OC_Archive{
 	}
 	/**
 	 * check if a file or folder exists in the archive
-	 * @param string path
+	 * @param string $path
 	 * @return bool
 	 */
 	function fileExists($path) {
@@ -144,7 +142,7 @@ class OC_Archive_ZIP extends OC_Archive{
 	}
 	/**
 	 * remove a file or folder from the archive
-	 * @param string path
+	 * @param string $path
 	 * @return bool
 	 */
 	function remove($path) {
@@ -156,8 +154,8 @@ class OC_Archive_ZIP 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) {
@@ -194,6 +192,7 @@ class OC_Archive_ZIP extends OC_Archive{
 	}
 
 	/**
+	 * @param string $path
 	 * @return string
 	 */
 	private function stripPath($path) {
diff --git a/lib/private/davclient.php b/lib/private/davclient.php
index f93b175f352..afa4e1103b4 100644
--- a/lib/private/davclient.php
+++ b/lib/private/davclient.php
@@ -31,8 +31,7 @@ class OC_DAVClient extends \Sabre_DAV_Client {
 
 	/**
 	 * @brief Sets the request timeout or 0 to disable timeout.
-	 * @param int timeout in seconds or 0 to disable
-	 * @param integer $timeout
+	 * @param integer $timeout in seconds or 0 to disable
 	 */
 	public function setRequestTimeout($timeout) {
 		$this->requestTimeout = (int)$timeout;
diff --git a/lib/private/files/node/node.php b/lib/private/files/node/node.php
index 604a881c4a1..643a587dfc2 100644
--- a/lib/private/files/node/node.php
+++ b/lib/private/files/node/node.php
@@ -31,9 +31,8 @@ class Node implements \OCP\Files\Node {
 
 	/**
 	 * @param \OC\Files\View $view
-	 * @param \OC\Files\Node\Root Root $root
+	 * @param \OC\Files\Node\Root $root
 	 * @param string $path
-	 * @param Root $root
 	 */
 	public function __construct($root, $view, $path) {
 		$this->view = $view;
diff --git a/lib/private/installer.php b/lib/private/installer.php
index 43785adc006..1b974c6e5a5 100644
--- a/lib/private/installer.php
+++ b/lib/private/installer.php
@@ -25,10 +25,6 @@
  */
 class OC_Installer{
 	/**
-	 * @brief Installs an app
-	 * @param $data array with all information
-	 * @throws \Exception
-	 * @returns integer
 	 *
 	 * This function installs an app. All information needed are passed in the
 	 * associative array $data.
@@ -55,7 +51,11 @@ class OC_Installer{
 	 *
 	 * It is the task of oc_app_install to create the tables and do whatever is
 	 * needed to get the app working.
-	 * @return string
+	 *
+	 * @brief Installs an app
+	 * @param array $data with all information
+	 * @throws \Exception
+	 * @return integer
 	 */
 	public static function installApp( $data = array()) {
 		$l = \OC_L10N::get('lib');
@@ -220,7 +220,7 @@ class OC_Installer{
 
 	/**
 	 * @brief checks whether or not an app is installed
-	 * @param $app app
+	 * @param string $app app
 	 * @returns true/false
 	 *
 	 * Checks whether or not an app is installed, i.e. registered in apps table.
@@ -236,7 +236,7 @@ class OC_Installer{
 
 	/**
 	 * @brief Update an application
-	 * @param $data array with all information
+	 * @param array $data with all information
 	 *
 	 * This function installs an app. All information needed are passed in the
 	 * associative array $data.
@@ -270,7 +270,7 @@ class OC_Installer{
 
 	/**
 	 * @brief Check if an update for the app is available
-	 * @param $name name of the application
+	 * @param string $name name of the application
 	 * @return string|false false or the version number of the update
 	 *
 	 * The function will check if an update for a version is available
@@ -298,8 +298,8 @@ class OC_Installer{
 
 	/**
 	 * @brief Check if app is already downloaded
-	 * @param $name name of the application to remove
-	 * @returns true/false
+	 * @param string $name name of the application to remove
+	 * @return boolean
 	 *
 	 * The function will check if the app is already downloaded in the apps repository
 	 */
@@ -316,7 +316,7 @@ class OC_Installer{
 	 * @brief Removes an app
 	 * @param string $name name of the application to remove
 	 * @param $options array with options
-	 * @returns true/false
+	 * @return boolean
 	 *
 	 * This function removes an app. $options is an associative array. The
 	 * following keys are optional:ja
@@ -395,8 +395,7 @@ class OC_Installer{
 	/**
 	 * install an app already placed in the app folder
 	 * @param string $app id of the app to install
-	 * @returns array see OC_App::getAppInfo
-	 * @return string
+	 * @return integer
 	 */
 	public static function installShippedApp($app) {
 		//install the database
@@ -431,7 +430,7 @@ class OC_Installer{
 	/**
 	 * check the code of an app with some static code checks
 	 * @param string $folder the folder of the app to check
-	 * @returns true for app is o.k. and false for app is not o.k.
+	 * @return boolean true for app is o.k. and false for app is not o.k.
 	 */
 	public static function checkCode($appname, $folder) {
 
diff --git a/lib/private/ocs.php b/lib/private/ocs.php
index 41eb0b303ac..2305b3eccfe 100644
--- a/lib/private/ocs.php
+++ b/lib/private/ocs.php
@@ -35,13 +35,10 @@ class OC_OCS {
 	/**
 	* reads input date from get/post/cookies and converts the date to a special data-type
 	*
-	* @param string HTTP method to read the key from
-	* @param string Parameter to read
-	* @param string Variable type to format data
-	* @param mixed Default value to return if the key is not found
-	* @param string $method
-	* @param string $key
-	* @param string $default
+	* @param string $method HTTP method to read the key from
+	* @param string $key Parameter to read
+	* @param string $type Variable type to format data
+	* @param mixed $default Default value to return if the key is not found
 	* @return string Data or if the key is not found and no default is set it will exit with a 400 Bad request
 	*/
 	public static function readData($method, $key, $type = 'raw', $default = null) {
diff --git a/lib/private/request.php b/lib/private/request.php
index 14144992388..ee3d2fd54db 100755
--- a/lib/private/request.php
+++ b/lib/private/request.php
@@ -98,11 +98,10 @@ class OC_Request {
 
 	/**
 	 * @brief Returns the script name
-	 * @returns string the script name
+	 * @return string the script name
 	 *
 	 * Returns the script name, even if the website uses one or more
 	 * reverse proxies
-	 * @return string
 	 */
 	public static function scriptName() {
 		$name = $_SERVER['SCRIPT_NAME'];
@@ -116,8 +115,7 @@ class OC_Request {
 
 	/**
 	 * @brief get Path info from request
-	 * @returns string Path info or false when not found
-	 * @return string
+	 * @return string Path info or false when not found
 	 */
 	public static function getPathInfo() {
 		if (array_key_exists('PATH_INFO', $_SERVER)) {
@@ -141,8 +139,7 @@ class OC_Request {
 
 	/**
 	 * @brief get Path info from request, not urldecoded
-	 * @returns string Path info or false when not found
-	 * @return string
+	 * @return string Path info or false when not found
 	 */
 	public static function getRawPathInfo() {
 		$requestUri = $_SERVER['REQUEST_URI'];
@@ -183,7 +180,7 @@ class OC_Request {
 
 	/**
 	 * @brief Check if this is a no-cache request
-	 * @returns boolean true for no-cache
+	 * @return boolean true for no-cache
 	 */
 	static public function isNoCache() {
 		if (!isset($_SERVER['HTTP_CACHE_CONTROL'])) {
@@ -194,7 +191,7 @@ class OC_Request {
 
 	/**
 	 * @brief Check if the requestor understands gzip
-	 * @returns boolean true for gzip encoding supported
+	 * @return boolean true for gzip encoding supported
 	 */
 	static public function acceptGZip() {
 		if (!isset($_SERVER['HTTP_ACCEPT_ENCODING'])) {
@@ -210,7 +207,7 @@ class OC_Request {
 
 	/**
 	 * @brief Check if the requester sent along an mtime
-	 * @returns false or an mtime
+	 * @return false or an mtime
 	 */
 	static public function hasModificationTime () {
 		if (isset($_SERVER['HTTP_X_OC_MTIME'])) {
diff --git a/lib/private/util.php b/lib/private/util.php
index 40a510ab1eb..1d24d5d9b5e 100755
--- a/lib/private/util.php
+++ b/lib/private/util.php
@@ -217,7 +217,7 @@ class OC_Util {
 	 * @brief add a javascript file
 	 *
 	 * @param string $application
-	 * @param filename $file
+	 * @param mixed $file filename
 	 * @return void
 	 */
 	public static function addScript( $application, $file = null ) {
@@ -236,7 +236,7 @@ class OC_Util {
 	 * @brief add a css file
 	 *
 	 * @param string $application
-	 * @param filename $file
+	 * @param mixed $file filename
 	 * @return void
 	 */
 	public static function addStyle( $application, $file = null ) {
@@ -515,7 +515,6 @@ class OC_Util {
 
 	/**
 	 * @brief Check for correct file permissions of data directory
-	 * @paran string $dataDirectory
 	 * @param string $dataDirectory
 	 * @return array arrays with error messages and hints
 	 */