[Pkg-owncloud-commits] [owncloud] 69/153: Fix more missing or broken PHPDoc

David Prévot taffit at moszumanska.debian.org
Tue May 27 03:05:37 UTC 2014


This is an automated email from the git hooks/post-receive script.

taffit pushed a commit to branch master
in repository owncloud.

commit 6930ae22e462e3fd11acbe0f103f2b9a8e8c0e20
Author: Robin McCorkell <rmccorkell at karoshi.org.uk>
Date:   Thu May 15 13:19:32 2014 +0100

    Fix more missing or broken PHPDoc
---
 apps/files_encryption/hooks/hooks.php    |  2 +-
 apps/files_encryption/lib/proxy.php      |  2 +-
 apps/files_external/lib/config.php       | 12 ++++++------
 apps/files_external/lib/ftp.php          |  2 +-
 apps/files_external/lib/smb.php          |  2 +-
 apps/files_sharing/lib/cache.php         |  2 +-
 apps/files_sharing/lib/maintainer.php    |  2 +-
 apps/files_sharing/lib/sharedstorage.php |  8 +++-----
 apps/files_trashbin/lib/hooks.php        |  4 ++--
 apps/files_versions/lib/hooks.php        |  6 +++---
 10 files changed, 20 insertions(+), 22 deletions(-)

diff --git a/apps/files_encryption/hooks/hooks.php b/apps/files_encryption/hooks/hooks.php
index fdc1126..0ab1c4b 100644
--- a/apps/files_encryption/hooks/hooks.php
+++ b/apps/files_encryption/hooks/hooks.php
@@ -422,7 +422,7 @@ class Hooks {
 
 	/**
 	 * @brief after a file is renamed, rename its keyfile and share-keys also fix the file size and fix also the sharing
-	 * @param array with oldpath and newpath
+	 * @param array $params array with oldpath and newpath
 	 *
 	 * This function is connected to the rename signal of OC_Filesystem and adjust the name and location
 	 * of the stored versions along the actual file
diff --git a/apps/files_encryption/lib/proxy.php b/apps/files_encryption/lib/proxy.php
index b5bb03c..3449516 100644
--- a/apps/files_encryption/lib/proxy.php
+++ b/apps/files_encryption/lib/proxy.php
@@ -226,7 +226,7 @@ class Proxy extends \OC_FileProxy {
 
 	/**
 	 * @param string $path
-	 * @param $result
+	 * @param resource $result
 	 * @return resource
 	 */
 	public function postFopen($path, &$result) {
diff --git a/apps/files_external/lib/config.php b/apps/files_external/lib/config.php
index e861839..7a65123 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) {
diff --git a/apps/files_external/lib/ftp.php b/apps/files_external/lib/ftp.php
index b3f8b14..2650a94 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 b1d3553..6e53c4a 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_sharing/lib/cache.php b/apps/files_sharing/lib/cache.php
index f74315c..6a6c737 100644
--- a/apps/files_sharing/lib/cache.php
+++ b/apps/files_sharing/lib/cache.php
@@ -80,7 +80,7 @@ class Shared_Cache extends Cache {
 	/**
 	 * get the stored metadata of a file or folder
 	 *
-	 * @param string /int $file
+	 * @param string|int $file
 	 * @return array
 	 */
 	public function get($file) {
diff --git a/apps/files_sharing/lib/maintainer.php b/apps/files_sharing/lib/maintainer.php
index bbb3268..f07c09e 100644
--- a/apps/files_sharing/lib/maintainer.php
+++ b/apps/files_sharing/lib/maintainer.php
@@ -33,7 +33,7 @@ class Maintainer {
 	 * Keeps track of the "allow links" config setting
 	 * and removes all link shares if the config option is set to "no"
 	 *
-	 * @param array with app, key, value as named values
+	 * @param array $params array with app, key, value as named values
 	 */
 	static public function configChangeHook($params) {
 		if($params['app'] === 'core' && $params['key'] === 'shareapi_allow_links' && $params['value'] === 'no') {
diff --git a/apps/files_sharing/lib/sharedstorage.php b/apps/files_sharing/lib/sharedstorage.php
index d1ca60f..a6a34d9 100644
--- a/apps/files_sharing/lib/sharedstorage.php
+++ b/apps/files_sharing/lib/sharedstorage.php
@@ -53,8 +53,7 @@ class Shared extends \OC\Files\Storage\Common {
 
 	/**
 	 * @brief Get the source file path, permissions, and owner for a shared file
-	 * @param string Shared target file path
-	 * @param string $target
+	 * @param string $target Shared target file path
 	 * @return Returns array with the keys path, permissions, and owner or false if not found
 	 */
 	public function getFile($target) {
@@ -77,8 +76,7 @@ class Shared extends \OC\Files\Storage\Common {
 
 	/**
 	 * @brief Get the source file path for a shared file
-	 * @param string Shared target file path
-	 * @param string $target
+	 * @param string $target Shared target file path
 	 * @return string source file path or false if not found
 	 */
 	public function getSourcePath($target) {
@@ -101,7 +99,7 @@ class Shared extends \OC\Files\Storage\Common {
 
 	/**
 	 * @brief Get the permissions granted for a shared file
-	 * @param string Shared target file path
+	 * @param string $target Shared target file path
 	 * @return int CRUDS permissions granted
 	 */
 	public function getPermissions($target) {
diff --git a/apps/files_trashbin/lib/hooks.php b/apps/files_trashbin/lib/hooks.php
index b2c6bc1..a6f8811 100644
--- a/apps/files_trashbin/lib/hooks.php
+++ b/apps/files_trashbin/lib/hooks.php
@@ -30,7 +30,7 @@ class Hooks {
 
 	/**
 	 * @brief Copy files to trash bin
-	 * @param array
+	 * @param array $params
 	 *
 	 * This function is connected to the delete signal of OC_Filesystem
 	 * to copy the file to the trash bin
@@ -45,7 +45,7 @@ class Hooks {
 
 	/**
 	 * @brief clean up user specific settings if user gets deleted
-	 * @param array with uid
+	 * @param array $params array with uid
 	 *
 	 * This function is connected to the pre_deleteUser signal of OC_Users
 	 * to remove the used space for the trash bin stored in the database
diff --git a/apps/files_versions/lib/hooks.php b/apps/files_versions/lib/hooks.php
index 5d3882c..c0f7201 100644
--- a/apps/files_versions/lib/hooks.php
+++ b/apps/files_versions/lib/hooks.php
@@ -30,7 +30,7 @@ class Hooks {
 
 	/**
 	 * @brief Erase versions of deleted file
-	 * @param array
+	 * @param array $params
 	 *
 	 * This function is connected to the delete signal of OC_Filesystem
 	 * cleanup the versions directory if the actual file gets deleted
@@ -58,7 +58,7 @@ class Hooks {
 
 	/**
 	 * @brief rename/move versions of renamed/moved files
-	 * @param array with oldpath and newpath
+	 * @param array $params array with oldpath and newpath
 	 *
 	 * This function is connected to the rename signal of OC_Filesystem and adjust the name and location
 	 * of the stored versions along the actual file
@@ -76,7 +76,7 @@ class Hooks {
 
 	/**
 	 * @brief clean up user specific settings if user gets deleted
-	 * @param array with uid
+	 * @param array $params array with uid
 	 *
 	 * This function is connected to the pre_deleteUser signal of OC_Users
 	 * to remove the used space for versions stored in the database

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-owncloud/owncloud.git



More information about the Pkg-owncloud-commits mailing list