diff options
Diffstat (limited to 'apps')
52 files changed, 365 insertions, 365 deletions
diff --git a/apps/files/tests/ajax_rename.php b/apps/files/tests/ajax_rename.php index 1b69e438061..9928053e501 100644 --- a/apps/files/tests/ajax_rename.php +++ b/apps/files/tests/ajax_rename.php @@ -66,7 +66,7 @@ class Test_OC_Files_App_Rename extends \PHPUnit_Framework_TestCase { } /** - * @brief test rename of file/folder + * test rename of file/folder */ function testRenameFolder() { $dir = '/'; diff --git a/apps/files_encryption/ajax/adminrecovery.php b/apps/files_encryption/ajax/adminrecovery.php index 61e43acc2c3..303ba0e16e1 100644 --- a/apps/files_encryption/ajax/adminrecovery.php +++ b/apps/files_encryption/ajax/adminrecovery.php @@ -5,7 +5,7 @@ * This file is licensed under the Affero General Public License version 3 or later. * See the COPYING-README file. * - * @brief Script to handle admin settings for encrypted key recovery + * Script to handle admin settings for encrypted key recovery */ use OCA\Encryption; diff --git a/apps/files_encryption/ajax/changeRecoveryPassword.php b/apps/files_encryption/ajax/changeRecoveryPassword.php index f020e52607d..0cb010d3b56 100644 --- a/apps/files_encryption/ajax/changeRecoveryPassword.php +++ b/apps/files_encryption/ajax/changeRecoveryPassword.php @@ -5,7 +5,7 @@ * This file is licensed under the Affero General Public License version 3 or later. * See the COPYING-README file. * - * @brief Script to change recovery key password + * Script to change recovery key password * */ diff --git a/apps/files_encryption/ajax/getMigrationStatus.php b/apps/files_encryption/ajax/getMigrationStatus.php index a8828401934..adceb949044 100644 --- a/apps/files_encryption/ajax/getMigrationStatus.php +++ b/apps/files_encryption/ajax/getMigrationStatus.php @@ -4,7 +4,7 @@ * This file is licensed under the Affero General Public License version 3 or later. * See the COPYING-README file. * - * @brief check migration status + * check migration status */ use OCA\Encryption\Util; diff --git a/apps/files_encryption/ajax/updatePrivateKeyPassword.php b/apps/files_encryption/ajax/updatePrivateKeyPassword.php index 29c72952ae9..f7d20c486cf 100644 --- a/apps/files_encryption/ajax/updatePrivateKeyPassword.php +++ b/apps/files_encryption/ajax/updatePrivateKeyPassword.php @@ -5,7 +5,7 @@ * This file is licensed under the Affero General Public License version 3 or later. * See the COPYING-README file. * - * @brief Script to change recovery key password + * Script to change recovery key password * */ diff --git a/apps/files_encryption/ajax/userrecovery.php b/apps/files_encryption/ajax/userrecovery.php index 81ca1459a91..0f3b973d69a 100644 --- a/apps/files_encryption/ajax/userrecovery.php +++ b/apps/files_encryption/ajax/userrecovery.php @@ -4,7 +4,7 @@ * This file is licensed under the Affero General Public License version 3 or later. * See the COPYING-README file. * - * @brief Script to handle admin settings for encrypted key recovery + * Script to handle admin settings for encrypted key recovery */ use OCA\Encryption; diff --git a/apps/files_encryption/hooks/hooks.php b/apps/files_encryption/hooks/hooks.php index 0ab1c4b129c..c1ccb927df5 100644 --- a/apps/files_encryption/hooks/hooks.php +++ b/apps/files_encryption/hooks/hooks.php @@ -36,7 +36,7 @@ class Hooks { private static $deleteFiles = array();
/**
- * @brief Startup encryption backend upon user login
+ * Startup encryption backend upon user login
* @note This method should never be called for users using client side encryption
*/
public static function login($params) {
@@ -136,7 +136,7 @@ class Hooks { }
/**
- * @brief setup encryption backend upon user created
+ * setup encryption backend upon user created
* @note This method should never be called for users using client side encryption
*/
public static function postCreateUser($params) {
@@ -149,7 +149,7 @@ class Hooks { }
/**
- * @brief cleanup encryption backend upon user deleted
+ * cleanup encryption backend upon user deleted
* @note This method should never be called for users using client side encryption
*/
public static function postDeleteUser($params) {
@@ -171,7 +171,7 @@ class Hooks { }
/**
- * @brief If the password can't be changed within ownCloud, than update the key password in advance.
+ * If the password can't be changed within ownCloud, than update the key password in advance.
*/
public static function preSetPassphrase($params) {
if (\OCP\App::isEnabled('files_encryption')) {
@@ -182,7 +182,7 @@ class Hooks { }
/**
- * @brief Change a user's encryption passphrase
+ * Change a user's encryption passphrase
* @param array $params keys: uid, password
*/
public static function setPassphrase($params) {
@@ -259,7 +259,7 @@ class Hooks { }
/*
- * @brief check if files can be encrypted to every user.
+ * check if files can be encrypted to every user.
*/
/**
* @param array $params
@@ -398,7 +398,7 @@ class Hooks { }
/**
- * @brief mark file as renamed so that we know the original source after the file was renamed
+ * mark file as renamed so that we know the original source after the file was renamed
* @param array $params with the old path and the new path
*/
public static function preRename($params) {
@@ -421,7 +421,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
+ * after a file is renamed, rename its keyfile and share-keys also fix the file size and fix also the sharing
* @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
@@ -557,7 +557,7 @@ class Hooks { }
/**
- * @brief if the file was really deleted we remove the encryption keys
+ * if the file was really deleted we remove the encryption keys
* @param array $params
* @return boolean|null
*/
@@ -597,7 +597,7 @@ class Hooks { }
/**
- * @brief remember the file which should be deleted and it's owner
+ * remember the file which should be deleted and it's owner
* @param array $params
* @return boolean|null
*/
diff --git a/apps/files_encryption/lib/crypt.php b/apps/files_encryption/lib/crypt.php index 5cdc92e85f7..ec7b3bc92e4 100755 --- a/apps/files_encryption/lib/crypt.php +++ b/apps/files_encryption/lib/crypt.php @@ -40,7 +40,7 @@ class Crypt { /**
- * @brief return encryption mode client or server side encryption
+ * return encryption mode client or server side encryption
* @param string $user name (use system wide setting if name=null)
* @return string 'client' or 'server'
*/
@@ -51,7 +51,7 @@ class Crypt { }
/**
- * @brief Create a new encryption keypair
+ * Create a new encryption keypair
* @return array publicKey, privatekey
*/
public static function createKeypair() {
@@ -85,7 +85,7 @@ class Crypt { }
/**
- * @brief Add arbitrary padding to encrypted data
+ * Add arbitrary padding to encrypted data
* @param string $data data to be padded
* @return string padded data
* @note In order to end up with data exactly 8192 bytes long we must
@@ -102,7 +102,7 @@ class Crypt { }
/**
- * @brief Remove arbitrary padding to encrypted data
+ * Remove arbitrary padding to encrypted data
* @param string $padded padded data to remove padding from
* @return string unpadded data on success, false on error
*/
@@ -124,7 +124,7 @@ class Crypt { }
/**
- * @brief Check if a file's contents contains an IV and is symmetrically encrypted
+ * Check if a file's contents contains an IV and is symmetrically encrypted
* @param string $content
* @return boolean
* @note see also OCA\Encryption\Util->isEncryptedPath()
@@ -178,7 +178,7 @@ class Crypt { }
/**
- * @brief Check if a file is encrypted via legacy system
+ * Check if a file is encrypted via legacy system
* @param boolean $isCatFileContent
* @param string $relPath The path of the file, relative to user/data;
* e.g. filename or /Docs/filename, NOT admin/files/filename
@@ -208,7 +208,7 @@ class Crypt { }
/**
- * @brief Symmetrically encrypt a string
+ * Symmetrically encrypt a string
* @param string $plainContent
* @param string $iv
* @param string $passphrase
@@ -228,7 +228,7 @@ class Crypt { }
/**
- * @brief Symmetrically decrypt a string
+ * Symmetrically decrypt a string
* @param string $encryptedContent
* @param string $iv
* @param string $passphrase
@@ -250,7 +250,7 @@ class Crypt { }
/**
- * @brief Concatenate encrypted data with its IV and padding
+ * Concatenate encrypted data with its IV and padding
* @param string $content content to be concatenated
* @param string $iv IV to be concatenated
* @return string concatenated content
@@ -264,7 +264,7 @@ class Crypt { }
/**
- * @brief Split concatenated data and IV into respective parts
+ * Split concatenated data and IV into respective parts
* @param string $catFile concatenated data to be split
* @return array keys: encrypted, iv
*/
@@ -289,7 +289,7 @@ class Crypt { }
/**
- * @brief Symmetrically encrypts a string and returns keyfile content
+ * Symmetrically encrypts a string and returns keyfile content
* @param string $plainContent content to be encrypted in keyfile
* @param string $passphrase
* @return false|string encrypted content combined with IV
@@ -321,7 +321,7 @@ class Crypt { /**
- * @brief Symmetrically decrypts keyfile content
+ * Symmetrically decrypts keyfile content
* @param string $keyfileContent
* @param string $passphrase
* @throws \Exception
@@ -358,7 +358,7 @@ class Crypt { }
/**
- * @brief Decrypt private key and check if the result is a valid keyfile
+ * Decrypt private key and check if the result is a valid keyfile
* @param string $encryptedKey encrypted keyfile
* @param string $passphrase to decrypt keyfile
* @return string|false encrypted private key or false
@@ -385,7 +385,7 @@ class Crypt { }
/**
- * @brief Create asymmetrically encrypted keyfile content using a generated key
+ * Create asymmetrically encrypted keyfile content using a generated key
* @param string $plainContent content to be encrypted
* @param array $publicKeys array keys must be the userId of corresponding user
* @return array keys: keys (array, key = userId), data
@@ -433,7 +433,7 @@ class Crypt { }
/**
- * @brief Asymmetrically encrypt a file using multiple public keys
+ * Asymmetrically encrypt a file using multiple public keys
* @param string $encryptedContent
* @param string $shareKey
* @param mixed $privateKey
@@ -467,7 +467,7 @@ class Crypt { }
/**
- * @brief Generates a pseudo random initialisation vector
+ * Generates a pseudo random initialisation vector
* @return String $iv generated IV
*/
private static function generateIv() {
@@ -496,7 +496,7 @@ class Crypt { }
/**
- * @brief Generate a pseudo random 256-bit ASCII key, used as file key
+ * Generate a pseudo random 256-bit ASCII key, used as file key
* @return string|false Generated key
*/
public static function generateKey() {
@@ -522,7 +522,7 @@ class Crypt { }
/**
- * @brief Get the blowfish encryption handler for a key
+ * Get the blowfish encryption handler for a key
* @param string $key (optional)
* @return \Crypt_Blowfish blowfish object
*
@@ -543,7 +543,7 @@ class Crypt { }
/**
- * @brief decrypts content using legacy blowfish system
+ * decrypts content using legacy blowfish system
* @param string $content the cleartext message you want to decrypt
* @param string $passphrase
* @return string cleartext content
diff --git a/apps/files_encryption/lib/helper.php b/apps/files_encryption/lib/helper.php index 2455c605dfe..564e97e0592 100755 --- a/apps/files_encryption/lib/helper.php +++ b/apps/files_encryption/lib/helper.php @@ -24,7 +24,7 @@ namespace OCA\Encryption; /** - * @brief Class to manage registration of hooks an various helper methods + * Class to manage registration of hooks an various helper methods * @package OCA\Encryption */ class Helper { @@ -32,7 +32,7 @@ class Helper { private static $tmpFileMapping; // Map tmp files to files in data/user/files /** - * @brief register share related hooks + * register share related hooks * */ public static function registerShareHooks() { @@ -43,7 +43,7 @@ class Helper { } /** - * @brief register user related hooks + * register user related hooks * */ public static function registerUserHooks() { @@ -56,7 +56,7 @@ class Helper { } /** - * @brief register filesystem related hooks + * register filesystem related hooks * */ public static function registerFilesystemHooks() { @@ -68,7 +68,7 @@ class Helper { } /** - * @brief register app management related hooks + * register app management related hooks * */ public static function registerAppHooks() { @@ -78,7 +78,7 @@ class Helper { } /** - * @brief setup user for files_encryption + * setup user for files_encryption * * @param Util $util * @param string $password @@ -100,7 +100,7 @@ class Helper { } /** - * @brief enable recovery + * enable recovery * * @param string $recoveryKeyId * @param string $recoveryPassword @@ -164,7 +164,7 @@ class Helper { } /** - * @brief Check if a path is a .part file + * Check if a path is a .part file * @param string $path Path that may identify a .part file * @return bool */ @@ -181,7 +181,7 @@ class Helper { /** - * @brief Remove .path extension from a file path + * Remove .path extension from a file path * @param string $path Path that may identify a .part file * @return string File path without .part extension * @note this is needed for reusing keys @@ -208,7 +208,7 @@ class Helper { } /** - * @brief disable recovery + * disable recovery * * @param string $recoveryPassword * @return bool @@ -227,7 +227,7 @@ class Helper { /** - * @brief checks if access is public/anonymous user + * checks if access is public/anonymous user * @return bool */ public static function isPublicAccess() { @@ -239,7 +239,7 @@ class Helper { } /** - * @brief Format a path to be relative to the /user/files/ directory + * Format a path to be relative to the /user/files/ directory * @param string $path the absolute path * @return string e.g. turns '/admin/files/test.txt' into 'test.txt' */ @@ -259,7 +259,7 @@ class Helper { } /** - * @brief try to get the user from the path if no user is logged in + * try to get the user from the path if no user is logged in * @param string $path * @return mixed user or false if we couldn't determine a user */ @@ -294,7 +294,7 @@ class Helper { } /** - * @brief get path to the corresponding file in data/user/files if path points + * get path to the corresponding file in data/user/files if path points * to a version or to a file in cache * @param string $path path to a version or a file in the trash * @return string path to corresponding file relative to data/user/files @@ -327,7 +327,7 @@ class Helper { } /** - * @brief create directory recursively + * create directory recursively * @param string $path * @param \OC\Files\View $view */ @@ -344,7 +344,7 @@ class Helper { } /** - * @brief redirect to a error page + * redirect to a error page * @param Session $session */ public static function redirectToErrorPage($session, $errorCode = null) { @@ -428,7 +428,7 @@ class Helper { } /** - * @brief glob uses different pattern than regular expressions, escape glob pattern only + * glob uses different pattern than regular expressions, escape glob pattern only * @param string $path unescaped path * @return string path */ @@ -437,7 +437,7 @@ class Helper { } /** - * @brief remember from which file the tmp file (getLocalFile() call) was created + * remember from which file the tmp file (getLocalFile() call) was created * @param string $tmpFile path of tmp file * @param string $originalFile path of the original file relative to data/ */ @@ -446,7 +446,7 @@ class Helper { } /** - * @brief get the path of the original file + * get the path of the original file * @param string $tmpFile path of the tmp file * @return string|false path of the original file or false */ diff --git a/apps/files_encryption/lib/keymanager.php b/apps/files_encryption/lib/keymanager.php index 0732153f313..3c51c5efba2 100755 --- a/apps/files_encryption/lib/keymanager.php +++ b/apps/files_encryption/lib/keymanager.php @@ -24,13 +24,13 @@ namespace OCA\Encryption; /** - * @brief Class to manage storage and retrieval of encryption keys + * Class to manage storage and retrieval of encryption keys * @note Where a method requires a view object, it's root must be '/' */ class Keymanager { /** - * @brief retrieve the ENCRYPTED private key from a user + * retrieve the ENCRYPTED private key from a user * * @param \OC\Files\View $view * @param string $user @@ -55,7 +55,7 @@ class Keymanager { } /** - * @brief retrieve public key for a specified user + * retrieve public key for a specified user * @param \OC\Files\View $view * @param string $userId * @return string public key or false @@ -74,7 +74,7 @@ class Keymanager { } /** - * @brief Retrieve a user's public and private key + * Retrieve a user's public and private key * @param \OC\Files\View $view * @param string $userId * @return array keys: privateKey, publicKey @@ -89,7 +89,7 @@ class Keymanager { } /** - * @brief Retrieve public keys for given users + * Retrieve public keys for given users * @param \OC\Files\View $view * @param array $userIds * @return array of public keys for the specified users @@ -109,7 +109,7 @@ class Keymanager { } /** - * @brief store file encryption key + * store file encryption key * * @param \OC\Files\View $view * @param \OCA\Encryption\Util $util @@ -167,7 +167,7 @@ class Keymanager { } /** - * @brief retrieve keyfile for an encrypted file + * retrieve keyfile for an encrypted file * @param \OC\Files\View $view * @param \OCA\Encryption\Util $util * @param string|false $filePath @@ -210,7 +210,7 @@ class Keymanager { } /** - * @brief Delete a keyfile + * Delete a keyfile * * @param \OC\Files\View $view * @param string $path path of the file the key belongs to @@ -266,7 +266,7 @@ class Keymanager { } /** - * @brief store private key from the user + * store private key from the user * @param string $key * @return bool * @note Encryption of the private key must be performed by client code @@ -293,7 +293,7 @@ class Keymanager { } /** - * @brief store share key + * store share key * * @param \OC\Files\View $view * @param string $path where the share key is stored @@ -319,7 +319,7 @@ class Keymanager { } /** - * @brief store multiple share keys for a single file + * store multiple share keys for a single file * @param \OC\Files\View $view * @param \OCA\Encryption\Util $util * @param string $path @@ -365,7 +365,7 @@ class Keymanager { } /** - * @brief retrieve shareKey for an encrypted file + * retrieve shareKey for an encrypted file * @param \OC\Files\View $view * @param string $userId * @param \OCA\Encryption\Util $util @@ -406,7 +406,7 @@ class Keymanager { } /** - * @brief delete all share keys of a given file + * delete all share keys of a given file * @param \OC\Files\View $view * @param string $userId owner of the file * @param string $filePath path to the file, relative to the owners file dir @@ -445,7 +445,7 @@ class Keymanager { } /** - * @brief Delete a single user's shareKey for a single file + * Delete a single user's shareKey for a single file */ public static function delShareKey(\OC\Files\View $view, $userIds, $filePath) { @@ -486,7 +486,7 @@ class Keymanager { } /** - * @brief recursively delete share keys from given users + * recursively delete share keys from given users * * @param string $dir directory * @param array $userIds user ids for which the share keys should be deleted @@ -512,7 +512,7 @@ class Keymanager { } /** - * @brief Make preparations to vars and filesystem for saving a keyfile + * Make preparations to vars and filesystem for saving a keyfile * @param string|boolean $path * @param string $basePath */ @@ -542,7 +542,7 @@ class Keymanager { } /** - * @brief extract filename from share key name + * extract filename from share key name * @param string $shareKey (filename.userid.sharekey) * @return string|false filename or false */ diff --git a/apps/files_encryption/lib/proxy.php b/apps/files_encryption/lib/proxy.php index 3449516f6ef..ae3df834e9f 100644 --- a/apps/files_encryption/lib/proxy.php +++ b/apps/files_encryption/lib/proxy.php @@ -24,7 +24,7 @@ */ /** - * @brief Encryption proxy which handles filesystem operations before and after + * Encryption proxy which handles filesystem operations before and after * execution and encrypts, and handles keyfiles accordingly. Used for * webui. */ @@ -144,7 +144,7 @@ class Proxy extends \OC_FileProxy { } /** - * @brief update file cache with the new unencrypted size after file was written + * update file cache with the new unencrypted size after file was written * @param string $path * @param mixed $result * @return mixed @@ -212,7 +212,7 @@ class Proxy extends \OC_FileProxy { } /** - * @brief remember initial fopen mode because sometimes it gets changed during the request + * remember initial fopen mode because sometimes it gets changed during the request * @param string $path path * @param string $mode type of access */ diff --git a/apps/files_encryption/lib/session.php b/apps/files_encryption/lib/session.php index f9001422560..93be6691f96 100644 --- a/apps/files_encryption/lib/session.php +++ b/apps/files_encryption/lib/session.php @@ -36,7 +36,7 @@ class Session { /** - * @brief if session is started, check if ownCloud key pair is set up, if not create it + * if session is started, check if ownCloud key pair is set up, if not create it * @param \OC\Files\View $view * * @note The ownCloud key pair is used to allow public link sharing even if encryption is enabled @@ -105,7 +105,7 @@ class Session { } /** - * @brief Sets user private key to session + * Sets user private key to session * @param string $privateKey * @return bool * @@ -120,7 +120,7 @@ class Session { } /** - * @brief Sets status of encryption app + * Sets status of encryption app * @param string $init INIT_SUCCESSFUL, INIT_EXECUTED, NOT_INITIALIZED * @return bool * @@ -135,7 +135,7 @@ class Session { } /** - * @brief remove encryption keys and init status from session + * remove encryption keys and init status from session */ public function closeSession() { \OC::$session->remove('encryptionInitialized'); @@ -144,7 +144,7 @@ class Session { /** - * @brief Gets status if we already tried to initialize the encryption app + * Gets status if we already tried to initialize the encryption app * @return string init status INIT_SUCCESSFUL, INIT_EXECUTED, NOT_INITIALIZED * * @note this doesn not indicate of the init was successful, we just remeber the try! @@ -158,7 +158,7 @@ class Session { } /** - * @brief Gets user or public share private key from session + * Gets user or public share private key from session * @return string $privateKey The user's plaintext private key * */ @@ -176,7 +176,7 @@ class Session { } /** - * @brief Sets public user private key to session + * Sets public user private key to session * @param string $privateKey * @return bool */ @@ -189,7 +189,7 @@ class Session { } /** - * @brief Gets public share private key from session + * Gets public share private key from session * @return string $privateKey * */ @@ -204,7 +204,7 @@ class Session { /** - * @brief Sets user legacy key to session + * Sets user legacy key to session * @param string $legacyKey * @return bool */ @@ -216,7 +216,7 @@ class Session { } /** - * @brief Gets user legacy key from session + * Gets user legacy key from session * @return string $legacyKey The user's plaintext legacy key * */ diff --git a/apps/files_encryption/lib/stream.php b/apps/files_encryption/lib/stream.php index 1008eba43b6..341114214d5 100644 --- a/apps/files_encryption/lib/stream.php +++ b/apps/files_encryption/lib/stream.php @@ -31,7 +31,7 @@ namespace OCA\Encryption; /** - * @brief Provides 'crypt://' stream wrapper protocol. + * Provides 'crypt://' stream wrapper protocol. * @note We use a stream wrapper because it is the most secure way to handle * decrypted content transfers. There is no safe way to decrypt the entire file * somewhere on the server, so we have to encrypt and decrypt blocks on the fly. @@ -179,7 +179,7 @@ class Stream { } /** - * @brief Returns the current position of the file pointer + * Returns the current position of the file pointer * @return int position of the file pointer */ public function stream_tell() { @@ -246,7 +246,7 @@ class Stream { } /** - * @brief Encrypt and pad data ready for writing to disk + * Encrypt and pad data ready for writing to disk * @param string $plainData data to be encrypted * @param string $key key to use for encryption * @return string encrypted data on success, false on failure @@ -267,7 +267,7 @@ class Stream { } /** - * @brief Fetch the plain encryption key for the file and set it as plainKey property + * Fetch the plain encryption key for the file and set it as plainKey property * @internal param bool $generate if true, a new key will be generated if none can be found * @return bool true on key found and set, false on key not found and new key generated and set */ @@ -318,7 +318,7 @@ class Stream { } /** - * @brief Handle plain data from the stream, and write it in 8192 byte blocks + * Handle plain data from the stream, and write it in 8192 byte blocks * @param string $data data to be written to disk * @note the data will be written to the path stored in the stream handle, set in stream_open() * @note $data is only ever be a maximum of 8192 bytes long. This is set by PHP internally. stream_write() is called multiple times in a loop on data larger than 8192 bytes diff --git a/apps/files_encryption/lib/util.php b/apps/files_encryption/lib/util.php index 84dbec6fdfc..d20efc3ac7b 100644 --- a/apps/files_encryption/lib/util.php +++ b/apps/files_encryption/lib/util.php @@ -25,7 +25,7 @@ namespace OCA\Encryption; /** - * @brief Class for utilities relating to encrypted file storage system + * Class for utilities relating to encrypted file storage system * @param \OC\Files\View $view expected to have OC '/' as root path * @param string $userId ID of the logged in user * @param int $client indicating status of client side encryption. Currently @@ -111,7 +111,7 @@ class Util { } /** - * @brief check if the users private & public key exists + * check if the users private & public key exists * @return boolean */ public function userKeysExists() { @@ -125,7 +125,7 @@ class Util { } /** - * @brief Sets up user folders and keys for serverside encryption + * Sets up user folders and keys for serverside encryption * * @param string $passphrase to encrypt server-stored private key with * @return bool @@ -222,7 +222,7 @@ class Util { } /** - * @brief Check whether pwd recovery is enabled for a given user + * Check whether pwd recovery is enabled for a given user * @return bool 1 = yes, 0 = no, false = no record * * @note If records are not being returned, check for a hidden space @@ -264,7 +264,7 @@ class Util { } /** - * @brief Enable / disable pwd recovery for a given user + * Enable / disable pwd recovery for a given user * @param bool $enabled Whether to enable or disable recovery * @return bool */ @@ -300,7 +300,7 @@ class Util { } /** - * @brief Find all files and their encryption status within a directory + * Find all files and their encryption status within a directory * @param string $directory The path of the parent directory to search * @param bool $found the founded files if called again * @return mixed false if 0 found, array on success. Keys: name, path @@ -421,7 +421,7 @@ class Util { } /** - * @brief Check if a given path identifies an encrypted file + * Check if a given path identifies an encrypted file * @param string $path * @return boolean */ @@ -463,7 +463,7 @@ class Util { } /** - * @brief get the file size of the unencrypted file + * get the file size of the unencrypted file * @param string $path absolute path * @return bool */ @@ -537,7 +537,7 @@ class Util { } /** - * @brief fix the file size of the encrypted file + * fix the file size of the encrypted file * @param string $path absolute path * @return boolean true / false if file is encrypted */ @@ -594,7 +594,7 @@ class Util { } /** - * @brief encrypt versions from given file + * encrypt versions from given file * @param array $filelist list of encrypted files, relative to data/user/files * @return boolean */ @@ -640,7 +640,7 @@ class Util { } /** - * @brief decrypt versions from given file + * decrypt versions from given file * @param string $filelist list of decrypted files, relative to data/user/files * @return boolean */ @@ -686,7 +686,7 @@ class Util { } /** - * @brief Decrypt all files + * Decrypt all files * @return bool */ public function decryptAll() { @@ -799,7 +799,7 @@ class Util { } /** - * @brief Encrypt all files in a directory + * Encrypt all files in a directory * @param string $dirPath the directory whose files will be encrypted * @param null $legacyPassphrase * @param null $newPassphrase @@ -926,7 +926,7 @@ class Util { } /** - * @brief Return important encryption related paths + * Return important encryption related paths * @param string $pathName Name of the directory to return the path of * @return string path */ @@ -970,7 +970,7 @@ class Util { } /** - * @brief Filter an array of UIDs to return only ones ready for sharing + * Filter an array of UIDs to return only ones ready for sharing * @param array $unfilteredUsers users to be checked for sharing readiness * @return array as multi-dimensional array. keys: ready, unready */ @@ -1017,7 +1017,7 @@ class Util { } /** - * @brief Decrypt a keyfile + * Decrypt a keyfile * @param string $filePath * @param string $privateKey * @return false|string @@ -1036,7 +1036,7 @@ class Util { } /** - * @brief Encrypt keyfile to multiple users + * Encrypt keyfile to multiple users * @param Session $session * @param array $users list of users which should be able to access the file * @param string $filePath path of the file to be shared @@ -1097,7 +1097,7 @@ class Util { } /** - * @brief Find, sanitise and format users sharing a file + * Find, sanitise and format users sharing a file * @note This wraps other methods into a portable bundle * @param boolean $sharingEnabled * @param string $filePath path relativ to current users files folder @@ -1176,7 +1176,7 @@ class Util { } /** - * @brief set migration status + * set migration status * @param int $status * @return boolean */ @@ -1199,7 +1199,7 @@ class Util { } /** - * @brief start migration mode to initially encrypt users data + * start migration mode to initially encrypt users data * @return boolean */ public function beginMigration() { @@ -1221,7 +1221,7 @@ class Util { } /** - * @brief close migration mode after users data has been encrypted successfully + * close migration mode after users data has been encrypted successfully * @return boolean */ public function finishMigration() { @@ -1237,7 +1237,7 @@ class Util { } /** - * @brief check if files are already migrated to the encryption system + * check if files are already migrated to the encryption system * @return int|false migration status, false = in case of no record * @note If records are not being returned, check for a hidden space * at the start of the uid in db @@ -1288,7 +1288,7 @@ class Util { } /** - * @brief get uid of the owners of the file and the path to the file + * get uid of the owners of the file and the path to the file * @param string $path Path of the file to check * @throws \Exception * @note $shareFilePath must be relative to data/UID/files. Files @@ -1367,7 +1367,7 @@ class Util { } /** - * @brief go recursively through a dir and collect all files and sub files. + * go recursively through a dir and collect all files and sub files. * @param string $dir relative to the users files folder * @return array with list of files relative to the users files folder */ @@ -1397,7 +1397,7 @@ class Util { } /** - * @brief get owner of the shared files. + * get owner of the shared files. * @param int $id ID of a share * @return string owner */ @@ -1511,7 +1511,7 @@ class Util { } /** - * @brief add recovery key to all encrypted files + * add recovery key to all encrypted files */ public function addRecoveryKeys($path = '/') { $dirContent = $this->view->getDirectoryContent($this->keyfilesPath . $path); @@ -1532,7 +1532,7 @@ class Util { } /** - * @brief remove recovery key to all encrypted files + * remove recovery key to all encrypted files */ public function removeRecoveryKeys($path = '/') { $dirContent = $this->view->getDirectoryContent($this->keyfilesPath . $path); @@ -1550,7 +1550,7 @@ class Util { } /** - * @brief decrypt given file with recovery key and encrypt it again to the owner and his new key + * decrypt given file with recovery key and encrypt it again to the owner and his new key * @param string $file * @param string $privateKey recovery key to decrypt the file */ @@ -1598,7 +1598,7 @@ class Util { } /** - * @brief collect all files and recover them one by one + * collect all files and recover them one by one * @param string $path to look for files keys * @param string $privateKey private recovery key which is used to decrypt the files */ @@ -1618,7 +1618,7 @@ class Util { } /** - * @brief recover users files in case of password lost + * recover users files in case of password lost * @param string $recoveryPassword */ public function recoverUsersFiles($recoveryPassword) { @@ -1637,7 +1637,7 @@ class Util { } /** - * @brief check if the file is stored on a system wide mount point + * check if the file is stored on a system wide mount point * @param string $path relative to /data/user with leading '/' * @return boolean */ @@ -1654,7 +1654,7 @@ class Util { } /** - * @brief decrypt private key and add it to the current session + * decrypt private key and add it to the current session * @param array $params with 'uid' and 'password' * @return mixed session or false */ @@ -1682,7 +1682,7 @@ class Util { } /* - * @brief remove encryption related keys from the session + * remove encryption related keys from the session */ public function closeEncryptionSession() { $session = new \OCA\Encryption\Session($this->view); diff --git a/apps/files_encryption/tests/crypt.php b/apps/files_encryption/tests/crypt.php index b98798d7265..b22cd214eaa 100755 --- a/apps/files_encryption/tests/crypt.php +++ b/apps/files_encryption/tests/crypt.php @@ -206,7 +206,7 @@ class Test_Encryption_Crypt extends \PHPUnit_Framework_TestCase { /** * @medium - * @brief Test that data that is written by the crypto stream wrapper + * Test that data that is written by the crypto stream wrapper * @note Encrypted data is manually prepared and decrypted here to avoid dependency on success of stream_read * @note If this test fails with truncate content, check that enough array slices are being rejoined to form $e, as the crypt.php file may have gotten longer and broken the manual * reassembly of its data @@ -293,7 +293,7 @@ class Test_Encryption_Crypt extends \PHPUnit_Framework_TestCase { /** * @medium - * @brief Test that data that is read by the crypto stream wrapper + * Test that data that is read by the crypto stream wrapper */ function testSymmetricStreamDecryptShortFileContent() { @@ -388,7 +388,7 @@ class Test_Encryption_Crypt extends \PHPUnit_Framework_TestCase { /** * @medium - * @brief test decryption using legacy blowfish method + * test decryption using legacy blowfish method */ function testLegacyDecryptShort() { @@ -402,7 +402,7 @@ class Test_Encryption_Crypt extends \PHPUnit_Framework_TestCase { /** * @medium - * @brief test decryption using legacy blowfish method + * test decryption using legacy blowfish method */ function testLegacyDecryptLong() { @@ -660,7 +660,7 @@ class Test_Encryption_Crypt extends \PHPUnit_Framework_TestCase { /** - * @brief encryption using legacy blowfish method + * encryption using legacy blowfish method * @param string $data data to encrypt * @param string $passwd password * @return string diff --git a/apps/files_encryption/tests/hooks.php b/apps/files_encryption/tests/hooks.php index ee534f708c2..fcb369c7238 100644 --- a/apps/files_encryption/tests/hooks.php +++ b/apps/files_encryption/tests/hooks.php @@ -32,7 +32,7 @@ use OCA\Encryption; /** * Class Test_Encryption_Hooks - * @brief this class provide basic hook app tests + * this class provide basic hook app tests */ class Test_Encryption_Hooks extends \PHPUnit_Framework_TestCase { @@ -259,7 +259,7 @@ class Test_Encryption_Hooks extends \PHPUnit_Framework_TestCase { } /** - * @brief test rename operation + * test rename operation */ function testRenameHook() { diff --git a/apps/files_encryption/tests/proxy.php b/apps/files_encryption/tests/proxy.php index 533aaa376b9..8d6bc81b08d 100644 --- a/apps/files_encryption/tests/proxy.php +++ b/apps/files_encryption/tests/proxy.php @@ -33,7 +33,7 @@ use OCA\Encryption; /** * Class Test_Encryption_Proxy - * @brief this class provide basic proxy app tests + * this class provide basic proxy app tests */ class Test_Encryption_Proxy extends \PHPUnit_Framework_TestCase { @@ -91,7 +91,7 @@ class Test_Encryption_Proxy extends \PHPUnit_Framework_TestCase { /** * @medium - * @brief test if postFileSize returns the unencrypted file size + * test if postFileSize returns the unencrypted file size */ function testPostFileSize() { diff --git a/apps/files_encryption/tests/share.php b/apps/files_encryption/tests/share.php index f75092f5436..bb3d7505a5d 100755 --- a/apps/files_encryption/tests/share.php +++ b/apps/files_encryption/tests/share.php @@ -959,7 +959,7 @@ class Test_Encryption_Share extends \PHPUnit_Framework_TestCase { /** - * @brief test moving a shared file out of the Shared folder + * test moving a shared file out of the Shared folder */ function testRename() { diff --git a/apps/files_encryption/tests/stream.php b/apps/files_encryption/tests/stream.php index f742cd3f8e9..5df9cdbe1f1 100644 --- a/apps/files_encryption/tests/stream.php +++ b/apps/files_encryption/tests/stream.php @@ -33,7 +33,7 @@ use OCA\Encryption; /** * Class Test_Encryption_Stream - * @brief this class provide basic stream tests + * this class provide basic stream tests */ class Test_Encryption_Stream extends \PHPUnit_Framework_TestCase { @@ -183,7 +183,7 @@ class Test_Encryption_Stream extends \PHPUnit_Framework_TestCase { /** * @medium - * @brief test if stream wrapper can read files outside from the data folder + * test if stream wrapper can read files outside from the data folder */ function testStreamFromLocalFile() { diff --git a/apps/files_encryption/tests/trashbin.php b/apps/files_encryption/tests/trashbin.php index e36293ba81e..5d54b7db24f 100755 --- a/apps/files_encryption/tests/trashbin.php +++ b/apps/files_encryption/tests/trashbin.php @@ -34,7 +34,7 @@ use OCA\Encryption; /** * Class Test_Encryption_Trashbin - * @brief this class provide basic trashbin app tests + * this class provide basic trashbin app tests */ class Test_Encryption_Trashbin extends \PHPUnit_Framework_TestCase { @@ -114,7 +114,7 @@ class Test_Encryption_Trashbin extends \PHPUnit_Framework_TestCase { /** * @medium - * @brief test delete file + * test delete file */ function testDeleteFile() { @@ -186,7 +186,7 @@ class Test_Encryption_Trashbin extends \PHPUnit_Framework_TestCase { /** * @medium - * @brief test restore file + * test restore file * * @depends testDeleteFile */ @@ -218,7 +218,7 @@ class Test_Encryption_Trashbin extends \PHPUnit_Framework_TestCase { /** * @medium - * @brief test delete file forever + * test delete file forever */ function testPermanentDeleteFile() { diff --git a/apps/files_encryption/tests/util.php b/apps/files_encryption/tests/util.php index 395bf152cd9..a4dcc5cc8bd 100755 --- a/apps/files_encryption/tests/util.php +++ b/apps/files_encryption/tests/util.php @@ -121,7 +121,7 @@ class Test_Encryption_Util extends \PHPUnit_Framework_TestCase { /** * @medium - * @brief test that paths set during User construction are correct + * test that paths set during User construction are correct */ function testKeyPaths() { $util = new Encryption\Util($this->view, $this->userId); @@ -136,7 +136,7 @@ class Test_Encryption_Util extends \PHPUnit_Framework_TestCase { /** * @medium - * @brief test detection of encrypted files + * test detection of encrypted files */ function testIsEncryptedPath() { @@ -171,7 +171,7 @@ class Test_Encryption_Util extends \PHPUnit_Framework_TestCase { /** * @medium - * @brief test setup of encryption directories + * test setup of encryption directories */ function testSetupServerSide() { $this->assertEquals(true, $this->util->setupServerSide($this->pass)); @@ -179,14 +179,14 @@ class Test_Encryption_Util extends \PHPUnit_Framework_TestCase { /** * @medium - * @brief test checking whether account is ready for encryption, + * test checking whether account is ready for encryption, */ function testUserIsReady() { $this->assertEquals(true, $this->util->ready()); } /** - * @brief test checking whether account is not ready for encryption, + * test checking whether account is not ready for encryption, */ // function testUserIsNotReady() { // $this->view->unlink($this->publicKeyDir); @@ -200,7 +200,7 @@ class Test_Encryption_Util extends \PHPUnit_Framework_TestCase { /** * @medium - * @brief test checking whether account is not ready for encryption, + * test checking whether account is not ready for encryption, */ function testIsLegacyUser() { \Test_Encryption_Util::loginHelper(\Test_Encryption_Util::TEST_ENCRYPTION_UTIL_LEGACY_USER); @@ -279,7 +279,7 @@ class Test_Encryption_Util extends \PHPUnit_Framework_TestCase { } /** -< * @brief Test that data that is read by the crypto stream wrapper +< * Test that data that is read by the crypto stream wrapper */ function testGetFileSize() { \Test_Encryption_Util::loginHelper(\Test_Encryption_Util::TEST_ENCRYPTION_UTIL_USER1); diff --git a/apps/files_encryption/tests/webdav.php b/apps/files_encryption/tests/webdav.php index bdd3d51897b..d33dc58cf92 100755 --- a/apps/files_encryption/tests/webdav.php +++ b/apps/files_encryption/tests/webdav.php @@ -34,7 +34,7 @@ use OCA\Encryption; /** * Class Test_Encryption_Webdav * - * @brief this class provide basic webdav tests for PUT,GET and DELETE + * this class provide basic webdav tests for PUT,GET and DELETE */ class Test_Encryption_Webdav extends \PHPUnit_Framework_TestCase { @@ -112,7 +112,7 @@ class Test_Encryption_Webdav extends \PHPUnit_Framework_TestCase { } /** - * @brief test webdav put random file + * test webdav put random file */ function testWebdavPUT() { @@ -167,7 +167,7 @@ class Test_Encryption_Webdav extends \PHPUnit_Framework_TestCase { } /** - * @brief test webdav get random file + * test webdav get random file * * @depends testWebdavPUT */ @@ -190,7 +190,7 @@ class Test_Encryption_Webdav extends \PHPUnit_Framework_TestCase { } /** - * @brief test webdav delete random file + * test webdav delete random file * @depends testWebdavGET */ function testWebdavDELETE($filename) { @@ -216,7 +216,7 @@ class Test_Encryption_Webdav extends \PHPUnit_Framework_TestCase { } /** - * @brief handle webdav request + * handle webdav request * * @param bool $body * diff --git a/apps/files_external/lib/dropbox.php b/apps/files_external/lib/dropbox.php index 9b0e6befee3..0b624b27176 100755 --- a/apps/files_external/lib/dropbox.php +++ b/apps/files_external/lib/dropbox.php @@ -63,7 +63,7 @@ class Dropbox extends \OC\Files\Storage\Common { } /** - * @brief Returns the path's metadata + * Returns the path's metadata * @param string $path path for which to return the metadata * @param bool $list if true, also return the directory's contents * @return mixed directory contents if $list is true, file metadata if $list is diff --git a/apps/files_sharing/lib/api.php b/apps/files_sharing/lib/api.php index 5749836bed1..21fd5d00a4c 100644 --- a/apps/files_sharing/lib/api.php +++ b/apps/files_sharing/lib/api.php @@ -25,7 +25,7 @@ namespace OCA\Files\Share; class Api { /** - * @brief get all shares + * get all shares * * @param array $params option 'file' to limit the result to a specific file/folder * @return \OC_OCS_Result share information @@ -60,7 +60,7 @@ class Api { } /** - * @brief get share information for a given share + * get share information for a given share * * @param array $params which contains a 'id' * @return \OC_OCS_Result share information @@ -76,7 +76,7 @@ class Api { } /** - * @brief collect all share information, either of a specific share or all + * collect all share information, either of a specific share or all * shares for a given path * @param array $params * @return \OC_OCS_Result @@ -130,7 +130,7 @@ class Api { } /** - * @brief add reshares to a array of shares + * add reshares to a array of shares * @param array $shares array of shares * @param int $itemSource item source ID * @return array new shares array which includes reshares @@ -161,7 +161,7 @@ class Api { } /** - * @brief get share from all files in a given folder (non-recursive) + * get share from all files in a given folder (non-recursive) * @param array $params contains 'path' to the folder * @return \OC_OCS_Result */ @@ -196,7 +196,7 @@ class Api { } /** - * @brief create a new share + * create a new share * @param array $params * @return \OC_OCS_Result */ @@ -313,7 +313,7 @@ class Api { } /** - * @brief update permissions for a share + * update permissions for a share * @param array $share information about the share * @param array $params contains 'permissions' * @return \OC_OCS_Result @@ -358,7 +358,7 @@ class Api { } /** - * @brief enable/disable public upload + * enable/disable public upload * @param array $share information about the share * @param array $params contains 'publicUpload' which can be 'yes' or 'no' * @return \OC_OCS_Result @@ -384,7 +384,7 @@ class Api { } /** - * @brief update password for public link share + * update password for public link share * @param array $share information about the share * @param array $params 'password' * @return \OC_OCS_Result @@ -438,7 +438,7 @@ class Api { } /** - * @brief unshare a file/folder + * unshare a file/folder * @param array $params contains the shareID 'id' which should be unshared * @return \OC_OCS_Result */ @@ -478,7 +478,7 @@ class Api { } /** - * @brief get file ID from a given path + * get file ID from a given path * @param string $path * @return string fileID or null */ @@ -495,7 +495,7 @@ class Api { } /** - * @brief get itemType + * get itemType * @param string $path * @return string type 'file', 'folder' or null of file/folder doesn't exists */ @@ -513,7 +513,7 @@ class Api { } /** - * @brief get some information from a given share + * get some information from a given share * @param int $shareID * @return array with: item_source, share_type, share_with, item_type, permissions */ diff --git a/apps/files_sharing/lib/cache.php b/apps/files_sharing/lib/cache.php index f793c19307d..9d83ed13b87 100644 --- a/apps/files_sharing/lib/cache.php +++ b/apps/files_sharing/lib/cache.php @@ -42,7 +42,7 @@ class Shared_Cache extends Cache { } /** - * @brief Get the source cache of a shared file or folder + * Get the source cache of a shared file or folder * @param string $target Shared target file path * @return \OC\Files\Cache\Cache */ diff --git a/apps/files_sharing/lib/helper.php b/apps/files_sharing/lib/helper.php index dd4056b48f1..71b496ab944 100644 --- a/apps/files_sharing/lib/helper.php +++ b/apps/files_sharing/lib/helper.php @@ -162,7 +162,7 @@ class Helper { } /** - * @brief Format a path to be relative to the /user/files/ directory + * Format a path to be relative to the /user/files/ directory * @param string $path the absolute path * @return string e.g. turns '/admin/files/test.txt' into 'test.txt' */ diff --git a/apps/files_sharing/lib/share/file.php b/apps/files_sharing/lib/share/file.php index 9950b4d61fd..af71786b104 100644 --- a/apps/files_sharing/lib/share/file.php +++ b/apps/files_sharing/lib/share/file.php @@ -54,7 +54,7 @@ class OC_Share_Backend_File implements OCP\Share_Backend_File_Dependent { } /** - * @brief create unique target + * create unique target * @param string $filePath * @param string $shareWith * @param string $exclude @@ -154,7 +154,7 @@ class OC_Share_Backend_File implements OCP\Share_Backend_File_Dependent { } /** - * @brief resolve reshares to return the correct source item + * resolve reshares to return the correct source item * @param array $source * @return array source item */ diff --git a/apps/files_sharing/lib/sharedstorage.php b/apps/files_sharing/lib/sharedstorage.php index a6a34d9adc0..4b69276d05a 100644 --- a/apps/files_sharing/lib/sharedstorage.php +++ b/apps/files_sharing/lib/sharedstorage.php @@ -36,7 +36,7 @@ class Shared extends \OC\Files\Storage\Common { } /** - * @brief get id of the mount point + * get id of the mount point * @return string */ public function getId() { @@ -44,7 +44,7 @@ class Shared extends \OC\Files\Storage\Common { } /** - * @brief get file cache of the shared item source + * get file cache of the shared item source * @return string */ public function getSourceId() { @@ -52,7 +52,7 @@ class Shared extends \OC\Files\Storage\Common { } /** - * @brief Get the source file path, permissions, and owner for a shared file + * Get the source file path, permissions, and owner for a shared file * @param string $target Shared target file path * @return Returns array with the keys path, permissions, and owner or false if not found */ @@ -75,7 +75,7 @@ class Shared extends \OC\Files\Storage\Common { } /** - * @brief Get the source file path for a shared file + * Get the source file path for a shared file * @param string $target Shared target file path * @return string source file path or false if not found */ @@ -98,7 +98,7 @@ class Shared extends \OC\Files\Storage\Common { } /** - * @brief Get the permissions granted for a shared file + * Get the permissions granted for a shared file * @param string $target Shared target file path * @return int CRUDS permissions granted */ @@ -263,7 +263,7 @@ class Shared extends \OC\Files\Storage\Common { } /** - * @brief Format a path to be relative to the /user/files/ directory + * Format a path to be relative to the /user/files/ directory * @param string $path the absolute path * @return string e.g. turns '/admin/files/test.txt' into '/test.txt' */ @@ -287,7 +287,7 @@ class Shared extends \OC\Files\Storage\Common { } /** - * @brief rename a shared folder/file + * rename a shared folder/file * @param string $sourcePath * @param string $targetPath * @return bool @@ -481,7 +481,7 @@ class Shared extends \OC\Files\Storage\Common { } /** - * @brief return mount point of share, relative to data/user/files + * return mount point of share, relative to data/user/files * @return string */ public function getMountPoint() { @@ -489,7 +489,7 @@ class Shared extends \OC\Files\Storage\Common { } /** - * @brief get share type + * get share type * @return integer can be single user share (0) group share (1), unique group share name (2) */ private function getShareType() { @@ -501,7 +501,7 @@ class Shared extends \OC\Files\Storage\Common { } /** - * @brief does the group share already has a user specific unique name + * does the group share already has a user specific unique name * @return bool */ private function uniqueNameSet() { @@ -509,14 +509,14 @@ class Shared extends \OC\Files\Storage\Common { } /** - * @brief the share now uses a unique name of this user + * the share now uses a unique name of this user */ private function setUniqueName() { $this->share['unique_name'] = true; } /** - * @brief get share ID + * get share ID * @return integer unique share ID */ private function getShareId() { @@ -524,7 +524,7 @@ class Shared extends \OC\Files\Storage\Common { } /** - * @brief get the user who shared the file + * get the user who shared the file * @return string */ public function getSharedFrom() { @@ -532,7 +532,7 @@ class Shared extends \OC\Files\Storage\Common { } /** - * @brief return share type, can be "file" or "folder" + * return share type, can be "file" or "folder" * @return string */ public function getItemType() { diff --git a/apps/files_sharing/lib/updater.php b/apps/files_sharing/lib/updater.php index 49044383df5..21d67caad9d 100644 --- a/apps/files_sharing/lib/updater.php +++ b/apps/files_sharing/lib/updater.php @@ -27,7 +27,7 @@ class Shared_Updater { static private $toRemove = array(); /** - * @brief walk up the users file tree and update the etags + * walk up the users file tree and update the etags * @param string $user * @param string $path */ @@ -78,7 +78,7 @@ class Shared_Updater { } /** - * @brief remove all shares for a given file if the file was deleted + * remove all shares for a given file if the file was deleted * * @param string $path */ diff --git a/apps/files_sharing/tests/api.php b/apps/files_sharing/tests/api.php index 615eacc7186..dc07c6fc620 100644 --- a/apps/files_sharing/tests/api.php +++ b/apps/files_sharing/tests/api.php @@ -352,7 +352,7 @@ class Test_Files_Sharing_Api extends Test_Files_Sharing_Base { } /** - * @brief share a folder, than reshare a file within the shared folder and check if we construct the correct path + * share a folder, than reshare a file within the shared folder and check if we construct the correct path * @medium */ function testGetShareFromFolderReshares() { @@ -417,7 +417,7 @@ class Test_Files_Sharing_Api extends Test_Files_Sharing_Base { } /** - * @brief reshare a sub folder and check if we get the correct path + * reshare a sub folder and check if we get the correct path * @medium */ function testGetShareFromSubFolderReShares() { @@ -470,7 +470,7 @@ class Test_Files_Sharing_Api extends Test_Files_Sharing_Base { } /** - * @brief test re-re-share of folder if the path gets constructed correctly + * test re-re-share of folder if the path gets constructed correctly * @medium */ function testGetShareFromFolderReReShares() { @@ -538,7 +538,7 @@ class Test_Files_Sharing_Api extends Test_Files_Sharing_Base { } /** - * @brief test multiple shared folder if the path gets constructed correctly + * test multiple shared folder if the path gets constructed correctly * @medium */ function testGetShareMultipleSharedFolder() { @@ -621,7 +621,7 @@ class Test_Files_Sharing_Api extends Test_Files_Sharing_Base { } /** - * @brief test re-re-share of folder if the path gets constructed correctly + * test re-re-share of folder if the path gets constructed correctly * @medium */ function testGetShareFromFileReReShares() { @@ -895,7 +895,7 @@ class Test_Files_Sharing_Api extends Test_Files_Sharing_Base { } /** - * @brief test unshare of a reshared file + * test unshare of a reshared file */ function testDeleteReshare() { @@ -939,7 +939,7 @@ class Test_Files_Sharing_Api extends Test_Files_Sharing_Base { } /** - * @brief share a folder which contains a share mount point, should be forbidden + * share a folder which contains a share mount point, should be forbidden */ public function testShareFolderWithAMountPoint() { // user 1 shares a folder with user2 diff --git a/apps/files_sharing/tests/base.php b/apps/files_sharing/tests/base.php index 27f9419810c..7cd36b9d419 100644 --- a/apps/files_sharing/tests/base.php +++ b/apps/files_sharing/tests/base.php @@ -119,7 +119,7 @@ abstract class Test_Files_Sharing_Base extends \PHPUnit_Framework_TestCase { } /** - * @brief get some information from a given share + * get some information from a given share * @param int $shareID * @return array with: item_source, share_type, share_with, item_type, permissions */ diff --git a/apps/files_sharing/tests/cache.php b/apps/files_sharing/tests/cache.php index 4e63a1844c6..c5408ba55e7 100644 --- a/apps/files_sharing/tests/cache.php +++ b/apps/files_sharing/tests/cache.php @@ -230,7 +230,7 @@ class Test_Files_Sharing_Cache extends Test_Files_Sharing_Base { } /** - * @brief verify if each value from the result matches the expected result + * verify if each value from the result matches the expected result * @param array $example array with the expected results * @param array $result array with the results */ diff --git a/apps/files_trashbin/lib/hooks.php b/apps/files_trashbin/lib/hooks.php index a6f8811cbe1..b6f0fb7e547 100644 --- a/apps/files_trashbin/lib/hooks.php +++ b/apps/files_trashbin/lib/hooks.php @@ -29,7 +29,7 @@ namespace OCA\Files_Trashbin; class Hooks { /** - * @brief Copy files to trash bin + * Copy files to trash bin * @param array $params * * This function is connected to the delete signal of OC_Filesystem @@ -44,7 +44,7 @@ class Hooks { } /** - * @brief clean up user specific settings if user gets deleted + * clean up user specific settings if user gets deleted * @param array $params array with uid * * This function is connected to the pre_deleteUser signal of OC_Users @@ -56,7 +56,7 @@ class Hooks { Trashbin::deleteUser($uid); } } - + public static function post_write_hook($params) { Trashbin::resizeTrash(\OCP\User::getUser()); } diff --git a/apps/files_trashbin/lib/trashbin.php b/apps/files_trashbin/lib/trashbin.php index 5baa307299c..e95f1b13c37 100644 --- a/apps/files_trashbin/lib/trashbin.php +++ b/apps/files_trashbin/lib/trashbin.php @@ -62,7 +62,7 @@ class Trashbin { /** - * @brief copy file to owners trash + * copy file to owners trash * @param string $sourcePath * @param string $owner * @param string $ownerPath @@ -373,7 +373,7 @@ class Trashbin { } /** - * @brief restore versions from trash bin + * restore versions from trash bin * * @param \OC\Files\View $view file view * @param string $file complete path to file @@ -421,7 +421,7 @@ class Trashbin { } /** - * @brief restore encryption keys from trash bin + * restore encryption keys from trash bin * * @param \OC\Files\View $view * @param string $file complete path to file @@ -523,7 +523,7 @@ class Trashbin { } /** - * @brief delete all files from the trash + * delete all files from the trash */ public static function deleteAll() { $user = \OCP\User::getUser(); @@ -537,7 +537,7 @@ class Trashbin { /** - * @brief delete file from trash bin permanently + * delete file from trash bin permanently * * @param string $filename path to the file * @param int $timestamp of deletion time @@ -653,7 +653,7 @@ class Trashbin { } /** - * @brief deletes used space for trash bin in db if user was deleted + * deletes used space for trash bin in db if user was deleted * * @param type $uid id of deleted user * @return bool result of db delete operation @@ -707,7 +707,7 @@ class Trashbin { } /** - * @brief resize trash bin if necessary after a new file was added to ownCloud + * resize trash bin if necessary after a new file was added to ownCloud * @param string $user user id */ public static function resizeTrash($user) { @@ -871,7 +871,7 @@ class Trashbin { } /** - * @brief get the size from a given root folder + * get the size from a given root folder * @param \OC\Files\View $view file view on the root folder * @return integer size of the folder */ @@ -925,7 +925,7 @@ class Trashbin { } /** - * @brief check if trash bin is empty for a given user + * check if trash bin is empty for a given user * @param string $user */ public static function isEmpty($user) { diff --git a/apps/files_versions/lib/hooks.php b/apps/files_versions/lib/hooks.php index c0f7201de3b..2de4001affd 100644 --- a/apps/files_versions/lib/hooks.php +++ b/apps/files_versions/lib/hooks.php @@ -29,7 +29,7 @@ class Hooks { /** - * @brief Erase versions of deleted file + * Erase versions of deleted file * @param array $params * * This function is connected to the delete signal of OC_Filesystem @@ -46,7 +46,7 @@ class Hooks { } /** - * @brief mark file as "deleted" so that we can clean up the versions if the file is gone + * mark file as "deleted" so that we can clean up the versions if the file is gone * @param array $params */ public static function pre_remove_hook($params) { @@ -57,7 +57,7 @@ class Hooks { } /** - * @brief rename/move versions of renamed/moved files + * rename/move versions of renamed/moved files * @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 @@ -75,7 +75,7 @@ class Hooks { } /** - * @brief clean up user specific settings if user gets deleted + * clean up user specific settings if user gets deleted * @param array $params array with uid * * This function is connected to the pre_deleteUser signal of OC_Users diff --git a/apps/files_versions/lib/versions.php b/apps/files_versions/lib/versions.php index 3bbbb26791b..56e1dfc2e24 100644 --- a/apps/files_versions/lib/versions.php +++ b/apps/files_versions/lib/versions.php @@ -147,7 +147,7 @@ class Storage { /** - * @brief mark file as deleted so that we can remove the versions if the file is gone + * mark file as deleted so that we can remove the versions if the file is gone * @param string $path */ public static function markDeletedFile($path) { @@ -261,7 +261,7 @@ class Storage { /** - * @brief get a list of all available versions of a file in descending chronological order + * get a list of all available versions of a file in descending chronological order * @param string $uid user id from the owner of the file * @param string $filename file to find versions of, relative to the user files dir * @param string $userFullPath @@ -307,7 +307,7 @@ class Storage { } /** - * @brief translate a timestamp into a string like "5 days ago" + * translate a timestamp into a string like "5 days ago" * @param int $timestamp * @return string for example "5 days ago" */ @@ -334,7 +334,7 @@ class Storage { } /** - * @brief deletes used space for files versions in db if user was deleted + * deletes used space for files versions in db if user was deleted * * @param string $uid id of deleted user * @return \OC_DB_StatementWrapper of db delete operation @@ -345,7 +345,7 @@ class Storage { } /** - * @brief get the size of all stored versions from a given user + * get the size of all stored versions from a given user * @param string $uid id from the user * @return int size of versions */ @@ -372,7 +372,7 @@ class Storage { } /** - * @brief returns all stored file versions from a given user + * returns all stored file versions from a given user * @param string $uid id of the user * @return array with contains two arrays 'all' which contains all versions sorted by age and 'by_file' which contains all versions sorted by filename */ @@ -420,7 +420,7 @@ class Storage { } /** - * @brief get list of files we want to expire + * get list of files we want to expire * @param array $versions list of versions * @param integer $time * @return array containing the list of to deleted versions and the size of them @@ -477,7 +477,7 @@ class Storage { } /** - * @brief Erase a file's versions which exceed the set quota + * Erase a file's versions which exceed the set quota */ private static function expire($filename, $versionsSize = null, $offset = 0) { if(\OCP\Config::getSystemValue('files_versions', Storage::DEFAULTENABLED)=='true') { @@ -574,7 +574,7 @@ class Storage { } /** - * @brief create recursively missing directories + * create recursively missing directories * @param string $filename $path to a file * @param \OC\Files\View $view view on data/user/ */ diff --git a/apps/files_versions/tests/versions.php b/apps/files_versions/tests/versions.php index 9f15b86d981..aa66faffcbf 100644 --- a/apps/files_versions/tests/versions.php +++ b/apps/files_versions/tests/versions.php @@ -24,14 +24,14 @@ require_once __DIR__ . '/../lib/versions.php'; /** * Class Test_Files_versions - * @brief this class provide basic files versions test + * this class provide basic files versions test */ class Test_Files_Versioning extends \PHPUnit_Framework_TestCase { /** * @medium - * @brief test expire logic + * test expire logic * @dataProvider versionsProvider */ function testGetExpireList($versions, $sizeOfAllDeletedFiles) { diff --git a/apps/user_ldap/group_ldap.php b/apps/user_ldap/group_ldap.php index b34dc339996..4051b1d8cae 100644 --- a/apps/user_ldap/group_ldap.php +++ b/apps/user_ldap/group_ldap.php @@ -39,7 +39,7 @@ class GROUP_LDAP extends BackendUtility implements \OCP\GroupInterface { } /** - * @brief is user in group? + * is user in group? * @param string $uid uid of the user * @param string $gid gid of the group * @return bool @@ -126,7 +126,7 @@ class GROUP_LDAP extends BackendUtility implements \OCP\GroupInterface { } /** - * @brief Get all groups a user belongs to + * Get all groups a user belongs to * @param string $uid Name of the user * @return array with group names * @@ -204,7 +204,7 @@ class GROUP_LDAP extends BackendUtility implements \OCP\GroupInterface { } /** - * @brief get a list of all users in a group + * get a list of all users in a group * @return array with user ids */ public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) { @@ -285,7 +285,7 @@ class GROUP_LDAP extends BackendUtility implements \OCP\GroupInterface { } /** - * @brief returns the number of users in a group, who match the search term + * returns the number of users in a group, who match the search term * @param string $gid the internal group name * @param string $search optional, a search string * @return int|bool @@ -363,7 +363,7 @@ class GROUP_LDAP extends BackendUtility implements \OCP\GroupInterface { } /** - * @brief get a list of all groups + * get a list of all groups * @return array with group names * * Returns a list with all groups (used by getGroups) @@ -402,7 +402,7 @@ class GROUP_LDAP extends BackendUtility implements \OCP\GroupInterface { } /** - * @brief get a list of all groups using a paged search + * get a list of all groups using a paged search * @return array with group names * * Returns a list with all groups @@ -480,7 +480,7 @@ class GROUP_LDAP extends BackendUtility implements \OCP\GroupInterface { } /** - * @brief Check if backend implements actions + * Check if backend implements actions * @param int $actions bitwise-or'ed actions * @return boolean * diff --git a/apps/user_ldap/group_proxy.php b/apps/user_ldap/group_proxy.php index 7e401620e82..1a36953676b 100644 --- a/apps/user_ldap/group_proxy.php +++ b/apps/user_ldap/group_proxy.php @@ -30,7 +30,7 @@ class Group_Proxy extends lib\Proxy implements \OCP\GroupInterface { private $refBackend = null; /** - * @brief Constructor + * Constructor * @param string[] $serverConfigPrefixes array containing the config Prefixes */ public function __construct($serverConfigPrefixes, ILDAPWrapper $ldap) { @@ -45,7 +45,7 @@ class Group_Proxy extends lib\Proxy implements \OCP\GroupInterface { } /** - * @brief Tries the backends one after the other until a positive result is returned from the specified method + * Tries the backends one after the other until a positive result is returned from the specified method * @param string $gid the gid connected to the request * @param string $method the method of the group backend that shall be called * @param array $parameters an array of parameters to be passed @@ -63,7 +63,7 @@ class Group_Proxy extends lib\Proxy implements \OCP\GroupInterface { } /** - * @brief Asks the backend connected to the server that supposely takes care of the gid from the request. + * Asks the backend connected to the server that supposely takes care of the gid from the request. * @param string $gid the gid connected to the request * @param string $method the method of the group backend that shall be called * @param array $parameters an array of parameters to be passed @@ -95,7 +95,7 @@ class Group_Proxy extends lib\Proxy implements \OCP\GroupInterface { } /** - * @brief is user in group? + * is user in group? * @param string $uid uid of the user * @param string $gid gid of the group * @return bool @@ -107,7 +107,7 @@ class Group_Proxy extends lib\Proxy implements \OCP\GroupInterface { } /** - * @brief Get all groups a user belongs to + * Get all groups a user belongs to * @param string $uid Name of the user * @return string[] with group names * @@ -128,7 +128,7 @@ class Group_Proxy extends lib\Proxy implements \OCP\GroupInterface { } /** - * @brief get a list of all users in a group + * get a list of all users in a group * @return string[] with user ids */ public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) { @@ -145,7 +145,7 @@ class Group_Proxy extends lib\Proxy implements \OCP\GroupInterface { } /** - * @brief returns the number of users in a group, who match the search term + * returns the number of users in a group, who match the search term * @param string $gid the internal group name * @param string $search optional, a search string * @return int|bool @@ -156,7 +156,7 @@ class Group_Proxy extends lib\Proxy implements \OCP\GroupInterface { } /** - * @brief get a list of all groups + * get a list of all groups * @return string[] with group names * * Returns a list with all groups @@ -184,7 +184,7 @@ class Group_Proxy extends lib\Proxy implements \OCP\GroupInterface { } /** - * @brief Check if backend implements actions + * Check if backend implements actions * @param int $actions bitwise-or'ed actions * @return boolean * diff --git a/apps/user_ldap/lib/access.php b/apps/user_ldap/lib/access.php index 441eb40489e..78de14f4ee9 100644 --- a/apps/user_ldap/lib/access.php +++ b/apps/user_ldap/lib/access.php @@ -51,7 +51,7 @@ class Access extends LDAPUtility { } /** - * @brief reads a given attribute for an LDAP record identified by a DN + * reads a given attribute for an LDAP record identified by a DN * @param string $dn the record in question * @param string $attr the attribute that shall be retrieved * if empty, just check the record's existence @@ -115,7 +115,7 @@ class Access extends LDAPUtility { } /** - * @brief checks whether the given attributes value is probably a DN + * checks whether the given attributes value is probably a DN * @param string $attr the attribute in question * @return boolean if so true, otherwise false */ @@ -129,7 +129,7 @@ class Access extends LDAPUtility { } /** - * @brief sanitizes a DN received from the LDAP server + * sanitizes a DN received from the LDAP server * @param array $dn the DN in question * @return array the sanitized DN */ @@ -185,7 +185,7 @@ class Access extends LDAPUtility { } /** - * @brief returns the LDAP DN for the given internal ownCloud name of the group + * returns the LDAP DN for the given internal ownCloud name of the group * @param string $name the ownCloud name in question * @return string with the LDAP DN on success, otherwise false */ @@ -200,7 +200,7 @@ class Access extends LDAPUtility { } /** - * @brief returns the LDAP DN for the given internal ownCloud name of the user + * returns the LDAP DN for the given internal ownCloud name of the user * @param string $name the ownCloud name in question * @return string with the LDAP DN on success, otherwise false */ @@ -216,7 +216,7 @@ class Access extends LDAPUtility { } /** - * @brief returns the LDAP DN for the given internal ownCloud name + * returns the LDAP DN for the given internal ownCloud name * @param string $name the ownCloud name in question * @param boolean $isUser is it a user? otherwise group * @return string with the LDAP DN on success, otherwise false @@ -235,7 +235,7 @@ class Access extends LDAPUtility { } /** - * @brief returns the internal ownCloud name for the given LDAP DN of the group, false on DN outside of search DN or failure + * returns the internal ownCloud name for the given LDAP DN of the group, false on DN outside of search DN or failure * @param string $dn the dn of the group object * @param string $ldapName optional, the display name of the object * @return string with the name to use in ownCloud, false on DN outside of search DN @@ -252,7 +252,7 @@ class Access extends LDAPUtility { } /** - * @brief returns the internal ownCloud name for the given LDAP DN of the user, false on DN outside of search DN or failure + * returns the internal ownCloud name for the given LDAP DN of the user, false on DN outside of search DN or failure * @param string $dn the dn of the user object * @param string $ldapName optional, the display name of the object * @return string with with the name to use in ownCloud @@ -269,7 +269,7 @@ class Access extends LDAPUtility { } /** - * @brief returns an internal ownCloud name for the given LDAP DN, false on DN outside of search DN + * returns an internal ownCloud name for the given LDAP DN, false on DN outside of search DN * @param string $dn the dn of the user object * @param string $ldapName optional, the display name of the object * @param bool $isUser optional, whether it is a user object (otherwise group assumed) @@ -361,7 +361,7 @@ class Access extends LDAPUtility { } /** - * @brief gives back the user names as they are used ownClod internally + * gives back the user names as they are used ownClod internally * @param array $ldapUsers an array with the ldap Users result in style of array ( array ('dn' => foo, 'uid' => bar), ... ) * @return array an array with the user names to use in ownCloud * @@ -372,7 +372,7 @@ class Access extends LDAPUtility { } /** - * @brief gives back the group names as they are used ownClod internally + * gives back the group names as they are used ownClod internally * @param array $ldapGroups an array with the ldap Groups result in style of array ( array ('dn' => foo, 'cn' => bar), ... ) * @return array an array with the group names to use in ownCloud * @@ -452,7 +452,7 @@ class Access extends LDAPUtility { } /** - * @brief caches the user display name + * caches the user display name * @param string $ocName the internal ownCloud username * @param string $displayName the display name */ @@ -462,7 +462,7 @@ class Access extends LDAPUtility { } /** - * @brief creates a unique name for internal ownCloud use for users. Don't call it directly. + * creates a unique name for internal ownCloud use for users. Don't call it directly. * @param string $name the display name of the object * @return string with with the name to use in ownCloud or false if unsuccessful * @@ -484,7 +484,7 @@ class Access extends LDAPUtility { } /** - * @brief creates a unique name for internal ownCloud use for groups. Don't call it directly. + * creates a unique name for internal ownCloud use for groups. Don't call it directly. * @param string $name the display name of the object * @return string with with the name to use in ownCloud or false if unsuccessful. * @@ -532,7 +532,7 @@ class Access extends LDAPUtility { } /** - * @brief creates a unique name for internal ownCloud use. + * creates a unique name for internal ownCloud use. * @param string $name the display name of the object * @param boolean $isUser whether name should be created for a user (true) or a group (false) * @return string with with the name to use in ownCloud or false if unsuccessful @@ -551,7 +551,7 @@ class Access extends LDAPUtility { } /** - * @brief retrieves all known groups from the mappings table + * retrieves all known groups from the mappings table * @return array with the results * * retrieves all known groups from the mappings table @@ -561,7 +561,7 @@ class Access extends LDAPUtility { } /** - * @brief retrieves all known users from the mappings table + * retrieves all known users from the mappings table * @return array with the results * * retrieves all known users from the mappings table @@ -585,7 +585,7 @@ class Access extends LDAPUtility { } /** - * @brief inserts a new user or group into the mappings table + * inserts a new user or group into the mappings table * @param string $dn the record in question * @param string $ocName the name to use in ownCloud * @param bool $isUser is it a user or a group? @@ -670,7 +670,7 @@ class Access extends LDAPUtility { } /** - * @brief executes an LDAP search, optimized for Users + * executes an LDAP search, optimized for Users * @param string $filter the LDAP filter for the search * @param string|string[] $attr optional, when a certain attribute shall be filtered out * @param integer $limit @@ -695,7 +695,7 @@ class Access extends LDAPUtility { } /** - * @brief executes an LDAP search, optimized for Groups + * executes an LDAP search, optimized for Groups * @param string $filter the LDAP filter for the search * @param string|string[] $attr optional, when a certain attribute shall be filtered out * @param integer $limit @@ -709,7 +709,7 @@ class Access extends LDAPUtility { } /** - * @brief prepares and executes an LDAP search operation + * prepares and executes an LDAP search operation * @param string $filter the LDAP filter for the search * @param array $base an array containing the LDAP subtree(s) that shall be searched * @param string|string[] $attr optional, array, one or more attributes that shall be @@ -755,7 +755,7 @@ class Access extends LDAPUtility { } /** - * @brief processes an LDAP paged search operation + * processes an LDAP paged search operation * @param array $sr the array containing the LDAP search resources * @param string $filter the LDAP filter for the search * @param array $base an array containing the LDAP subtree(s) that shall be searched @@ -796,7 +796,7 @@ class Access extends LDAPUtility { } /** - * @brief executes an LDAP search, but counts the results only + * executes an LDAP search, but counts the results only * @param string $filter the LDAP filter for the search * @param array $base an array containing the LDAP subtree(s) that shall be searched * @param string|string[] $attr optional, array, one or more attributes that shall be @@ -861,7 +861,7 @@ class Access extends LDAPUtility { } /** - * @brief Executes an LDAP search + * Executes an LDAP search * @param string $filter the LDAP filter for the search * @param array $base an array containing the LDAP subtree(s) that shall be searched * @param string|string[] $attr optional, array, one or more attributes that shall be @@ -991,7 +991,7 @@ class Access extends LDAPUtility { } /** - * @brief escapes (user provided) parts for LDAP filter + * escapes (user provided) parts for LDAP filter * @param string $input, the provided value * @return string the escaped string */ @@ -1002,7 +1002,7 @@ class Access extends LDAPUtility { } /** - * @brief combines the input filters with AND + * combines the input filters with AND * @param string[] $filters the filters to connect * @return string the combined filter */ @@ -1011,7 +1011,7 @@ class Access extends LDAPUtility { } /** - * @brief combines the input filters with AND + * combines the input filters with AND * @param string[] $filters the filters to connect * @return string the combined filter */ @@ -1020,7 +1020,7 @@ class Access extends LDAPUtility { } /** - * @brief combines the input filters with given operator + * combines the input filters with given operator * @param string[] $filters the filters to connect * @param string $operator either & or | * @return string the combined filter @@ -1038,7 +1038,7 @@ class Access extends LDAPUtility { } /** - * @brief creates a filter part for to perform search for users + * creates a filter part for to perform search for users * @param string $search the search term * @return string the final filter part to use in LDAP searches */ @@ -1049,7 +1049,7 @@ class Access extends LDAPUtility { } /** - * @brief creates a filter part for to perform search for groups + * creates a filter part for to perform search for groups * @param string $search the search term * @return string the final filter part to use in LDAP searches */ @@ -1060,7 +1060,7 @@ class Access extends LDAPUtility { } /** - * @brief creates a filter part for searches + * creates a filter part for searches * @param string $search the search term * @param string[]|null $searchAttributes * @param string $fallbackAttribute a fallback attribute in case the user @@ -1107,7 +1107,7 @@ class Access extends LDAPUtility { } /** - * @brief auto-detects the directory's UUID attribute + * auto-detects the directory's UUID attribute * @param string $dn a known DN used to check against * @param bool $isUser * @param bool $force the detection should be run, even if it is not set to auto @@ -1183,7 +1183,7 @@ class Access extends LDAPUtility { } /** - * @brief converts a binary ObjectGUID into a string representation + * converts a binary ObjectGUID into a string representation * @param string $oguid the ObjectGUID in it's binary form as retrieved from AD * @return string * @link http://www.php.net/manual/en/function.ldap-get-values-len.php#73198 @@ -1209,7 +1209,7 @@ class Access extends LDAPUtility { } /** - * @brief converts a stored DN so it can be used as base parameter for LDAP queries, internally we store them for usage in LDAP filters + * converts a stored DN so it can be used as base parameter for LDAP queries, internally we store them for usage in LDAP filters * @param string $dn the DN * @return string */ @@ -1218,7 +1218,7 @@ class Access extends LDAPUtility { } /** - * @brief checks if the given DN is part of the given base DN(s) + * checks if the given DN is part of the given base DN(s) * @param string $dn the DN * @param string[] $bases array containing the allowed base DN or DNs * @return bool @@ -1240,7 +1240,7 @@ class Access extends LDAPUtility { } /** - * @brief get a cookie for the next LDAP paged search + * get a cookie for the next LDAP paged search * @param string $base a string with the base DN for the search * @param string $filter the search filter to identify the correct search * @param int $limit the limit (or 'pageSize'), to identify the correct search well @@ -1265,7 +1265,7 @@ class Access extends LDAPUtility { } /** - * @brief set a cookie for LDAP paged search run + * set a cookie for LDAP paged search run * @param string $base a string with the base DN for the search * @param string $filter the search filter to identify the correct search * @param int $limit the limit (or 'pageSize'), to identify the correct search well @@ -1281,7 +1281,7 @@ class Access extends LDAPUtility { } /** - * @brief Check whether the most recent paged search was successful. It flushed the state var. Use it always after a possible paged search. + * Check whether the most recent paged search was successful. It flushed the state var. Use it always after a possible paged search. * @return boolean|null true on success, null or false otherwise */ public function getPagedSearchResultState() { @@ -1291,7 +1291,7 @@ class Access extends LDAPUtility { } /** - * @brief Prepares a paged search, if possible + * Prepares a paged search, if possible * @param string $filter the LDAP filter for the search * @param string[] $bases an array containing the LDAP subtree(s) that shall be searched * @param string[] $attr optional, when a certain attribute shall be filtered outside diff --git a/apps/user_ldap/lib/backendutility.php b/apps/user_ldap/lib/backendutility.php index 8ad26246c6b..c94366ce019 100644 --- a/apps/user_ldap/lib/backendutility.php +++ b/apps/user_ldap/lib/backendutility.php @@ -29,7 +29,7 @@ abstract class BackendUtility { protected $access; /** - * @brief constructor, make sure the subclasses call this one! + * constructor, make sure the subclasses call this one! * @param Access $access an instance of Access for LDAP interaction */ public function __construct(Access $access) { diff --git a/apps/user_ldap/lib/configuration.php b/apps/user_ldap/lib/configuration.php index c6c3c6b89bf..9c455929b4a 100644 --- a/apps/user_ldap/lib/configuration.php +++ b/apps/user_ldap/lib/configuration.php @@ -117,7 +117,7 @@ class Configuration { } /** - * @brief set LDAP configuration with values delivered by an array, not read + * set LDAP configuration with values delivered by an array, not read * from configuration. It does not save the configuration! To do so, you * must call saveConfiguration afterwards. * @param array $config array that holds the config parameters in an associated @@ -212,7 +212,7 @@ class Configuration { } /** - * @brief saves the current Configuration in the database + * saves the current Configuration in the database */ public function saveConfiguration() { $cta = array_flip($this->getConfigTranslationArray()); diff --git a/apps/user_ldap/lib/connection.php b/apps/user_ldap/lib/connection.php index 3a900a6fce4..52f6c5ceb10 100644 --- a/apps/user_ldap/lib/connection.php +++ b/apps/user_ldap/lib/connection.php @@ -42,7 +42,7 @@ class Connection extends LDAPUtility { protected $doNotValidate = false; /** - * @brief Constructor + * Constructor * @param ILDAPWrapper $ldap * @param string $configPrefix a string with the prefix for the configkey column (appconfig table) * @param string $configID a string with the value for the appid column (appconfig table) or null for on-the-fly connections @@ -73,7 +73,7 @@ class Connection extends LDAPUtility { } /** - * @brief defines behaviour when the instance is cloned + * defines behaviour when the instance is cloned */ public function __clone() { //a cloned instance inherits the connection resource. It may use it, @@ -117,7 +117,7 @@ class Connection extends LDAPUtility { } /** - * @brief initializes the LDAP backend + * initializes the LDAP backend * @param bool $force read the config settings no matter what */ public function init($force = false) { @@ -126,7 +126,7 @@ class Connection extends LDAPUtility { } /** - * @brief Returns the LDAP handler + * Returns the LDAP handler */ public function getConnectionResource() { if(!$this->ldapConnectionRes) { @@ -210,7 +210,7 @@ class Connection extends LDAPUtility { } /** - * @brief Caches the general LDAP configuration. + * Caches the general LDAP configuration. * @param bool $force optional. true, if the re-read should be forced. defaults * to false. * @return null @@ -223,7 +223,7 @@ class Connection extends LDAPUtility { } /** - * @brief set LDAP configuration with values delivered by an array, not read from configuration + * set LDAP configuration with values delivered by an array, not read from configuration * @param array $config array that holds the config parameters in an associated array * @param array &$setParameters optional; array where the set fields will be given to * @return boolean true if config validates, false otherwise. Check with $setParameters for detailed success on single parameters @@ -243,7 +243,7 @@ class Connection extends LDAPUtility { } /** - * @brief saves the current Configuration in the database and empties the + * saves the current Configuration in the database and empties the * cache * @return null */ @@ -253,7 +253,7 @@ class Connection extends LDAPUtility { } /** - * @brief get the current LDAP configuration + * get the current LDAP configuration * @return array */ public function getConfiguration() { @@ -433,7 +433,7 @@ class Connection extends LDAPUtility { } /** - * @brief Validates the user specified configuration + * Validates the user specified configuration * @return bool true if configuration seems OK, false otherwise */ private function validateConfiguration() { diff --git a/apps/user_ldap/lib/helper.php b/apps/user_ldap/lib/helper.php index 5641db48a32..37caedc6251 100644 --- a/apps/user_ldap/lib/helper.php +++ b/apps/user_ldap/lib/helper.php @@ -26,7 +26,7 @@ namespace OCA\user_ldap\lib; class Helper { /** - * @brief returns prefixes for each saved LDAP/AD server configuration. + * returns prefixes for each saved LDAP/AD server configuration. * @param bool $activeConfigurations optional, whether only active configuration shall be * retrieved, defaults to false * @return array with a list of the available prefixes @@ -79,7 +79,7 @@ class Helper { /** * - * @brief determines the host for every configured connection + * determines the host for every configured connection * @return array an array with configprefix as keys * */ @@ -106,7 +106,7 @@ class Helper { } /** - * @brief deletes a given saved LDAP/AD server configuration. + * deletes a given saved LDAP/AD server configuration. * @param string $prefix the configuration prefix of the config to delete * @return bool true on success, false otherwise */ @@ -176,7 +176,7 @@ class Helper { } /** - * @brief extractsthe domain from a given URL + * extractsthe domain from a given URL * @param string $url the URL * @return string|false domain as string on success, false otherwise */ diff --git a/apps/user_ldap/lib/ildapwrapper.php b/apps/user_ldap/lib/ildapwrapper.php index e17f787dbb6..97ae0810116 100644 --- a/apps/user_ldap/lib/ildapwrapper.php +++ b/apps/user_ldap/lib/ildapwrapper.php @@ -28,7 +28,7 @@ interface ILDAPWrapper { //LDAP functions in use /** - * @brief Bind to LDAP directory + * Bind to LDAP directory * @param resource $link LDAP link resource * @param string $dn an RDN to log in with * @param string $password the password @@ -39,7 +39,7 @@ interface ILDAPWrapper { public function bind($link, $dn, $password); /** - * @brief connect to an LDAP server + * connect to an LDAP server * @param string $host The host to connect to * @param string $port The port to connect to * @return mixed a link resource on success, otherwise false @@ -47,7 +47,7 @@ interface ILDAPWrapper { public function connect($host, $port); /** - * @brief Send LDAP pagination control + * Send LDAP pagination control * @param resource $link LDAP link resource * @param int $pageSize number of results per page * @param bool $isCritical Indicates whether the pagination is critical of not. @@ -57,7 +57,7 @@ interface ILDAPWrapper { public function controlPagedResult($link, $pageSize, $isCritical, $cookie); /** - * @brief Retrieve the LDAP pagination cookie + * Retrieve the LDAP pagination cookie * @param resource $link LDAP link resource * @param resource $result LDAP result resource * @param string $cookie structure sent by LDAP server @@ -68,7 +68,7 @@ interface ILDAPWrapper { public function controlPagedResultResponse($link, $result, &$cookie); /** - * @brief Count the number of entries in a search + * Count the number of entries in a search * @param resource $link LDAP link resource * @param resource $result LDAP result resource * @return int|false number of results on success, false otherwise @@ -76,21 +76,21 @@ interface ILDAPWrapper { public function countEntries($link, $result); /** - * @brief Return the LDAP error number of the last LDAP command + * Return the LDAP error number of the last LDAP command * @param resource $link LDAP link resource * @return string error message as string */ public function errno($link); /** - * @brief Return the LDAP error message of the last LDAP command + * Return the LDAP error message of the last LDAP command * @param resource $link LDAP link resource * @return int error code as integer */ public function error($link); /** - * @brief Return first result id + * Return first result id * @param resource $link LDAP link resource * @param resource $result LDAP result resource * @return Resource an LDAP search result resource @@ -98,7 +98,7 @@ interface ILDAPWrapper { public function firstEntry($link, $result); /** - * @brief Get attributes from a search result entry + * Get attributes from a search result entry * @param resource $link LDAP link resource * @param resource $result LDAP result resource * @return array containing the results, false on error @@ -106,7 +106,7 @@ interface ILDAPWrapper { public function getAttributes($link, $result); /** - * @brief Get the DN of a result entry + * Get the DN of a result entry * @param resource $link LDAP link resource * @param resource $result LDAP result resource * @return string containing the DN, false on error @@ -114,7 +114,7 @@ interface ILDAPWrapper { public function getDN($link, $result); /** - * @brief Get all result entries + * Get all result entries * @param resource $link LDAP link resource * @param resource $result LDAP result resource * @return array containing the results, false on error @@ -122,7 +122,7 @@ interface ILDAPWrapper { public function getEntries($link, $result); /** - * @brief Return next result id + * Return next result id * @param resource $link LDAP link resource * @param resource $result LDAP entry result resource * @return resource an LDAP search result resource @@ -130,7 +130,7 @@ interface ILDAPWrapper { public function nextEntry($link, $result); /** - * @brief Read an entry + * Read an entry * @param resource $link LDAP link resource * @param array $baseDN The DN of the entry to read from * @param string $filter An LDAP filter @@ -140,7 +140,7 @@ interface ILDAPWrapper { public function read($link, $baseDN, $filter, $attr); /** - * @brief Search LDAP tree + * Search LDAP tree * @param resource $link LDAP link resource * @param string $baseDN The DN of the entry to read from * @param string $filter An LDAP filter @@ -152,7 +152,7 @@ interface ILDAPWrapper { public function search($link, $baseDN, $filter, $attr, $attrsOnly = 0, $limit = 0); /** - * @brief Sets the value of the specified option to be $value + * Sets the value of the specified option to be $value * @param resource $link LDAP link resource * @param string $option a defined LDAP Server option * @param int $value the new value for the option @@ -161,14 +161,14 @@ interface ILDAPWrapper { public function setOption($link, $option, $value); /** - * @brief establish Start TLS + * establish Start TLS * @param resource $link LDAP link resource * @return bool true on success, false otherwise */ public function startTls($link); /** - * @brief Sort the result of a LDAP search + * Sort the result of a LDAP search * @param resource $link LDAP link resource * @param resource $result LDAP result resource * @param string $sortFilter attribute to use a key in sort @@ -176,7 +176,7 @@ interface ILDAPWrapper { public function sort($link, $result, $sortFilter); /** - * @brief Unbind from LDAP directory + * Unbind from LDAP directory * @param resource $link LDAP link resource * @return bool true on success, false otherwise */ @@ -185,19 +185,19 @@ interface ILDAPWrapper { //additional required methods in ownCloud /** - * @brief Checks whether the server supports LDAP + * Checks whether the server supports LDAP * @return bool true if it the case, false otherwise * */ public function areLDAPFunctionsAvailable(); /** - * @brief Checks whether PHP supports LDAP Paged Results + * Checks whether PHP supports LDAP Paged Results * @return bool true if it the case, false otherwise * */ public function hasPagedResultSupport(); /** - * @brief Checks whether the submitted parameter is a resource + * Checks whether the submitted parameter is a resource * @param resource $resource the resource variable to check * @return bool true if it is a resource, false otherwise */ diff --git a/apps/user_ldap/lib/ldap.php b/apps/user_ldap/lib/ldap.php index 212eea0d8e9..2b20b2ab738 100644 --- a/apps/user_ldap/lib/ldap.php +++ b/apps/user_ldap/lib/ldap.php @@ -204,7 +204,7 @@ class LDAP implements ILDAPWrapper { } /** - * @brief Checks whether the server supports LDAP + * Checks whether the server supports LDAP * @return boolean if it the case, false otherwise * */ public function areLDAPFunctionsAvailable() { @@ -212,7 +212,7 @@ class LDAP implements ILDAPWrapper { } /** - * @brief Checks whether PHP supports LDAP Paged Results + * Checks whether PHP supports LDAP Paged Results * @return boolean if it the case, false otherwise * */ public function hasPagedResultSupport() { @@ -222,7 +222,7 @@ class LDAP implements ILDAPWrapper { } /** - * @brief Checks whether the submitted parameter is a resource + * Checks whether the submitted parameter is a resource * @param Resource $resource the resource variable to check * @return bool true if it is a resource, false otherwise */ diff --git a/apps/user_ldap/lib/ldaputility.php b/apps/user_ldap/lib/ldaputility.php index 0d942f3b6ae..aa1e75e928b 100644 --- a/apps/user_ldap/lib/ldaputility.php +++ b/apps/user_ldap/lib/ldaputility.php @@ -27,7 +27,7 @@ abstract class LDAPUtility { protected $ldap; /** - * @brief constructor, make sure the subclasses call this one! + * constructor, make sure the subclasses call this one! * @param ILDAPWrapper $ldapWrapper an instance of an ILDAPWrapper */ public function __construct(ILDAPWrapper $ldapWrapper) { diff --git a/apps/user_ldap/lib/proxy.php b/apps/user_ldap/lib/proxy.php index f7ba9082e09..d15d1ae8616 100644 --- a/apps/user_ldap/lib/proxy.php +++ b/apps/user_ldap/lib/proxy.php @@ -90,7 +90,7 @@ abstract class Proxy { abstract protected function walkBackends($id, $method, $parameters); /** - * @brief Takes care of the request to the User backend + * Takes care of the request to the User backend * @param string $id * @param string $method string, the method of the user backend that shall be called * @param array $parameters an array of parameters to be passed diff --git a/apps/user_ldap/lib/wizard.php b/apps/user_ldap/lib/wizard.php index d1f3f7bf3f1..b8a0e5ad799 100644 --- a/apps/user_ldap/lib/wizard.php +++ b/apps/user_ldap/lib/wizard.php @@ -44,7 +44,7 @@ class Wizard extends LDAPUtility { const LDAP_NW_TIMEOUT = 4; /** - * @brief Constructor + * Constructor * @param Configuration $configuration an instance of Configuration * @param ILDAPWrapper $ldap an instance of ILDAPWrapper */ @@ -162,7 +162,7 @@ class Wizard extends LDAPUtility { } /** - * @brief return the state of the Group Filter Mode + * return the state of the Group Filter Mode * @return WizardResult */ public function getGroupFilterMode() { @@ -171,7 +171,7 @@ class Wizard extends LDAPUtility { } /** - * @brief return the state of the Login Filter Mode + * return the state of the Login Filter Mode * @return WizardResult */ public function getLoginFilterMode() { @@ -180,7 +180,7 @@ class Wizard extends LDAPUtility { } /** - * @brief return the state of the User Filter Mode + * return the state of the User Filter Mode * @return WizardResult */ public function getUserFilterMode() { @@ -189,7 +189,7 @@ class Wizard extends LDAPUtility { } /** - * @brief return the state of the mode of the specified filter + * return the state of the mode of the specified filter * @param string $confKey contains the access key of the Configuration */ private function getFilterMode($confKey) { @@ -201,7 +201,7 @@ class Wizard extends LDAPUtility { } /** - * @brief detects the available LDAP attributes + * detects the available LDAP attributes * @return array The instance's WizardResult instance * @throws \Exception */ @@ -235,7 +235,7 @@ class Wizard extends LDAPUtility { } /** - * @brief detects the available LDAP groups + * detects the available LDAP groups * @return WizardResult the instance's WizardResult instance */ public function determineGroupsForGroups() { @@ -245,7 +245,7 @@ class Wizard extends LDAPUtility { } /** - * @brief detects the available LDAP groups + * detects the available LDAP groups * @return WizardResult the instance's WizardResult instance */ public function determineGroupsForUsers() { @@ -254,7 +254,7 @@ class Wizard extends LDAPUtility { } /** - * @brief detects the available LDAP groups + * detects the available LDAP groups * @param string $dbKey * @param string $confKey * @param bool $testMemberOf @@ -310,7 +310,7 @@ class Wizard extends LDAPUtility { } /** - * @brief Detects the available object classes + * Detects the available object classes * @return WizardResult the instance's WizardResult instance * @throws \Exception */ @@ -337,7 +337,7 @@ class Wizard extends LDAPUtility { } /** - * @brief detects the available object classes + * detects the available object classes * @return WizardResult * @throws \Exception */ @@ -479,7 +479,7 @@ class Wizard extends LDAPUtility { } /** - * @brief tries to determine a base dn from User DN or LDAP Host + * tries to determine a base dn from User DN or LDAP Host * @return WizardResult|false WizardResult on success, false otherwise */ public function guessBaseDN() { @@ -519,7 +519,7 @@ class Wizard extends LDAPUtility { } /** - * @brief sets the found value for the configuration key in the WizardResult + * sets the found value for the configuration key in the WizardResult * as well as in the Configuration instance * @param string $key the configuration key * @param string $value the (detected) value @@ -531,7 +531,7 @@ class Wizard extends LDAPUtility { } /** - * @brief Checks, whether a port was entered in the Host configuration + * Checks, whether a port was entered in the Host configuration * field. In this case the port will be stripped off, but also stored as * setting. */ @@ -549,7 +549,7 @@ class Wizard extends LDAPUtility { } /** - * @brief tries to detect the group member association attribute which is + * tries to detect the group member association attribute which is * one of 'uniqueMember', 'memberUid', 'member' * @return string|false, string with the attribute name, false on error * @throws \Exception @@ -591,7 +591,7 @@ class Wizard extends LDAPUtility { } /** - * @brief Checks whether for a given BaseDN results will be returned + * Checks whether for a given BaseDN results will be returned * @param string $base the BaseDN to test * @return bool true on success, false otherwise * @throws \Exception @@ -617,7 +617,7 @@ class Wizard extends LDAPUtility { } /** - * @brief Checks whether the server supports memberOf in LDAP Filter. + * Checks whether the server supports memberOf in LDAP Filter. * Requires that groups are determined, thus internally called from within * determineGroups() * @return bool true if it does, false otherwise @@ -658,7 +658,7 @@ class Wizard extends LDAPUtility { } /** - * @brief creates an LDAP Filter from given configuration + * creates an LDAP Filter from given configuration * @param integer $filterType int, for which use case the filter shall be created * can be any of self::LFILTER_USER_LIST, self::LFILTER_LOGIN or * self::LFILTER_GROUP_LIST @@ -877,7 +877,7 @@ class Wizard extends LDAPUtility { } /** - * @brief checks whether a valid combination of agent and password has been + * checks whether a valid combination of agent and password has been * provided (either two values or nothing for anonymous connect) * @return bool, true if everything is fine, false otherwise */ @@ -905,7 +905,7 @@ class Wizard extends LDAPUtility { } /** - * @brief does a cumulativeSearch on LDAP to get different values of a + * does a cumulativeSearch on LDAP to get different values of a * specified attribute * @param string[] $filters array, the filters that shall be used in the search * @param string $attr the attribute of which a list of values shall be returned @@ -981,7 +981,7 @@ class Wizard extends LDAPUtility { } /** - * @brief determines if and which $attr are available on the LDAP server + * determines if and which $attr are available on the LDAP server * @param string[] $objectclasses the objectclasses to use as search filter * @param string $attr the attribute to look for * @param string $dbkey the dbkey of the setting the feature is connected to @@ -1040,7 +1040,7 @@ class Wizard extends LDAPUtility { } /** - * @brief appends a list of values fr + * appends a list of values fr * @param resource $result the return value from ldap_get_attributes * @param string $attribute the attribute values to look for * @param array &$known new values will be appended here diff --git a/apps/user_ldap/tests/user_ldap.php b/apps/user_ldap/tests/user_ldap.php index ca8aeb12f87..2535c34bcf5 100644 --- a/apps/user_ldap/tests/user_ldap.php +++ b/apps/user_ldap/tests/user_ldap.php @@ -78,7 +78,7 @@ class Test_User_Ldap_Direct extends \PHPUnit_Framework_TestCase { } /** - * @brief Prepares the Access mock for checkPassword tests + * Prepares the Access mock for checkPassword tests * @param \OCA\user_ldap\lib\Access $access mock * @return void */ @@ -186,7 +186,7 @@ class Test_User_Ldap_Direct extends \PHPUnit_Framework_TestCase { } /** - * @brief Prepares the Access mock for getUsers tests + * Prepares the Access mock for getUsers tests * @param \OCA\user_ldap\lib\Access $access mock * @return void */ diff --git a/apps/user_ldap/user_ldap.php b/apps/user_ldap/user_ldap.php index 7e8c557f047..aece2ee9aa2 100644 --- a/apps/user_ldap/user_ldap.php +++ b/apps/user_ldap/user_ldap.php @@ -69,7 +69,7 @@ class USER_LDAP extends BackendUtility implements \OCP\UserInterface { } /** - * @brief reads jpegPhoto and set is as avatar if available + * reads jpegPhoto and set is as avatar if available * @param string $uid ownCloud user name * @param string $dn the user's LDAP DN * @return void @@ -117,7 +117,7 @@ class USER_LDAP extends BackendUtility implements \OCP\UserInterface { } /** - * @brief checks whether the user is allowed to change his avatar in ownCloud + * checks whether the user is allowed to change his avatar in ownCloud * @param string $uid the ownCloud user name * @return boolean either the user can or cannot */ @@ -135,7 +135,7 @@ class USER_LDAP extends BackendUtility implements \OCP\UserInterface { } /** - * @brief reads the image from LDAP that shall be used as Avatar + * reads the image from LDAP that shall be used as Avatar * @param string $uid the ownCloud user name * @param string $dn the user DN * @return string data (provided by LDAP) | false @@ -155,7 +155,7 @@ class USER_LDAP extends BackendUtility implements \OCP\UserInterface { } /** - * @brief Check if the password is correct + * Check if the password is correct * @param string $uid The username * @param string $password The password * @return boolean @@ -199,7 +199,7 @@ class USER_LDAP extends BackendUtility implements \OCP\UserInterface { } /** - * @brief Get a list of all users + * Get a list of all users * @return string[] with all uids * * Get a list of all users. @@ -240,7 +240,7 @@ class USER_LDAP extends BackendUtility implements \OCP\UserInterface { } /** - * @brief check if a user exists + * check if a user exists * @param string $uid the username * @return boolean */ @@ -271,7 +271,7 @@ class USER_LDAP extends BackendUtility implements \OCP\UserInterface { } /** - * @brief delete a user + * delete a user * @param string $uid The username of the user to delete * @return bool * @@ -282,7 +282,7 @@ class USER_LDAP extends BackendUtility implements \OCP\UserInterface { } /** - * @brief get the user's home directory + * get the user's home directory * @param string $uid the username * @return boolean */ @@ -325,7 +325,7 @@ class USER_LDAP extends BackendUtility implements \OCP\UserInterface { } /** - * @brief get display name of the user + * get display name of the user * @param string $uid user ID of the user * @return string display name */ @@ -352,7 +352,7 @@ class USER_LDAP extends BackendUtility implements \OCP\UserInterface { } /** - * @brief Get a list of all display names + * Get a list of all display names * @return array with all displayNames (value) and the correspondig uids (key) * * Get a list of all display names and user ids. @@ -373,7 +373,7 @@ class USER_LDAP extends BackendUtility implements \OCP\UserInterface { } /** - * @brief Check if backend implements actions + * Check if backend implements actions * @param int $actions bitwise-or'ed actions * @return boolean * diff --git a/apps/user_ldap/user_proxy.php b/apps/user_ldap/user_proxy.php index 77d08ada703..fa4d6939303 100644 --- a/apps/user_ldap/user_proxy.php +++ b/apps/user_ldap/user_proxy.php @@ -30,7 +30,7 @@ class User_Proxy extends lib\Proxy implements \OCP\UserInterface { private $refBackend = null; /** - * @brief Constructor + * Constructor * @param array $serverConfigPrefixes array containing the config Prefixes */ public function __construct($serverConfigPrefixes, ILDAPWrapper $ldap) { @@ -45,7 +45,7 @@ class User_Proxy extends lib\Proxy implements \OCP\UserInterface { } /** - * @brief Tries the backends one after the other until a positive result is returned from the specified method + * Tries the backends one after the other until a positive result is returned from the specified method * @param string $uid the uid connected to the request * @param string $method the method of the user backend that shall be called * @param array $parameters an array of parameters to be passed @@ -68,7 +68,7 @@ class User_Proxy extends lib\Proxy implements \OCP\UserInterface { } /** - * @brief Asks the backend connected to the server that supposely takes care of the uid from the request. + * Asks the backend connected to the server that supposely takes care of the uid from the request. * @param string $uid the uid connected to the request * @param string $method the method of the user backend that shall be called * @param array $parameters an array of parameters to be passed @@ -105,7 +105,7 @@ class User_Proxy extends lib\Proxy implements \OCP\UserInterface { } /** - * @brief Check if backend implements actions + * Check if backend implements actions * @param int $actions bitwise-or'ed actions * @return boolean * @@ -118,7 +118,7 @@ class User_Proxy extends lib\Proxy implements \OCP\UserInterface { } /** - * @brief Get a list of all users + * Get a list of all users * @return string[] with all uids * * Get a list of all users. @@ -136,7 +136,7 @@ class User_Proxy extends lib\Proxy implements \OCP\UserInterface { } /** - * @brief check if a user exists + * check if a user exists * @param string $uid the username * @return boolean */ @@ -145,7 +145,7 @@ class User_Proxy extends lib\Proxy implements \OCP\UserInterface { } /** - * @brief Check if the password is correct + * Check if the password is correct * @param string $uid The username * @param string $password The password * @return bool @@ -157,7 +157,7 @@ class User_Proxy extends lib\Proxy implements \OCP\UserInterface { } /** - * @brief get the user's home directory + * get the user's home directory * @param string $uid the username * @return boolean */ @@ -166,7 +166,7 @@ class User_Proxy extends lib\Proxy implements \OCP\UserInterface { } /** - * @brief get display name of the user + * get display name of the user * @param string $uid user ID of the user * @return string display name */ @@ -175,7 +175,7 @@ class User_Proxy extends lib\Proxy implements \OCP\UserInterface { } /** - * @brief checks whether the user is allowed to change his avatar in ownCloud + * checks whether the user is allowed to change his avatar in ownCloud * @param string $uid the ownCloud user name * @return boolean either the user can or cannot */ @@ -184,7 +184,7 @@ class User_Proxy extends lib\Proxy implements \OCP\UserInterface { } /** - * @brief Get a list of all display names + * Get a list of all display names * @return array with all displayNames (value) and the corresponding uids (key) * * Get a list of all display names and user ids. @@ -202,7 +202,7 @@ class User_Proxy extends lib\Proxy implements \OCP\UserInterface { } /** - * @brief delete a user + * delete a user * @param string $uid The username of the user to delete * @return bool * @@ -220,7 +220,7 @@ class User_Proxy extends lib\Proxy implements \OCP\UserInterface { } /** - * @brief Count the number of users + * Count the number of users * @return int|bool */ public function countUsers() { |