summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorJoas Schilling <nickvergessen@gmx.de>2014-02-08 11:47:55 +0100
committerJoas Schilling <nickvergessen@gmx.de>2014-02-08 11:47:55 +0100
commitb330d07b51a983dc563a91244a3c83e691c9e97d (patch)
tree1142ec91b86d5da36e568ffcb4a25f5fd55b01fe /lib
parent81031984a6714feffc8b1a8e523988ab83f56515 (diff)
downloadnextcloud-server-b330d07b51a983dc563a91244a3c83e691c9e97d.tar.gz
nextcloud-server-b330d07b51a983dc563a91244a3c83e691c9e97d.zip
Fix more documentation failes
Issue #7111
Diffstat (limited to 'lib')
-rw-r--r--lib/private/appconfig.php4
-rw-r--r--lib/private/archive.php35
-rw-r--r--lib/private/archive/tar.php31
-rw-r--r--lib/private/archive/zip.php33
-rw-r--r--lib/private/davclient.php3
-rw-r--r--lib/private/files/node/node.php3
-rw-r--r--lib/private/installer.php27
-rw-r--r--lib/private/ocs.php11
-rwxr-xr-xlib/private/request.php15
-rwxr-xr-xlib/private/util.php5
-rw-r--r--lib/public/app.php8
-rw-r--r--lib/public/db.php4
-rw-r--r--lib/public/files.php17
-rw-r--r--lib/public/share.php37
-rw-r--r--lib/public/template.php13
-rw-r--r--lib/public/user.php6
16 files changed, 111 insertions, 141 deletions
diff --git a/lib/private/appconfig.php b/lib/private/appconfig.php
index 4dbbfbcf85d..5da0a7e906b 100644
--- a/lib/private/appconfig.php
+++ b/lib/private/appconfig.php
@@ -180,8 +180,6 @@ class OC_Appconfig {
* @param string $app app
* @param string $key key
* @return bool
- *
- * Deletes a key.
*/
public static function deleteKey($app, $key) {
// Boring!
@@ -213,8 +211,6 @@ class OC_Appconfig {
/**
* get multiply values, either the app or key can be used as wildcard by setting it to false
*
- * @param app
- * @param key
* @param boolean $app
* @param string $key
* @return array
diff --git a/lib/private/archive.php b/lib/private/archive.php
index 9fe553f7141..a18f8d3ffbd 100644
--- a/lib/private/archive.php
+++ b/lib/private/archive.php
@@ -9,7 +9,6 @@
abstract class OC_Archive{
/**
* open any of the supported archive types
- * @param string path
* @param string $path
* @return OC_Archive
*/
@@ -33,41 +32,39 @@ abstract class OC_Archive{
abstract function __construct($source);
/**
* add an empty folder to the archive
- * @param string path
* @param string $path
* @return bool
*/
abstract function addFolder($path);
/**
* add a file to the archive
- * @param string path
- * @param string source either a local file or string data
* @param string $path
+ * @param string source either a local file or string data
* @return bool
*/
abstract function addFile($path, $source='');
/**
* rename a file or folder in the archive
- * @param string source
- * @param string dest
+ * @param string $source
+ * @param string $dest
* @return bool
*/
abstract function rename($source, $dest);
/**
* get the uncompressed size of a file in the archive
- * @param string path
+ * @param string $path
* @return int
*/
abstract function filesize($path);
/**
* get the last modified time of a file in the archive
- * @param string path
+ * @param string $path
* @return int
*/
abstract function mtime($path);
/**
* get the files in a folder
- * @param path
+ * @param string $path
* @return array
*/
abstract function getFolder($path);
@@ -78,47 +75,47 @@ abstract class OC_Archive{
abstract function getFiles();
/**
* get the content of a file
- * @param string path
+ * @param string $path
* @return string
*/
abstract function getFile($path);
/**
* extract a single file from the archive
- * @param string path
- * @param string dest
+ * @param string $path
+ * @param string $dest
* @return bool
*/
abstract function extractFile($path, $dest);
/**
* extract the archive
- * @param string path
- * @param string dest
+ * @param string $path
+ * @param string $dest
* @return bool
*/
abstract function extract($dest);
/**
* check if a file or folder exists in the archive
- * @param string path
+ * @param string $path
* @return bool
*/
abstract function fileExists($path);
/**
* remove a file or folder from the archive
- * @param string path
+ * @param string $path
* @return bool
*/
abstract function remove($path);
/**
* get a file handler
- * @param string path
- * @param string mode
+ * @param string $path
+ * @param string $mode
* @return resource
*/
abstract function getStream($path, $mode);
/**
* add a folder and all its content
* @param string $path
- * @param string source
+ * @param string $source
* @return boolean|null
*/
function addRecursive($path, $source) {
diff --git a/lib/private/archive/tar.php b/lib/private/archive/tar.php
index 224c8b82cc7..5538e027ab4 100644
--- a/lib/private/archive/tar.php
+++ b/lib/private/archive/tar.php
@@ -30,7 +30,7 @@ class OC_Archive_TAR extends OC_Archive{
/**
* try to detect the type of tar compression
- * @param string file
+ * @param string $file
* @return integer
*/
static public function getTarType($file) {
@@ -53,7 +53,7 @@ class OC_Archive_TAR extends OC_Archive{
/**
* add an empty folder to the archive
- * @param string path
+ * @param string $path
* @return bool
*/
function addFolder($path) {
@@ -80,8 +80,8 @@ class OC_Archive_TAR extends OC_Archive{
}
/**
* add a file to the archive
- * @param string path
- * @param string source either a local file or string data
+ * @param string $path
+ * @param string $source either a local file or string data
* @return bool
*/
function addFile($path, $source='') {
@@ -103,8 +103,8 @@ class OC_Archive_TAR extends OC_Archive{
/**
* rename a file or folder in the archive
- * @param string source
- * @param string dest
+ * @param string $source
+ * @param string $dest
* @return bool
*/
function rename($source, $dest) {
@@ -139,7 +139,7 @@ class OC_Archive_TAR extends OC_Archive{
/**
* get the uncompressed size of a file in the archive
- * @param string path
+ * @param string $path
* @return int
*/
function filesize($path) {
@@ -158,7 +158,7 @@ class OC_Archive_TAR extends OC_Archive{
/**
* get the files in a folder
- * @param path
+ * @param string $path
* @return array
*/
function getFolder($path) {
@@ -201,7 +201,7 @@ class OC_Archive_TAR extends OC_Archive{
}
/**
* get the content of a file
- * @param string path
+ * @param string $path
* @return string
*/
function getFile($path) {
@@ -209,8 +209,7 @@ class OC_Archive_TAR extends OC_Archive{
}
/**
* extract a single file from the archive
- * @param string path
- * @param string dest
+ * @param string $path
* @param string $dest
* @return bool
*/
@@ -232,8 +231,6 @@ class OC_Archive_TAR extends OC_Archive{
}
/**
* extract the archive
- * @param string path
- * @param string dest
* @param string $dest
* @return bool
*/
@@ -242,7 +239,7 @@ class OC_Archive_TAR extends OC_Archive{
}
/**
* check if a file or folder exists in the archive
- * @param string path
+ * @param string $path
* @return bool
*/
function fileExists($path) {
@@ -270,7 +267,7 @@ class OC_Archive_TAR extends OC_Archive{
/**
* remove a file or folder from the archive
- * @param string path
+ * @param string $path
* @return bool
*/
function remove($path) {
@@ -291,8 +288,8 @@ class OC_Archive_TAR extends OC_Archive{
}
/**
* get a file handler
- * @param string path
- * @param string mode
+ * @param string $path
+ * @param string $mode
* @return resource
*/
function getStream($path, $mode) {
diff --git a/lib/private/archive/zip.php b/lib/private/archive/zip.php
index 4cb83087e29..cd5479299a1 100644
--- a/lib/private/archive/zip.php
+++ b/lib/private/archive/zip.php
@@ -23,7 +23,7 @@ class OC_Archive_ZIP extends OC_Archive{
}
/**
* add an empty folder to the archive
- * @param string path
+ * @param string $path
* @return bool
*/
function addFolder($path) {
@@ -31,8 +31,8 @@ class OC_Archive_ZIP extends OC_Archive{
}
/**
* add a file to the archive
- * @param string path
- * @param string source either a local file or string data
+ * @param string $path
+ * @param string $source either a local file or string data
* @return bool
*/
function addFile($path, $source='') {
@@ -49,8 +49,8 @@ class OC_Archive_ZIP extends OC_Archive{
}
/**
* rename a file or folder in the archive
- * @param string source
- * @param string dest
+ * @param string $source
+ * @param string $dest
* @return boolean|null
*/
function rename($source, $dest) {
@@ -60,7 +60,7 @@ class OC_Archive_ZIP extends OC_Archive{
}
/**
* get the uncompressed size of a file in the archive
- * @param string path
+ * @param string $path
* @return int
*/
function filesize($path) {
@@ -69,7 +69,7 @@ class OC_Archive_ZIP extends OC_Archive{
}
/**
* get the last modified time of a file in the archive
- * @param string path
+ * @param string $path
* @return int
*/
function mtime($path) {
@@ -77,7 +77,7 @@ class OC_Archive_ZIP extends OC_Archive{
}
/**
* get the files in a folder
- * @param path
+ * @param string $path
* @return array
*/
function getFolder($path) {
@@ -107,7 +107,7 @@ class OC_Archive_ZIP extends OC_Archive{
}
/**
* get the content of a file
- * @param string path
+ * @param string $path
* @return string
*/
function getFile($path) {
@@ -115,8 +115,7 @@ class OC_Archive_ZIP extends OC_Archive{
}
/**
* extract a single file from the archive
- * @param string path
- * @param string dest
+ * @param string $path
* @param string $dest
* @return boolean|null
*/
@@ -126,8 +125,7 @@ class OC_Archive_ZIP extends OC_Archive{
}
/**
* extract the archive
- * @param string path
- * @param string dest
+ * @param string $path
* @param string $dest
* @return bool
*/
@@ -136,7 +134,7 @@ class OC_Archive_ZIP extends OC_Archive{
}
/**
* check if a file or folder exists in the archive
- * @param string path
+ * @param string $path
* @return bool
*/
function fileExists($path) {
@@ -144,7 +142,7 @@ class OC_Archive_ZIP extends OC_Archive{
}
/**
* remove a file or folder from the archive
- * @param string path
+ * @param string $path
* @return bool
*/
function remove($path) {
@@ -156,8 +154,8 @@ class OC_Archive_ZIP extends OC_Archive{
}
/**
* get a file handler
- * @param string path
- * @param string mode
+ * @param string $path
+ * @param string $mode
* @return resource
*/
function getStream($path, $mode) {
@@ -194,6 +192,7 @@ class OC_Archive_ZIP extends OC_Archive{
}
/**
+ * @param string $path
* @return string
*/
private function stripPath($path) {
diff --git a/lib/private/davclient.php b/lib/private/davclient.php
index f93b175f352..afa4e1103b4 100644
--- a/lib/private/davclient.php
+++ b/lib/private/davclient.php
@@ -31,8 +31,7 @@ class OC_DAVClient extends \Sabre_DAV_Client {
/**
* @brief Sets the request timeout or 0 to disable timeout.
- * @param int timeout in seconds or 0 to disable
- * @param integer $timeout
+ * @param integer $timeout in seconds or 0 to disable
*/
public function setRequestTimeout($timeout) {
$this->requestTimeout = (int)$timeout;
diff --git a/lib/private/files/node/node.php b/lib/private/files/node/node.php
index 604a881c4a1..643a587dfc2 100644
--- a/lib/private/files/node/node.php
+++ b/lib/private/files/node/node.php
@@ -31,9 +31,8 @@ class Node implements \OCP\Files\Node {
/**
* @param \OC\Files\View $view
- * @param \OC\Files\Node\Root Root $root
+ * @param \OC\Files\Node\Root $root
* @param string $path
- * @param Root $root
*/
public function __construct($root, $view, $path) {
$this->view = $view;
diff --git a/lib/private/installer.php b/lib/private/installer.php
index 43785adc006..1b974c6e5a5 100644
--- a/lib/private/installer.php
+++ b/lib/private/installer.php
@@ -25,10 +25,6 @@
*/
class OC_Installer{
/**
- * @brief Installs an app
- * @param $data array with all information
- * @throws \Exception
- * @returns integer
*
* This function installs an app. All information needed are passed in the
* associative array $data.
@@ -55,7 +51,11 @@ class OC_Installer{
*
* It is the task of oc_app_install to create the tables and do whatever is
* needed to get the app working.
- * @return string
+ *
+ * @brief Installs an app
+ * @param array $data with all information
+ * @throws \Exception
+ * @return integer
*/
public static function installApp( $data = array()) {
$l = \OC_L10N::get('lib');
@@ -220,7 +220,7 @@ class OC_Installer{
/**
* @brief checks whether or not an app is installed
- * @param $app app
+ * @param string $app app
* @returns true/false
*
* Checks whether or not an app is installed, i.e. registered in apps table.
@@ -236,7 +236,7 @@ class OC_Installer{
/**
* @brief Update an application
- * @param $data array with all information
+ * @param array $data with all information
*
* This function installs an app. All information needed are passed in the
* associative array $data.
@@ -270,7 +270,7 @@ class OC_Installer{
/**
* @brief Check if an update for the app is available
- * @param $name name of the application
+ * @param string $name name of the application
* @return string|false false or the version number of the update
*
* The function will check if an update for a version is available
@@ -298,8 +298,8 @@ class OC_Installer{
/**
* @brief Check if app is already downloaded
- * @param $name name of the application to remove
- * @returns true/false
+ * @param string $name name of the application to remove
+ * @return boolean
*
* The function will check if the app is already downloaded in the apps repository
*/
@@ -316,7 +316,7 @@ class OC_Installer{
* @brief Removes an app
* @param string $name name of the application to remove
* @param $options array with options
- * @returns true/false
+ * @return boolean
*
* This function removes an app. $options is an associative array. The
* following keys are optional:ja
@@ -395,8 +395,7 @@ class OC_Installer{
/**
* install an app already placed in the app folder
* @param string $app id of the app to install
- * @returns array see OC_App::getAppInfo
- * @return string
+ * @return integer
*/
public static function installShippedApp($app) {
//install the database
@@ -431,7 +430,7 @@ class OC_Installer{
/**
* check the code of an app with some static code checks
* @param string $folder the folder of the app to check
- * @returns true for app is o.k. and false for app is not o.k.
+ * @return boolean true for app is o.k. and false for app is not o.k.
*/
public static function checkCode($appname, $folder) {
diff --git a/lib/private/ocs.php b/lib/private/ocs.php
index 41eb0b303ac..2305b3eccfe 100644
--- a/lib/private/ocs.php
+++ b/lib/private/ocs.php
@@ -35,13 +35,10 @@ class OC_OCS {
/**
* reads input date from get/post/cookies and converts the date to a special data-type
*
- * @param string HTTP method to read the key from
- * @param string Parameter to read
- * @param string Variable type to format data
- * @param mixed Default value to return if the key is not found
- * @param string $method
- * @param string $key
- * @param string $default
+ * @param string $method HTTP method to read the key from
+ * @param string $key Parameter to read
+ * @param string $type Variable type to format data
+ * @param mixed $default Default value to return if the key is not found
* @return string Data or if the key is not found and no default is set it will exit with a 400 Bad request
*/
public static function readData($method, $key, $type = 'raw', $default = null) {
diff --git a/lib/private/request.php b/lib/private/request.php
index 14144992388..ee3d2fd54db 100755
--- a/lib/private/request.php
+++ b/lib/private/request.php
@@ -98,11 +98,10 @@ class OC_Request {
/**
* @brief Returns the script name
- * @returns string the script name
+ * @return string the script name
*
* Returns the script name, even if the website uses one or more
* reverse proxies
- * @return string
*/
public static function scriptName() {
$name = $_SERVER['SCRIPT_NAME'];
@@ -116,8 +115,7 @@ class OC_Request {
/**
* @brief get Path info from request
- * @returns string Path info or false when not found
- * @return string
+ * @return string Path info or false when not found
*/
public static function getPathInfo() {
if (array_key_exists('PATH_INFO', $_SERVER)) {
@@ -141,8 +139,7 @@ class OC_Request {
/**
* @brief get Path info from request, not urldecoded
- * @returns string Path info or false when not found
- * @return string
+ * @return string Path info or false when not found
*/
public static function getRawPathInfo() {
$requestUri = $_SERVER['REQUEST_URI'];
@@ -183,7 +180,7 @@ class OC_Request {
/**
* @brief Check if this is a no-cache request
- * @returns boolean true for no-cache
+ * @return boolean true for no-cache
*/
static public function isNoCache() {
if (!isset($_SERVER['HTTP_CACHE_CONTROL'])) {
@@ -194,7 +191,7 @@ class OC_Request {
/**
* @brief Check if the requestor understands gzip
- * @returns boolean true for gzip encoding supported
+ * @return boolean true for gzip encoding supported
*/
static public function acceptGZip() {
if (!isset($_SERVER['HTTP_ACCEPT_ENCODING'])) {
@@ -210,7 +207,7 @@ class OC_Request {
/**
* @brief Check if the requester sent along an mtime
- * @returns false or an mtime
+ * @return false or an mtime
*/
static public function hasModificationTime () {
if (isset($_SERVER['HTTP_X_OC_MTIME'])) {
diff --git a/lib/private/util.php b/lib/private/util.php
index 40a510ab1eb..1d24d5d9b5e 100755
--- a/lib/private/util.php
+++ b/lib/private/util.php
@@ -217,7 +217,7 @@ class OC_Util {
* @brief add a javascript file
*
* @param string $application
- * @param filename $file
+ * @param mixed $file filename
* @return void
*/
public static function addScript( $application, $file = null ) {
@@ -236,7 +236,7 @@ class OC_Util {
* @brief add a css file
*
* @param string $application
- * @param filename $file
+ * @param mixed $file filename
* @return void
*/
public static function addStyle( $application, $file = null ) {
@@ -515,7 +515,6 @@ class OC_Util {
/**
* @brief Check for correct file permissions of data directory
- * @paran string $dataDirectory
* @param string $dataDirectory
* @return array arrays with error messages and hints
*/
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