From dc36d3095314db8d88c2ec1005d99af595c119da Mon Sep 17 00:00:00 2001
From: Morris Jobke <hey@morrisjobke.de>
Date: Mon, 19 May 2014 17:50:53 +0200
Subject: Remove all occurences of @brief and @returns from PHPDoc

* test case added to avoid adding them later
---
 lib/private/util.php | 70 ++++++++++++++++++++++++++--------------------------
 1 file changed, 35 insertions(+), 35 deletions(-)

(limited to 'lib/private/util.php')

diff --git a/lib/private/util.php b/lib/private/util.php
index 107dc6b9a9f..c018721afe3 100755
--- a/lib/private/util.php
+++ b/lib/private/util.php
@@ -13,7 +13,7 @@ class OC_Util {
 	private static $fsSetup=false;
 
 	/**
-	 * @brief Can be set up
+	 * Can be set up
 	 * @param string $user
 	 * @return boolean
 	 * @description configure the initial filesystem based on the configuration
@@ -87,7 +87,7 @@ class OC_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() {
@@ -115,7 +115,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief copies the user skeleton files into the fresh user home files
+	 * copies the user skeleton files into the fresh user home files
 	 * @param string $userDirectory
 	 */
 	public static function copySkeleton($userDirectory) {
@@ -123,7 +123,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief copies a directory recursively
+	 * copies a directory recursively
 	 * @param string $source
 	 * @param string $target
 	 * @return void
@@ -153,7 +153,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief get the current installed version of ownCloud
+	 * get the current installed version of ownCloud
 	 * @return array
 	 */
 	public static function getVersion() {
@@ -162,7 +162,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief get the current installed version string of ownCloud
+	 * get the current installed version string of ownCloud
 	 * @return string
 	 */
 	public static function getVersionString() {
@@ -223,7 +223,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief add a javascript file
+	 * add a javascript file
 	 *
 	 * @param string $application
 	 * @param string|null $file filename
@@ -242,7 +242,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief add a css file
+	 * add a css file
 	 *
 	 * @param string $application
 	 * @param string|null $file filename
@@ -261,7 +261,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief Add a custom element to the header
+	 * Add a custom element to the header
 	 * @param string $tag tag name of the element
 	 * @param array $attributes array of attributes for the element
 	 * @param string $text the text content for the element
@@ -276,7 +276,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief formats a timestamp in the "right" way
+	 * formats a timestamp in the "right" way
 	 *
 	 * @param int $timestamp
 	 * @param bool $dateOnly option to omit time from the result
@@ -296,7 +296,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief check if the current server configuration is suitable for ownCloud
+	 * check if the current server configuration is suitable for ownCloud
 	 * @return array arrays with error messages and hints
 	 */
 	public static function checkServer() {
@@ -540,7 +540,7 @@ class OC_Util {
 
 
 	/**
-	 * @brief check if there are still some encrypted files stored
+	 * check if there are still some encrypted files stored
 	 * @return boolean
 	 */
 	public static function encryptedFiles() {
@@ -561,7 +561,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief check if a backup from the encryption keys exists
+	 * check if a backup from the encryption keys exists
 	 * @return boolean
 	 */
 	public static function backupKeysExists() {
@@ -582,7 +582,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief Check for correct file permissions of data directory
+	 * Check for correct file permissions of data directory
 	 * @param string $dataDirectory
 	 * @return array arrays with error messages and hints
 	 */
@@ -655,7 +655,7 @@ class OC_Util {
 
 
 	/**
-	 * @brief Check if the app is enabled, redirects to home if not
+	 * Check if the app is enabled, redirects to home if not
 	 * @param string $app
 	 * @return void
 	 */
@@ -682,7 +682,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief Check if the user is a admin, redirects to home if not
+	 * Check if the user is a admin, redirects to home if not
 	 * @return void
 	 */
 	public static function checkAdminUser() {
@@ -715,7 +715,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief Check if the user is a subadmin, redirects to home if not
+	 * Check if the user is a subadmin, redirects to home if not
 	 * @return null|boolean $groups where the current user is subadmin
 	 */
 	public static function checkSubAdminUser() {
@@ -728,7 +728,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief Redirect to the user default page
+	 * Redirect to the user default page
 	 * @return void
 	 */
 	public static function redirectToDefaultPage() {
@@ -752,7 +752,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief get an id unique for this instance
+	 * get an id unique for this instance
 	 * @return string
 	 */
 	public static function getInstanceId() {
@@ -766,7 +766,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief Static lifespan (in seconds) when a request token expires.
+	 * Static lifespan (in seconds) when a request token expires.
 	 * @see OC_Util::callRegister()
 	 * @see OC_Util::isCallRegistered()
 	 * @description
@@ -777,7 +777,7 @@ class OC_Util {
 	public static $callLifespan = 3600; // 3600 secs = 1 hour
 
 	/**
-	 * @brief Register an get/post call. Important to prevent CSRF attacks.
+	 * Register an get/post call. Important to prevent CSRF attacks.
 	 * @todo Write howto: CSRF protection guide
 	 * @return string Generated token.
 	 * @description
@@ -802,7 +802,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief Check an ajax get/post call if the request token is valid.
+	 * Check an ajax get/post call if the request token is valid.
 	 * @return boolean False if request token is not set or is invalid.
 	 * @see OC_Util::$callLifespan
 	 * @see OC_Util::callRegister()
@@ -812,7 +812,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief Check an ajax get/post call if the request token is valid. Exit if not.
+	 * Check an ajax get/post call if the request token is valid. Exit if not.
 	 * @todo Write howto
 	 * @return void
 	 */
@@ -823,7 +823,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief Public function to sanitize HTML
+	 * Public function to sanitize HTML
 	 *
 	 * This function is used to sanitize HTML and should be applied on any
 	 * string or array of strings before displaying it on a web page.
@@ -842,7 +842,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief Public function to encode url parameters
+	 * Public function to encode url parameters
 	 *
 	 * This function is used to encode path to file before output.
 	 * Encoding is done according to RFC 3986 with one exception:
@@ -858,7 +858,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief Check if the .htaccess file is working
+	 * Check if the .htaccess file is working
 	 * @throws OC\HintException If the testfile can't get written.
 	 * @return bool
 	 * @description Check if the .htaccess file is working by creating a test
@@ -906,7 +906,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief test if webDAV is working properly
+	 * test if webDAV is working properly
 	 * @return bool
 	 * @description
 	 * The basic assumption is that if the server returns 401/Not Authenticated for an unauthenticated PROPFIND
@@ -970,7 +970,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief Check if the PHP module fileinfo is loaded.
+	 * Check if the PHP module fileinfo is loaded.
 	 * @return bool
 	 */
 	public static function fileInfoLoaded() {
@@ -978,7 +978,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief Check if a PHP version older then 5.3.8 is installed.
+	 * Check if a PHP version older then 5.3.8 is installed.
 	 * @return bool
 	 */
 	public static function isPHPoutdated() {
@@ -986,7 +986,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief Check if the ownCloud server can connect to the internet
+	 * Check if the ownCloud server can connect to the internet
 	 * @return bool
 	 */
 	public static function isInternetConnectionWorking() {
@@ -1018,7 +1018,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief Check if the connection to the internet is disabled on purpose
+	 * Check if the connection to the internet is disabled on purpose
 	 * @return string
 	 */
 	public static function isInternetConnectionEnabled(){
@@ -1026,7 +1026,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief clear all levels of output buffering
+	 * clear all levels of output buffering
 	 * @return void
 	 */
 	public static function obEnd(){
@@ -1037,7 +1037,7 @@ class OC_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
 	 * Please also update secureRNGAvailable if you change something here
@@ -1074,7 +1074,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief Checks if a secure random number generator is available
+	 * Checks if a secure random number generator is available
 	 * @return bool
 	 */
 	public static function secureRNGAvailable() {
@@ -1226,7 +1226,7 @@ class OC_Util {
 	}
 
 	/**
-	 * @brief Clear the opcode cache if one exists
+	 * Clear the opcode cache if one exists
 	 * This is necessary for writing to the config file
 	 * in case the opcode cache does not re-validate files
 	 * @return void
-- 
cgit v1.2.3