diff options
author | Jörn Friedrich Dreyer <jfd@butonic.de> | 2014-02-06 16:30:58 +0100 |
---|---|---|
committer | Jörn Friedrich Dreyer <jfd@butonic.de> | 2014-02-06 17:02:21 +0100 |
commit | 2a6a9a8cefcf68f48d95e124db0c1b7edc9fe356 (patch) | |
tree | 66d682a22c3d12d1838822fc52cdd48fa765f5df /lib/public/template.php | |
parent | 0d94da7e9ef9550c8ae0244b203ca84e5ee007b0 (diff) | |
download | nextcloud-server-2a6a9a8cefcf68f48d95e124db0c1b7edc9fe356.tar.gz nextcloud-server-2a6a9a8cefcf68f48d95e124db0c1b7edc9fe356.zip |
polish documentation based on scrutinizer patches
Diffstat (limited to 'lib/public/template.php')
-rw-r--r-- | lib/public/template.php | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/lib/public/template.php b/lib/public/template.php index 320b7c6393f..0d86acbd060 100644 --- a/lib/public/template.php +++ b/lib/public/template.php @@ -35,7 +35,7 @@ namespace OCP; * Make OC_Helper::imagePath available as a simple function * @param string app * @param string image - * @return link to the image + * @return string to the image * * @see OC_Helper::imagePath */ @@ -47,7 +47,7 @@ function image_path( $app, $image ) { /** * Make OC_Helper::mimetypeIcon available as a simple function * @param string mimetype - * @return path to the image of this file type. + * @return string to the image of this file type. */ function mimetype_icon( $mimetype ) { return(\mimetype_icon( $mimetype )); @@ -56,7 +56,7 @@ function mimetype_icon( $mimetype ) { /** * Make preview_icon available as a simple function * @param string path of file - * @return path to the preview of the image + * @return string to the preview of the image */ function preview_icon( $path ) { return(\preview_icon( $path )); @@ -67,6 +67,7 @@ function preview_icon( $path ) { * Returns the path to the preview of the image. * @param string path of file * @param string token + * @param string $path * @return link to the preview */ function publicPreview_icon ( $path, $token ) { @@ -77,7 +78,7 @@ function publicPreview_icon ( $path, $token ) { * Make OC_Helper::humanFileSize available as a simple function * Example: 2048 to 2 kB. * @param int size in bytes - * @return size as string + * @return string as string */ function human_file_size( $bytes ) { return(\human_file_size( $bytes )); @@ -88,7 +89,7 @@ function human_file_size( $bytes ) { * Return the relative date in relation to today. Returns something like "last hour" or "two month ago" * @param int unix timestamp * @param boolean date only - * @return human readable interpretation of the timestamp + * @return OC_L10N_String readable interpretation of the timestamp */ function relative_modified_date( $timestamp, $dateOnly = false ) { return(\relative_modified_date($timestamp, null, $dateOnly)); @@ -99,7 +100,7 @@ function relative_modified_date( $timestamp, $dateOnly = false ) { * Return a human readable outout for a file size. * @deprecated human_file_size() instead * @param integer size of a file in byte - * @return human readable interpretation of a file size + * @return string readable interpretation of a file size */ function simple_file_size($bytes) { return(\human_file_size($bytes)); @@ -111,7 +112,7 @@ function simple_file_size($bytes) { * @param $options the options * @param $selected which one is selected? * @param array the parameters - * @return html options + * @return string options */ function html_select_options($options, $selected, $params=array()) { return(\html_select_options($options, $selected, $params)); |