fixing various PHPDoc comments

diff --git a/lib/base.php b/lib/base.php
index 0283f90bbfed56bab995229506a00573e65e08b3..b0b2dca502f80477b02f055c03ed0f897c4a1e8f 100644 (file)
--- 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 90060cb33d8e6ec636007a548cf858371e7fdf83..78f5dad75f959c87a62926129310bfec2c75d558 100644 (file)
--- 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) {