summaryrefslogtreecommitdiffstats
path: root/lib/public
diff options
context:
space:
mode:
authorMorris Jobke <hey@morrisjobke.de>2014-05-19 17:50:53 +0200
committerMorris Jobke <hey@morrisjobke.de>2014-05-19 17:50:53 +0200
commitdc36d3095314db8d88c2ec1005d99af595c119da (patch)
tree9de515019d7ebae43a545e5dc4eb522ef71dbe9c /lib/public
parent95741f3936501e3ad6aeb26f93eeb28f9decc273 (diff)
downloadnextcloud-server-dc36d3095314db8d88c2ec1005d99af595c119da.tar.gz
nextcloud-server-dc36d3095314db8d88c2ec1005d99af595c119da.zip
Remove all occurences of @brief and @returns from PHPDoc
* test case added to avoid adding them later
Diffstat (limited to 'lib/public')
-rw-r--r--lib/public/iappconfig.php14
-rw-r--r--lib/public/iavatar.php6
-rw-r--r--lib/public/iavatarmanager.php2
-rw-r--r--lib/public/il10n.php4
-rw-r--r--lib/public/util.php4
5 files changed, 15 insertions, 15 deletions
diff --git a/lib/public/iappconfig.php b/lib/public/iappconfig.php
index 16c0752f073..d43eb70ee04 100644
--- a/lib/public/iappconfig.php
+++ b/lib/public/iappconfig.php
@@ -13,7 +13,7 @@ namespace OCP;
*/
interface IAppConfig {
/**
- * @brief check if a key is set in the appconfig
+ * check if a key is set in the appconfig
* @param string $app
* @param string $key
* @return bool
@@ -21,7 +21,7 @@ interface IAppConfig {
public function hasKey($app, $key);
/**
- * @brief Gets the config value
+ * Gets the config value
* @param string $app app
* @param string $key key
* @param string $default = null, default value if the key does not exist
@@ -33,7 +33,7 @@ interface IAppConfig {
public function getValue($app, $key, $default = null);
/**
- * @brief Deletes a key
+ * Deletes a key
* @param string $app app
* @param string $key key
* @return bool
@@ -43,7 +43,7 @@ interface IAppConfig {
public function deleteKey($app, $key);
/**
- * @brief Get the available keys for an app
+ * Get the available keys for an app
* @param string $app the app we are looking for
* @return array an array of key names
*
@@ -62,7 +62,7 @@ interface IAppConfig {
public function getValues($app, $key);
/**
- * @brief sets a value in the appconfig
+ * sets a value in the appconfig
* @param string $app app
* @param string $key key
* @param string $value value
@@ -73,7 +73,7 @@ interface IAppConfig {
public function setValue($app, $key, $value);
/**
- * @brief Get all apps using the config
+ * Get all apps using the config
* @return array an array of app ids
*
* This function returns a list of all apps that have at least one
@@ -82,7 +82,7 @@ interface IAppConfig {
public function getApps();
/**
- * @brief Remove app from appconfig
+ * Remove app from appconfig
* @param string $app app
* @return bool
*
diff --git a/lib/public/iavatar.php b/lib/public/iavatar.php
index fc7e8e79fed..1e80682c4f7 100644
--- a/lib/public/iavatar.php
+++ b/lib/public/iavatar.php
@@ -14,14 +14,14 @@ namespace OCP;
interface IAvatar {
/**
- * @brief get the users avatar
+ * get the users avatar
* @param int $size size in px of the avatar, avatars are square, defaults to 64
* @return boolean|\OC_Image containing the avatar or false if there's no image
*/
function get($size = 64);
/**
- * @brief sets the users avatar
+ * sets the users avatar
* @param Image $data mixed imagedata or path to set a new avatar
* @throws Exception if the provided file is not a jpg or png image
* @throws Exception if the provided image is not valid
@@ -31,7 +31,7 @@ interface IAvatar {
function set($data);
/**
- * @brief remove the users avatar
+ * remove the users avatar
* @return void
*/
function remove();
diff --git a/lib/public/iavatarmanager.php b/lib/public/iavatarmanager.php
index b09b456a0da..1fd89405983 100644
--- a/lib/public/iavatarmanager.php
+++ b/lib/public/iavatarmanager.php
@@ -14,7 +14,7 @@ namespace OCP;
interface IAvatarManager {
/**
- * @brief return a user specific instance of \OCP\IAvatar
+ * return a user specific instance of \OCP\IAvatar
* @see \OCP\IAvatar
* @param string $user the ownCloud user id
* @return \OCP\IAvatar
diff --git a/lib/public/il10n.php b/lib/public/il10n.php
index 7649a1ea538..2c95ddfec18 100644
--- a/lib/public/il10n.php
+++ b/lib/public/il10n.php
@@ -75,9 +75,9 @@ interface IL10N {
/**
- * @brief find the best language
+ * find the best language
* @param array|string $app details below
- * @returns string language
+ * @return string language
*
* If $app is an array, ownCloud assumes that these are the available
* languages. Otherwise ownCloud tries to find the files in the l10n
diff --git a/lib/public/util.php b/lib/public/util.php
index 929d86859a1..3166d4040d8 100644
--- a/lib/public/util.php
+++ b/lib/public/util.php
@@ -492,7 +492,7 @@ class Util {
}
/**
- * @brief Generates a cryptographic secure pseudo-random string
+ * Generates a cryptographic secure pseudo-random string
* @param int $length of the random string
* @return string
*/
@@ -501,7 +501,7 @@ class Util {
}
/**
- * @brief check if a password is required for each public link
+ * check if a password is required for each public link
* @return boolean
*/
public static function isPublicLinkPasswordRequired() {