From 2a6a9a8cefcf68f48d95e124db0c1b7edc9fe356 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=B6rn=20Friedrich=20Dreyer?= <jfd@butonic.de>
Date: Thu, 6 Feb 2014 16:30:58 +0100
Subject: polish documentation based on scrutinizer patches

---
 lib/private/user.php | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

(limited to 'lib/private/user.php')

diff --git a/lib/private/user.php b/lib/private/user.php
index 98ebebbe5c1..c78fb094c4d 100644
--- a/lib/private/user.php
+++ b/lib/private/user.php
@@ -219,7 +219,7 @@ class OC_User {
 	 * @brief Try to login a user
 	 * @param $uid The username of the user to log in
 	 * @param $password The password of the user
-	 * @return bool
+	 * @return boolean|null
 	 *
 	 * Log in a user and regenerate a new session - if the password is ok
 	 */
@@ -287,6 +287,7 @@ class OC_User {
 
 	/**
 	 * @brief Sets user display name for session
+	 * @param string $uid
 	 */
 	public static function setDisplayName($uid, $displayName = null) {
 		if (is_null($displayName)) {
@@ -478,7 +479,7 @@ class OC_User {
 	 * @brief Check if the password is correct
 	 * @param string $uid The username
 	 * @param string $password The password
-	 * @return mixed user id a string on success, false otherwise
+	 * @return string|false user id a string on success, false otherwise
 	 *
 	 * Check if the password is correct without logging in the user
 	 * returns the user id or false
@@ -606,7 +607,7 @@ class OC_User {
 
 	/**
 	 * @brief Returns the first active backend from self::$_usedBackends.
-	 * @return null if no backend active, otherwise OCP\Authentication\IApacheBackend
+	 * @return OCP\Authentication\IApacheBackend|null if no backend active, otherwise OCP\Authentication\IApacheBackend
 	 */
 	private static function findFirstActiveUsedBackend() {
 		foreach (self::$_usedBackends as $backend) {
-- 
cgit v1.2.3