fix documentation stuff

1 files changed, 88 insertions, 114 deletions

diff --git a/lib/public/util.php b/lib/public/util.php
index ed0622b8d16..de6fa382307 100644
--- a/lib/public/util.php
+++ b/lib/public/util.php
@@ -42,7 +42,7 @@ class Util {
 	const FATAL=4;
 
 	/**
-	 * @brief get the current installed version of ownCloud
+	 * get the current installed version of ownCloud
 	 * @return array
 	 */
 	public static function getVersion() {
@@ -50,7 +50,7 @@ class Util {
 	}
 
 	/**
-	 * @brief send an email
+	 * send an email
 	 * @param string $toaddress
 	 * @param string $toname
 	 * @param string $subject
@@ -58,6 +58,10 @@ class Util {
 	 * @param string $fromaddress
 	 * @param string $fromname
 	 * @param bool $html
+	 * @param string $altbody
+	 * @param string $ccaddress
+	 * @param string $ccname
+	 * @param string $bcc
 	 */
 	public static function sendMail( $toaddress, $toname, $subject, $mailtext, $fromaddress, $fromname,
 		$html = 0, $altbody = '', $ccaddress = '', $ccname = '', $bcc = '') {
@@ -67,7 +71,7 @@ class Util {
 	}
 
 	/**
-	 * @brief write a message in the log
+	 * write a message in the log
 	 * @param string $app
 	 * @param string $message
 	 * @param int $level
@@ -78,8 +82,9 @@ class Util {
 	}
 
 	/**
-	 * @brief write exception into the log. Include the stack trace
+	 * write exception into the log. Include the stack trace
 	 * if DEBUG mode is enabled
+	 * @param string $app app name
 	 * @param Exception $ex exception to log
 	 */
 	public static function logException( $app, \Exception $ex ) {
@@ -111,8 +116,8 @@ class Util {
 	}
 
 	/**
-	 * @brief get l10n object
-	 * @param string $app
+	 * get l10n object
+	 * @param string $application
 	 * @return OC_L10N
 	 */
 	public static function getL10N( $application ) {
@@ -120,24 +125,25 @@ class Util {
 	}
 
 	/**
-	 * @brief add a css file
-	 * @param string $url
+	 * add a css file
+	 * @param string $application
+	 * @param string $file
 	 */
 	public static function addStyle( $application, $file = null ) {
 		\OC_Util::addStyle( $application, $file );
 	}
 
 	/**
-	 * @brief add a javascript file
+	 * add a javascript file
 	 * @param string $application
-	 * @param string  $file
+	 * @param string $file
 	 */
 	public static function addScript( $application, $file = null ) {
 		\OC_Util::addScript( $application, $file );
 	}
 
 	/**
-	 * @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
@@ -147,7 +153,7 @@ class Util {
 	}
 
 	/**
-	 * @brief formats a timestamp in the "right" way
+	 * formats a timestamp in the "right" way
 	 * @param int $timestamp $timestamp
 	 * @param bool $dateOnly option to omit time from the result
 	 */
@@ -156,93 +162,78 @@ class Util {
 	}
 
 	/**
-	 * @brief check if some encrypted files are stored
+	 * check if some encrypted files are stored
 	 * @return bool
 	 */
 	public static function encryptedFiles() {
 		return \OC_Util::encryptedFiles();
 	}
-	
+
 	/**
-	 * @brief Creates an absolute url
+	 * Creates an absolute url to the given app and file.
 	 * @param string $app app
 	 * @param string $file file
 	 * @param array $args array with param=>value, will be appended to the returned url
 	 * 	The value of $args will be urlencoded
-	 * @returns string the url
-	 *
-	 * Returns a absolute url to the given app and file.
+	 * @return string the url
 	 */
 	public static function linkToAbsolute( $app, $file, $args = array() ) {
 		return(\OC_Helper::linkToAbsolute( $app, $file, $args ));
 	}
 
 	/**
-	 * @brief Creates an absolute url for remote use
+	 * Creates an absolute url for remote use.
 	 * @param string $service id
-	 * @returns string the url
-	 *
-	 * Returns a absolute url to the given app and file.
+	 * @return string the url
 	 */
 	public static function linkToRemote( $service ) {
 		return(\OC_Helper::linkToRemote( $service ));
 	}
 
 	/**
-	 * @brief Creates an absolute url for public use
+	 * Creates an absolute url for public use
 	 * @param string $service id
-	 * @returns string the url
-	 *
-	 * Returns a absolute url to the given app and file.
+	 * @return string the url
 	 */
 	public static function linkToPublic($service) {
 		return \OC_Helper::linkToPublic($service);
 	}
 
 	/**
-	 * @brief Creates an url using a defined route
+	 * Creates an url using a defined route
 	 * @param $route
 	 * @param array $parameters
 	 * @return
 	 * @internal param array $args with param=>value, will be appended to the returned url
-	 * @returns the url
-	 *
-	 * Returns a url to the given app and file.
+	 * @return the url
 	 */
 	public static function linkToRoute( $route, $parameters = array() ) {
 		return \OC_Helper::linkToRoute($route, $parameters);
 	}
 
 	/**
-	* @brief Creates an url
+	* Creates an url to the given app and file
 	* @param string $app app
 	* @param string $file file
 	* @param array $args array with param=>value, will be appended to the returned url
 	* 	The value of $args will be urlencoded
-	* @returns string the url
-	*
-	* Returns a url to the given app and file.
+	* @return string the url
 	*/
 	public static function linkTo( $app, $file, $args = array() ) {
 		return(\OC_Helper::linkTo( $app, $file, $args ));
 	}
 
 	/**
-	 * @brief Returns the server host
-	 * @returns string the server host
-	 *
-	 * Returns the server host, even if the website uses one or more
-	 * reverse proxies
+	 * Returns the server host, even if the website uses one or more reverse proxy
+	 * @return string the server host
 	 */
 	public static function getServerHost() {
 		return(\OC_Request::serverHost());
 	}
 
 	/**
-	 * @brief returns the server hostname
-	 * @returns string the server hostname
-	 *
 	 * Returns the server host name without an eventual port number
+	 * @return string the server hostname
 	 */
 	public static function getServerHostName() {
 		$host_name = self::getServerHost();
@@ -255,9 +246,9 @@ class Util {
 	}
 
 	/**
-	 * @brief Returns the default email address
+	 * Returns the default email address
 	 * @param string $user_part the user part of the address
-	 * @returns string the default email address
+	 * @return string the default email address
 	 *
 	 * Assembles a default email address (using the server hostname
 	 * and the given user part, and returns it
@@ -279,66 +270,54 @@ class Util {
 	}
 
 	/**
-	 * @brief Returns the server protocol
-	 * @returns string the server protocol
-	 *
 	 * Returns the server protocol. It respects reverse proxy servers and load balancers
+	 * @return string the server protocol
 	 */
 	public static function getServerProtocol() {
 		return(\OC_Request::serverProtocol());
 	}
 
 	/**
-	 * @brief Returns the request uri
-	 * @returns the request uri
+	 * Returns the request uri, even if the website uses one or more reverse proxies
 	 *
-	 * Returns the request uri, even if the website uses one or more
-	 * reverse proxies
+	 * @return the request uri
 	 */
 	public static function getRequestUri() {
 		return(\OC_Request::requestUri());
 	}
 
 	/**
-	 * @brief Returns the script name
-	 * @returns the script name
+	 * Returns the script name, even if the website uses one or more reverse proxies
 	 *
-	 * Returns the script name, even if the website uses one or more
-	 * reverse proxies
+	 * @return the script name
 	 */
 	public static function getScriptName() {
 		return(\OC_Request::scriptName());
 	}
 
 	/**
-	 * @brief Creates path to an image
+	 * Creates path to an image
 	 * @param string $app app
 	 * @param string $image image name
-	 * @returns string the url
-	 *
-	 * Returns the path to the image.
+	 * @return string the url
 	 */
 	public static function imagePath( $app, $image ) {
 		return(\OC_Helper::imagePath( $app, $image ));
 	}
 
 	/**
-	 * @brief Make a human file size
+	 * Make a human file size (2048 to 2 kB)
 	 * @param int $bytes file size in bytes
-	 * @returns string a human readable file size
-	 *
-	 * Makes 2048 to 2 kB.
+	 * @return string a human readable file size
 	 */
 	public static function humanFileSize( $bytes ) {
 		return(\OC_Helper::humanFileSize( $bytes ));
 	}
 
 	/**
-	 * @brief Make a computer file size
+	 * Make a computer file size (2 kB to 2048)
 	 * @param string $str file size in a fancy format
-	 * @returns int a file size in bytes
-	 *
-	 * Makes 2kB to 2048.
+	 * @return int a file size in bytes
 	 *
 	 * Inspired by: http://www.php.net/manual/en/function.filesize.php#92418
 	 */
@@ -347,12 +326,12 @@ class Util {
 	}
 
 	/**
-	 * @brief connects a function to a hook
+	 * connects a function to a hook
 	 * @param string $signalclass class name of emitter
 	 * @param string $signalname name of signal
 	 * @param string $slotclass class name of slot
 	 * @param string $slotname name of slot
-	 * @returns bool
+	 * @return bool
 	 *
 	 * This function makes it very easy to connect to use hooks.
 	 *
@@ -363,13 +342,11 @@ class Util {
 	}
 
 	/**
-	 * @brief emitts a signal
+	 * Emits a signal. To get data from the slot use references!
 	 * @param string $signalclass class name of emitter
 	 * @param string $signalname name of signal
 	 * @param string $params defautl: array() array with additional data
-	 * @returns bool true if slots exists or false if not
-	 *
-	 * Emits a signal. To get data from the slot use references!
+	 * @return bool true if slots exists or false if not
 	 *
 	 * TODO: write example
 	 */
@@ -394,7 +371,7 @@ class Util {
 	}
 
 	/**
-	 * @brief Used to sanitize HTML
+	 * Used 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.
@@ -405,78 +382,75 @@ class Util {
 	public static function sanitizeHTML( $value ) {
 		return(\OC_Util::sanitizeHTML($value));
 	}
-		
+
 	/**
-	 * @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:
-	 * Character '/' is preserved as is. 
+	 * Character '/' is preserved as is.
 	 *
 	 * @param string $component part of URI to encode
-	 * @return string 
+	 * @return string
 	 */
 	public static function encodePath($component) {
 		return(\OC_Util::encodePath($component));
 	}
 
 	/**
-	* @brief Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
-	*
-	* @param array $input The array to work on
-	* @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
-	* @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
-	* @return array
-	*
-	*
-	*/
+	 * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
+	 *
+	 * @param array $input The array to work on
+	 * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
+	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
+	 * @return array
+	 */
 	public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {
 		return(\OC_Helper::mb_array_change_key_case($input, $case, $encoding));
 	}
 
 	/**
-	* @brief replaces a copy of string delimited by the start and (optionally) length parameters with the string given in replacement.
-	*
-	* @param string $input The input string. .Opposite to the PHP build-in function does not accept an array.
-	* @param string $replacement The replacement string.
-	* @param int $start If start is positive, the replacing will begin at the start'th offset into string. If start is negative, the replacing will begin at the start'th character from the end of string.
-	* @param int $length Length of the part to be replaced
-	* @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
-	* @return string
-	*
-	*/
+	 * replaces a copy of string delimited by the start and (optionally) length parameters with the string given in replacement.
+	 *
+	 * @param string $string The input string. Opposite to the PHP build-in function does not accept an array.
+	 * @param string $replacement The replacement string.
+	 * @param int $start If start is positive, the replacing will begin at the start'th offset into string. If start is negative, the replacing will begin at the start'th character from the end of string.
+	 * @param int $length Length of the part to be replaced
+	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
+	 * @return string
+	 */
 	public static function mb_substr_replace($string, $replacement, $start, $length = null, $encoding = 'UTF-8') {
 		return(\OC_Helper::mb_substr_replace($string, $replacement, $start, $length, $encoding));
 	}
 
 	/**
-	* @brief Replace all occurrences of the search string with the replacement string
-	*
-	* @param string $search The value being searched for, otherwise known as the needle. String.
-	* @param string $replace The replacement string.
-	* @param string $subject The string or array being searched and replaced on, otherwise known as the haystack.
-	* @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
-	* @param int $count If passed, this will be set to the number of replacements performed.
-	* @return string
-	*
-	*/
+	 * Replace all occurrences of the search string with the replacement string
+	 *
+	 * @param string $search The value being searched for, otherwise known as the needle. String.
+	 * @param string $replace The replacement string.
+	 * @param string $subject The string or array being searched and replaced on, otherwise known as the haystack.
+	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
+	 * @param int $count If passed, this will be set to the number of replacements performed.
+	 * @return string
+	 */
 	public static function mb_str_replace($search, $replace, $subject, $encoding = 'UTF-8', &$count = null) {
 		return(\OC_Helper::mb_str_replace($search, $replace, $subject, $encoding, $count));
 	}
 
 	/**
-	* @brief performs a search in a nested array
-	* @param array $haystack the array to be searched
-	* @param string $needle the search string
-	* @param int $index optional, only search this key name
-	* @return mixed the key of the matching field, otherwise false
-	*/
+	 * performs a search in a nested array
+	 *
+	 * @param array $haystack the array to be searched
+	 * @param string $needle the search string
+	 * @param int $index optional, only search this key name
+	 * @return mixed the key of the matching field, otherwise false
+	 */
 	public static function recursiveArraySearch($haystack, $needle, $index = null) {
 		return(\OC_Helper::recursiveArraySearch($haystack, $needle, $index));
 	}
 
 	/**
-	 * @brief calculates the maximum upload size respecting system settings, free space and user quota
+	 * calculates the maximum upload size respecting system settings, free space and user quota
 	 *
 	 * @param $dir the current folder where the user currently operates
 	 * @return number of bytes representing