Fix more missing or broken PHPDoc

This commit is contained in:
Robin McCorkell 2014-05-15 13:19:32 +01:00
parent a17f9111a0
commit 6930ae22e4
10 changed files with 20 additions and 22 deletions

View File

@ -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 * @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 * 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 * of the stored versions along the actual file

View File

@ -226,7 +226,7 @@ class Proxy extends \OC_FileProxy {
/** /**
* @param string $path * @param string $path
* @param $result * @param resource $result
* @return resource * @return resource
*/ */
public function postFopen($path, &$result) { public function postFopen($path, &$result) {

View File

@ -359,10 +359,10 @@ class OC_Mount_Config {
* Add a mount point to the filesystem * Add a mount point to the filesystem
* @param string $mountPoint Mount point * @param string $mountPoint Mount point
* @param string $class Backend class * @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 $mountType MOUNT_TYPE_GROUP | MOUNT_TYPE_USER
* @param string $applicable User or group to apply mount to * @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 * @return boolean
*/ */
public static function addMountPoint($mountPoint, public static function addMountPoint($mountPoint,
@ -410,10 +410,10 @@ class OC_Mount_Config {
/** /**
* *
* @param string Mount point * @param string $mountPoint Mount point
* @param string MOUNT_TYPE_GROUP | MOUNT_TYPE_USER * @param string $mountType MOUNT_TYPE_GROUP | MOUNT_TYPE_USER
* @param string User or group to remove mount from * @param string $applicable User or group to remove mount from
* @param bool Personal or system mount point * @param bool $isPersonal Personal or system mount point
* @return bool * @return bool
*/ */
public static function removeMountPoint($mountPoint, $mountType, $applicable, $isPersonal = false) { public static function removeMountPoint($mountPoint, $mountType, $applicable, $isPersonal = false) {

View File

@ -64,7 +64,7 @@ class FTP extends \OC\Files\Storage\StreamWrapper{
/** /**
* Unlinks file or directory * Unlinks file or directory
* @param string @path * @param string $path
*/ */
public function unlink($path) { public function unlink($path) {
if ($this->is_dir($path)) { if ($this->is_dir($path)) {

View File

@ -83,7 +83,7 @@ class SMB extends \OC\Files\Storage\StreamWrapper{
/** /**
* Unlinks file or directory * Unlinks file or directory
* @param string @path * @param string $path
*/ */
public function unlink($path) { public function unlink($path) {
if ($this->is_dir($path)) { if ($this->is_dir($path)) {

View File

@ -80,7 +80,7 @@ class Shared_Cache extends Cache {
/** /**
* get the stored metadata of a file or folder * get the stored metadata of a file or folder
* *
* @param string /int $file * @param string|int $file
* @return array * @return array
*/ */
public function get($file) { public function get($file) {

View File

@ -33,7 +33,7 @@ class Maintainer {
* Keeps track of the "allow links" config setting * Keeps track of the "allow links" config setting
* and removes all link shares if the config option is set to "no" * 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) { static public function configChangeHook($params) {
if($params['app'] === 'core' && $params['key'] === 'shareapi_allow_links' && $params['value'] === 'no') { if($params['app'] === 'core' && $params['key'] === 'shareapi_allow_links' && $params['value'] === 'no') {

View File

@ -53,8 +53,7 @@ class Shared extends \OC\Files\Storage\Common {
/** /**
* @brief Get the source file path, permissions, and owner for a shared file * @brief Get the source file path, permissions, and owner for a shared file
* @param string Shared target file path * @param string $target Shared target file path
* @param string $target
* @return Returns array with the keys path, permissions, and owner or false if not found * @return Returns array with the keys path, permissions, and owner or false if not found
*/ */
public function getFile($target) { 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 * @brief Get the source file path for a shared file
* @param string Shared target file path * @param string $target Shared target file path
* @param string $target
* @return string source file path or false if not found * @return string source file path or false if not found
*/ */
public function getSourcePath($target) { public function getSourcePath($target) {
@ -101,7 +99,7 @@ class Shared extends \OC\Files\Storage\Common {
/** /**
* @brief Get the permissions granted for a shared file * @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 * @return int CRUDS permissions granted
*/ */
public function getPermissions($target) { public function getPermissions($target) {

View File

@ -30,7 +30,7 @@ class Hooks {
/** /**
* @brief Copy files to trash bin * @brief Copy files to trash bin
* @param array * @param array $params
* *
* This function is connected to the delete signal of OC_Filesystem * This function is connected to the delete signal of OC_Filesystem
* to copy the file to the trash bin * to copy the file to the trash bin
@ -45,7 +45,7 @@ class Hooks {
/** /**
* @brief clean up user specific settings if user gets deleted * @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 * 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 * to remove the used space for the trash bin stored in the database

View File

@ -30,7 +30,7 @@ class Hooks {
/** /**
* @brief Erase versions of deleted file * @brief Erase versions of deleted file
* @param array * @param array $params
* *
* This function is connected to the delete signal of OC_Filesystem * This function is connected to the delete signal of OC_Filesystem
* cleanup the versions directory if the actual file gets deleted * cleanup the versions directory if the actual file gets deleted
@ -58,7 +58,7 @@ class Hooks {
/** /**
* @brief rename/move versions of renamed/moved files * @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 * 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 * of the stored versions along the actual file
@ -76,7 +76,7 @@ class Hooks {
/** /**
* @brief clean up user specific settings if user gets deleted * @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 * This function is connected to the pre_deleteUser signal of OC_Users
* to remove the used space for versions stored in the database * to remove the used space for versions stored in the database