summaryrefslogtreecommitdiffstats
path: root/lib/private/helper.php
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/private/helper.php
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/private/helper.php')
-rw-r--r--lib/private/helper.php46
1 files changed, 23 insertions, 23 deletions
diff --git a/lib/private/helper.php b/lib/private/helper.php
index 12d82f6fb45..4ad792dfb13 100644
--- a/lib/private/helper.php
+++ b/lib/private/helper.php
@@ -31,7 +31,7 @@ class OC_Helper {
private static $templateManager;
/**
- * @brief Creates an url using a defined route
+ * Creates an url using a defined route
* @param string $route
* @param array $parameters
* @return
@@ -45,7 +45,7 @@ class OC_Helper {
}
/**
- * @brief Creates an url
+ * Creates an url
* @param string $app app
* @param string $file file
* @param array $args array with param=>value, will be appended to the returned url
@@ -68,7 +68,7 @@ class OC_Helper {
}
/**
- * @brief Creates an absolute url
+ * Creates an absolute url
* @param string $app app
* @param string $file file
* @param array $args array with param=>value, will be appended to the returned url
@@ -84,7 +84,7 @@ class OC_Helper {
}
/**
- * @brief Makes an $url absolute
+ * Makes an $url absolute
* @param string $url the url
* @return string the absolute url
*
@@ -95,7 +95,7 @@ class OC_Helper {
}
/**
- * @brief Creates an url for remote use
+ * Creates an url for remote use
* @param string $service id
* @return string the url
*
@@ -106,7 +106,7 @@ class OC_Helper {
}
/**
- * @brief Creates an absolute url for remote use
+ * Creates an absolute url for remote use
* @param string $service id
* @param bool $add_slash
* @return string the url
@@ -121,7 +121,7 @@ class OC_Helper {
}
/**
- * @brief Creates an absolute url for public use
+ * Creates an absolute url for public use
* @param string $service id
* @param bool $add_slash
* @return string the url
@@ -138,7 +138,7 @@ class OC_Helper {
}
/**
- * @brief Creates path to an image
+ * Creates path to an image
* @param string $app app
* @param string $image image name
* @return string the url
@@ -150,7 +150,7 @@ class OC_Helper {
}
/**
- * @brief get path to icon of file type
+ * get path to icon of file type
* @param string $mimetype mimetype
* @return string the url
*
@@ -264,7 +264,7 @@ class OC_Helper {
}
/**
- * @brief get path to preview of file
+ * get path to preview of file
* @param string $path path
* @return string the url
*
@@ -279,7 +279,7 @@ class OC_Helper {
}
/**
- * @brief Make a human file size
+ * Make a human file size
* @param int $bytes file size in bytes
* @return string a human readable file size
*
@@ -314,7 +314,7 @@ class OC_Helper {
}
/**
- * @brief Make a php file size
+ * Make a php file size
* @param int $bytes file size in bytes
* @return string a php parseable file size
*
@@ -340,7 +340,7 @@ class OC_Helper {
}
/**
- * @brief Make a computer file size
+ * Make a computer file size
* @param string $str file size in human readable format
* @return int a file size in bytes
*
@@ -377,7 +377,7 @@ class OC_Helper {
}
/**
- * @brief Recursive copying of folders
+ * Recursive copying of folders
* @param string $src source folder
* @param string $dest target folder
*
@@ -399,7 +399,7 @@ class OC_Helper {
}
/**
- * @brief Recursive deletion of folders
+ * Recursive deletion of folders
* @param string $dir path to the folder
* @return bool
*/
@@ -485,7 +485,7 @@ class OC_Helper {
}
/**
- * @brief Checks $_REQUEST contains a var for the $s key. If so, returns the html-escaped value of this var; otherwise returns the default value provided by $d.
+ * Checks $_REQUEST contains a var for the $s key. If so, returns the html-escaped value of this var; otherwise returns the default value provided by $d.
* @param string $s name of the var to escape, if set.
* @param string $d default value.
* @return string the print-safe value.
@@ -726,7 +726,7 @@ class OC_Helper {
}
/**
- * @brief Checks if $sub is a subdirectory of $parent
+ * Checks if $sub is a subdirectory of $parent
*
* @param string $sub
* @param string $parent
@@ -752,7 +752,7 @@ class OC_Helper {
}
/**
- * @brief Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
+ * 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)
@@ -773,7 +773,7 @@ class OC_Helper {
}
/**
- * @brief replaces a copy of string delimited by the start and (optionally) length parameters with the string given in replacement.
+ * replaces a copy of string delimited by the start and (optionally) length parameters with the string given in replacement.
*
* @param string $string
* @param string $replacement The replacement string.
@@ -794,7 +794,7 @@ class OC_Helper {
}
/**
- * @brief Replace all occurrences of the search string with the replacement 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.
* @param string $replace The replacement
@@ -816,7 +816,7 @@ class OC_Helper {
}
/**
- * @brief performs a search in a nested array
+ * performs a search in a nested array
* @param array $haystack the array to be searched
* @param string $needle the search string
* @param string $index optional, only search this key name
@@ -858,7 +858,7 @@ class OC_Helper {
}
/**
- * @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 string $dir the current folder where the user currently operates
* @param int $freeSpace the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly
@@ -873,7 +873,7 @@ class OC_Helper {
/**
* Calculate free space left within user quota
- *
+ *
* @param string $dir the current folder where the user currently operates
* @return int number of bytes representing
*/