From: Thomas Müller <thomas.mueller@tmit.eu>
Date: Wed, 2 Oct 2013 13:04:42 +0000 (+0200)
Subject: fixing various PHPDoc comments
X-Git-Tag: v6.0.0alpha2~72^2~3
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=621ab1c7eee6d26b596b255605083f7958d11083;p=nextcloud-server.git

fixing various PHPDoc comments
---

diff --git a/lib/base.php b/lib/base.php
index 0283f90bbfe..b0b2dca502f 100644
--- a/lib/base.php
+++ b/lib/base.php
@@ -492,7 +492,7 @@ class OC {
 			$sessionUser = self::$session->get('user_id');
 			$serverUser = $_SERVER['PHP_AUTH_USER'];
 			OC_Log::write('core',
-				"Session user-id doesn't match PHP_AUTH_USER. SESSION[user_id]: $sessionUser; SERVER[PHP_AUTH_USER]: $serverUser.",
+				"Session user-id ($sessionUser) doesn't match SERVER[PHP_AUTH_USER] ($serverUser).",
 				OC_Log::WARN);
 			OC_User::logout();
 		}
@@ -757,7 +757,7 @@ class OC {
 		elseif (OC::tryRememberLogin()) {
 			$error[] = 'invalidcookie';
 		}
-		// Someone wants to log in :
+		// logon via web form
 		elseif (OC::tryFormLogin()) {
 			$error[] = 'invalidpassword';
 		}
diff --git a/lib/private/user.php b/lib/private/user.php
index 90060cb33d8..78f5dad75f9 100644
--- a/lib/private/user.php
+++ b/lib/private/user.php
@@ -215,9 +215,12 @@ class OC_User {
 
 	/**
 	 * @brief Try to login a user, assuming authentication
-	 * has already happened (e.g. via SSO).
+	 * has already happened (e.g. via Single Sign On).
 	 *
 	 * Log in a user and regenerate a new session.
+	 *
+	 * @param \OCP\ApacheBackend $backend
+	 * @return bool
 	 */
 	public static function loginWithApache(\OCP\ApacheBackend $backend) {
 
@@ -238,7 +241,10 @@ class OC_User {
 	/**
 	 * @brief Verify with Apache whether user is authenticated.
 	 *
-	 * @return boolean|null true: authenticated - false: not authenticated
+	 * @return boolean|null
+	 *          true: authenticated
+	 *          false: not authenticated
+	 *          null: not handled / no backend available
 	 */
 	public static function handleApacheAuth() {
 		foreach (self::$_usedBackends as $backend) {
@@ -306,11 +312,11 @@ class OC_User {
 	}
 
 	/**
-	 * Supplies an attribute to the logout hyperlink. The default behaviuour
+	 * Supplies an attribute to the logout hyperlink. The default behaviour
 	 * is to return an href with '?logout=true' appended. However, it can
 	 * supply any attribute(s) which are valid for <a>.
 	 *
-	 * @return String with one or more HTML attributes.
+	 * @return string with one or more HTML attributes.
 	 */
 	public static function getLogoutAttribute() {
 		foreach (self::$_usedBackends as $backend) {