Merge pull request #8585 from owncloud/phpdoc-improvements-apps

PHPDoc improvements /apps

* owncloud/phpdoc-improvements-apps:
  Fix whitespace issues
  Reduce double-space with single-space.
  Remove spaces around | operator in doc block.
  Fix more missing or broken PHPDoc
  PHPDoc fixes for user_ldap
  Fix PHPDoc in /apps

6 files changed, 32 insertions, 32 deletions

diff --git a/apps/files_external/lib/amazons3.php b/apps/files_external/lib/amazons3.php
index 2093fb7e58c..7ff17f0e98a 100644
--- a/apps/files_external/lib/amazons3.php
+++ b/apps/files_external/lib/amazons3.php
@@ -25,7 +25,7 @@
 namespace OC\Files\Storage;
 
 set_include_path(get_include_path() . PATH_SEPARATOR .
-        \OC_App::getAppPath('files_external') . '/3rdparty/aws-sdk-php');
+	\OC_App::getAppPath('files_external') . '/3rdparty/aws-sdk-php');
 require 'aws-autoloader.php';
 
 use Aws\S3\S3Client;
diff --git a/apps/files_external/lib/config.php b/apps/files_external/lib/config.php
index 9906b7670a8..7a651239cb4 100755
--- a/apps/files_external/lib/config.php
+++ b/apps/files_external/lib/config.php
@@ -359,10 +359,10 @@ class OC_Mount_Config {
 	* Add a mount point to the filesystem
 	* @param string $mountPoint Mount point
 	* @param string $class Backend class
-	* @param array Backend parameters for the class
+	* @param array $classOptions Backend parameters for the class
 	* @param string $mountType MOUNT_TYPE_GROUP | MOUNT_TYPE_USER
 	* @param string $applicable User or group to apply mount to
-	* @param bool Personal or system mount point i.e. is this being called from the personal or admin page
+	* @param bool $isPersonal Personal or system mount point i.e. is this being called from the personal or admin page
 	* @return boolean
 	*/
 	public static function addMountPoint($mountPoint,
@@ -410,10 +410,10 @@ class OC_Mount_Config {
 
 	/**
 	*
-	* @param string Mount point
-	* @param string MOUNT_TYPE_GROUP | MOUNT_TYPE_USER
-	* @param string User or group to remove mount from
-	* @param bool Personal or system mount point
+	* @param string $mountPoint Mount point
+	* @param string $mountType MOUNT_TYPE_GROUP | MOUNT_TYPE_USER
+	* @param string $applicable User or group to remove mount from
+	* @param bool $isPersonal Personal or system mount point
 	* @return bool
 	*/
 	public static function removeMountPoint($mountPoint, $mountType, $applicable, $isPersonal = false) {
@@ -610,9 +610,9 @@ class OC_Mount_Config {
 
 	/**
 	 * Returns a dependency missing message
-	 * @param $l OC_L10N
-	 * @param $module string
-	 * @param $backend string
+	 * @param OC_L10N $l
+	 * @param string $module
+	 * @param string $backend
 	 * @return string
 	 */
 	private static function getSingleDependencyMessage($l, $module, $backend) {
@@ -658,7 +658,7 @@ class OC_Mount_Config {
 	/**
 	 * Encrypt a single password
 	 * @param string $password plain text password
-	 * @return encrypted password
+	 * @return string encrypted password
 	 */
 	private static function encryptPassword($password) {
 		$cipher = self::getCipher();
@@ -670,7 +670,7 @@ class OC_Mount_Config {
 	/**
 	 * Decrypts a single password
 	 * @param string $encryptedPassword encrypted password
-	 * @return plain text password
+	 * @return string plain text password
 	 */
 	private static function decryptPassword($encryptedPassword) {
 		$cipher = self::getCipher();
diff --git a/apps/files_external/lib/dropbox.php b/apps/files_external/lib/dropbox.php
index 38de3360f2b..9b0e6befee3 100755
--- a/apps/files_external/lib/dropbox.php
+++ b/apps/files_external/lib/dropbox.php
@@ -65,8 +65,8 @@ class Dropbox extends \OC\Files\Storage\Common {
 	/**
 	 * @brief Returns the path's metadata
 	 * @param string $path path for which to return the metadata
-	 * @param $list if true, also return the directory's contents
-	 * @return directory contents if $list is true, file metadata if $list is
+	 * @param bool $list if true, also return the directory's contents
+	 * @return mixed directory contents if $list is true, file metadata if $list is
 	 * false, null if the file doesn't exist or "false" if the operation failed
 	 */
 	private function getMetaData($path, $list = false) {
diff --git a/apps/files_external/lib/ftp.php b/apps/files_external/lib/ftp.php
index b3f8b1444ae..2650a94f85e 100644
--- a/apps/files_external/lib/ftp.php
+++ b/apps/files_external/lib/ftp.php
@@ -64,7 +64,7 @@ class FTP extends \OC\Files\Storage\StreamWrapper{
 
 	/**
 	 * Unlinks file or directory
-	 * @param string @path
+	 * @param string $path
 	 */
 	public function unlink($path) {
 		if ($this->is_dir($path)) {
diff --git a/apps/files_external/lib/smb.php b/apps/files_external/lib/smb.php
index b1d355323d9..6e53c4a9931 100644
--- a/apps/files_external/lib/smb.php
+++ b/apps/files_external/lib/smb.php
@@ -83,7 +83,7 @@ class SMB extends \OC\Files\Storage\StreamWrapper{
 
 	/**
 	 * Unlinks file or directory
-	 * @param string @path
+	 * @param string $path
 	 */
 	public function unlink($path) {
 		if ($this->is_dir($path)) {
diff --git a/apps/files_external/lib/swift.php b/apps/files_external/lib/swift.php
index a202d3843cb..03364867b0c 100644
--- a/apps/files_external/lib/swift.php
+++ b/apps/files_external/lib/swift.php
@@ -23,7 +23,7 @@
 namespace OC\Files\Storage;
 
 set_include_path(get_include_path() . PATH_SEPARATOR .
-        \OC_App::getAppPath('files_external') . '/3rdparty/php-opencloud/lib');
+	\OC_App::getAppPath('files_external') . '/3rdparty/php-opencloud/lib');
 require_once 'openstack.php';
 
 use \OpenCloud;
@@ -31,25 +31,25 @@ use \OpenCloud\Common\Exceptions;
 
 class Swift extends \OC\Files\Storage\Common {
 
-        /**
-         * @var \OpenCloud\ObjectStore
-         */
+	/**
+	 * @var \OpenCloud\ObjectStore
+	 */
 	private $connection;
-        /**
-         * @var \OpenCloud\ObjectStore\Container
-         */
+	/**
+	 * @var \OpenCloud\ObjectStore\Container
+	 */
 	private $container;
-        /**
-         * @var \OpenCloud\OpenStack
-         */
+	/**
+	 * @var \OpenCloud\OpenStack
+	 */
 	private $anchor;
-        /**
-         * @var string
-         */
+	/**
+	 * @var string
+	 */
 	private $bucket;
-        /**
-         * @var array
-         */
+	/**
+	 * @var array
+	 */
 	private static $tmpFiles = array();
 
 	/**