diff options
author | Joas Schilling <nickvergessen@gmx.de> | 2014-02-08 11:47:55 +0100 |
---|---|---|
committer | Joas Schilling <nickvergessen@gmx.de> | 2014-02-08 11:47:55 +0100 |
commit | b330d07b51a983dc563a91244a3c83e691c9e97d (patch) | |
tree | 1142ec91b86d5da36e568ffcb4a25f5fd55b01fe /lib/public | |
parent | 81031984a6714feffc8b1a8e523988ab83f56515 (diff) | |
download | nextcloud-server-b330d07b51a983dc563a91244a3c83e691c9e97d.tar.gz nextcloud-server-b330d07b51a983dc563a91244a3c83e691c9e97d.zip |
Fix more documentation failes
Issue #7111
Diffstat (limited to 'lib/public')
-rw-r--r-- | lib/public/app.php | 8 | ||||
-rw-r--r-- | lib/public/db.php | 4 | ||||
-rw-r--r-- | lib/public/files.php | 17 | ||||
-rw-r--r-- | lib/public/share.php | 37 | ||||
-rw-r--r-- | lib/public/template.php | 13 | ||||
-rw-r--r-- | lib/public/user.php | 6 |
6 files changed, 38 insertions, 47 deletions
diff --git a/lib/public/app.php b/lib/public/app.php index 0cb22545362..96162299ec4 100644 --- a/lib/public/app.php +++ b/lib/public/app.php @@ -85,6 +85,7 @@ class App { * Register a Configuration Screen that should appear in the personal settings section. * @param $app string appid * @param $page string page to be included + * @return void */ public static function registerPersonal( $app, $page ) { \OC_App::registerPersonal( $app, $page ); @@ -94,6 +95,7 @@ class App { * Register a Configuration Screen that should appear in the Admin section. * @param string $app string appid * @param string $page string page to be included + * @return void */ public static function registerAdmin( $app, $page ) { \OC_App::registerAdmin( $app, $page ); @@ -111,7 +113,6 @@ class App { /** * checks whether or not an app is enabled - * @param string * @param string $app * @return boolean * @@ -123,7 +124,8 @@ class App { /** * Check if the app is enabled, redirects to home if not - * @param string + * @param string $app + * @return void */ public static function checkAppEnabled( $app ) { \OC_Util::checkAppEnabled( $app ); @@ -131,7 +133,7 @@ class App { /** * Get the last version of the app, either from appinfo/version or from appinfo/info.xml - * @param string + * @param string $app * @return string */ public static function getAppVersion( $app ) { diff --git a/lib/public/db.php b/lib/public/db.php index adb1f14cc4d..cb876b4d1f9 100644 --- a/lib/public/db.php +++ b/lib/public/db.php @@ -49,7 +49,7 @@ class DB { /** * Insert a row if a matching row doesn't exists. - * @param string $table string The table name (will replace *PREFIX*) to perform the replace on. + * @param string $table The optional table name (will replace *PREFIX*) and add sequence suffix * @param $input array * * The input array if in the form: @@ -70,7 +70,7 @@ class DB { /** * Gets last value of autoincrement - * @param string $table string The optional table name (will replace *PREFIX*) and add sequence suffix + * @param string $table The optional table name (will replace *PREFIX*) and add sequence suffix * @return string * * \Doctrine\DBAL\Connection lastInsertID() diff --git a/lib/public/files.php b/lib/public/files.php index bc8fe2b7997..75c52b88fc7 100644 --- a/lib/public/files.php +++ b/lib/public/files.php @@ -37,7 +37,7 @@ namespace OCP; class Files { /** * Recusive deletion of folders - * @param string path to the folder + * @param string $path to the folder * @return bool */ static function rmdirr( $dir ) { @@ -46,7 +46,7 @@ class Files { /** * Get the mimetype form a local file - * @param string path + * @param string $path * @return string * does NOT work for ownClouds filesystem, use OC_FileSystem::getMimeType instead */ @@ -56,7 +56,7 @@ class Files { /** * Search for files by mimetype - * @param string mimetype + * @param string $mimetype * @return array */ static public function searchByMime( $mimetype ) { @@ -65,8 +65,8 @@ class Files { /** * Copy the contents of one stream to another - * @param resource source - * @param resource target + * @param resource $source + * @param resource $target * @return int the number of bytes copied */ public static function streamCopy( $source, $target ) { @@ -76,7 +76,7 @@ class Files { /** * Create a temporary file with an unique filename - * @param string postfix + * @param string $postfix * @return string * * temporary files are automatically cleaned up after the script is finished @@ -97,8 +97,8 @@ class Files { /** * Adds a suffix to the name in case the file exists - * @param string path - * @param string filename + * @param string $path + * @param string $filename * @return string */ public static function buildNotExistingFileName( $path, $filename ) { @@ -108,7 +108,6 @@ class Files { /** * Gets the Storage for an app - creates the needed folder if they are not * existant - * @param string appid * @param string $app * @return \OC\Files\View */ diff --git a/lib/public/share.php b/lib/public/share.php index bc8a54bc350..1225cfa0d43 100644 --- a/lib/public/share.php +++ b/lib/public/share.php @@ -750,12 +750,11 @@ class Share { /** * Set the permissions of an item for a specific user or group - * @param string Item type - * @param string Item source - * @param int SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK - * @param string User or group the item is being shared with - * @param int CRUDS permissions - * @param integer|null $permissions + * @param string $itemType Item type + * @param string $itemSource Item source + * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK + * @param string $shareWith User or group the item is being shared with + * @param integer|null $permissions CRUDS * @return boolean true on success or false on failure */ public static function setPermissions($itemType, $itemSource, $shareType, $shareWith, $permissions) { @@ -1382,20 +1381,15 @@ class Share { /** * Put shared item into the database - * @param string Item type - * @param string Item source - * @param int SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK - * @param string User or group the item is being shared with - * @param string User that is the owner of shared item - * @param int CRUDS permissions - * @param bool|array Parent folder target (optional) - * @param string token (optional) - * @param string name of the source item (optional) - * @param string $itemType - * @param string $itemSource - * @param integer $shareType - * @param integer $permissions - * @param string $itemSourceName + * @param string $itemType Item type + * @param string $itemSource Item source + * @param integer $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK + * @param string $shareWith User or group the item is being shared with + * @param string $uidOwner User that is the owner of shared item + * @param int $permissions CRUDS permissions + * @param bool|array, $parentFolder Parent folder target (optional) + * @param string $token (optional) + * @param string $itemSourceName name of the source item (optional) * @return bool Returns true on success or false on failure */ private static function put($itemType, $itemSource, $shareType, $shareWith, $uidOwner, @@ -1966,8 +1960,7 @@ interface Share_Backend { /** * Converts the shared item sources back into the item in the specified format - * @param array Shared items - * @param int Format + * @param array $items Shared items * @param integer $format * @return TODO * diff --git a/lib/public/template.php b/lib/public/template.php index 0d86acbd060..9a994c1bea8 100644 --- a/lib/public/template.php +++ b/lib/public/template.php @@ -65,9 +65,8 @@ function preview_icon( $path ) { /** * Make publicpreview_icon available as a simple function * Returns the path to the preview of the image. - * @param string path of file - * @param string token - * @param string $path + * @param string $path of file + * @param string $token * @return link to the preview */ function publicPreview_icon ( $path, $token ) { @@ -78,7 +77,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 string as string + * @return string size as string */ function human_file_size( $bytes ) { return(\human_file_size( $bytes )); @@ -89,7 +88,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 OC_L10N_String readable interpretation of the timestamp + * @return OC_L10N_String human readable interpretation of the timestamp */ function relative_modified_date( $timestamp, $dateOnly = false ) { return(\relative_modified_date($timestamp, null, $dateOnly)); @@ -100,7 +99,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 string readable interpretation of a file size + * @return string human readable interpretation of a file size */ function simple_file_size($bytes) { return(\human_file_size($bytes)); @@ -112,7 +111,7 @@ function simple_file_size($bytes) { * @param $options the options * @param $selected which one is selected? * @param array the parameters - * @return string options + * @return string html options */ function html_select_options($options, $selected, $params=array()) { return(\html_select_options($options, $selected, $params)); diff --git a/lib/public/user.php b/lib/public/user.php index ee8db3a100a..7bac938b838 100644 --- a/lib/public/user.php +++ b/lib/public/user.php @@ -101,10 +101,8 @@ class User { /** * Check if the password is correct - * @param string The username - * @param string The password - * @param string $uid - * @param string $password + * @param string $uid The username + * @param string $password The password * @return string|false username on success, false otherwise * * Check if the password is correct without logging in the user |