@returns -> @return

This commit is contained in:
Thomas Müller 2014-05-13 12:36:01 +02:00 committed by Robin McCorkell
parent 55fc693750
commit 58857b8df5
3 changed files with 12 additions and 12 deletions

View File

@ -254,7 +254,7 @@ class Crypt {
* @brief Concatenate encrypted data with its IV and padding
* @param string $content content to be concatenated
* @param string $iv IV to be concatenated
* @returns string concatenated content
* @return string concatenated content
*/
private static function concatIv($content, $iv) {
@ -267,7 +267,7 @@ class Crypt {
/**
* @brief Split concatenated data and IV into respective parts
* @param string $catFile concatenated data to be split
* @returns array keys: encrypted, iv
* @return array keys: encrypted, iv
*/
private static function splitIv($catFile) {
@ -330,7 +330,7 @@ class Crypt {
* @internal param string $source
* @internal param string $target
* @internal param string $key the decryption key
* @returns string decrypted content
* @return string decrypted content
*
* This function decrypts a file
*/
@ -362,7 +362,7 @@ class Crypt {
* @brief Decrypt private key and check if the result is a valid keyfile
* @param string $encryptedKey encrypted keyfile
* @param string $passphrase to decrypt keyfile
* @returns encrypted private key or false
* @return encrypted private key or false
*
* This function decrypts a file
*/
@ -389,7 +389,7 @@ class Crypt {
* @brief 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
* @returns array keys: keys (array, key = userId), data
* @return array keys: keys (array, key = userId), data
* @note symmetricDecryptFileContent() can decrypt files created using this method
*/
public static function multiKeyEncrypt($plainContent, array $publicKeys) {
@ -440,7 +440,7 @@ class Crypt {
* @param $privateKey
* @return false|string
* @internal param string $plainContent content to be encrypted
* @returns string $plainContent decrypted string
* @return string $plainContent decrypted string
* @note symmetricDecryptFileContent() can be used to decrypt files created using this method
*
* This function decrypts a file
@ -498,7 +498,7 @@ class Crypt {
/**
* @brief Generate a pseudo random 256-bit ASCII key, used as file key
* @returns $key Generated key
* @return $key Generated key
*/
public static function generateKey() {

View File

@ -145,7 +145,7 @@ class Session {
/**
* @brief Gets status if we already tried to initialize the encryption app
* @returns init status INIT_SUCCESSFUL, INIT_EXECUTED, NOT_INOITIALIZED
* @return init status INIT_SUCCESSFUL, INIT_EXECUTED, NOT_INOITIALIZED
*
* @note this doesn not indicate of the init was successful, we just remeber the try!
*/
@ -159,7 +159,7 @@ class Session {
/**
* @brief Gets user or public share private key from session
* @returns string $privateKey The user's plaintext private key
* @return string $privateKey The user's plaintext private key
*
*/
public function getPrivateKey() {
@ -190,7 +190,7 @@ class Session {
/**
* @brief Gets public share private key from session
* @returns string $privateKey
* @return string $privateKey
*
*/
public function getPublicSharePrivateKey() {
@ -217,7 +217,7 @@ class Session {
/**
* @brief Gets user legacy key from session
* @returns string $legacyKey The user's plaintext legacy key
* @return string $legacyKey The user's plaintext legacy key
*
*/
public function getLegacyKey() {

View File

@ -265,7 +265,7 @@ class Storage {
* @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
* @returns array versions newest version first
* @return array versions newest version first
*/
public static function getVersions($uid, $filename, $userFullPath = '') {
$versions = array();