Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nextcloud/server.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas Müller <thomas.mueller@tmit.eu>2013-10-02 17:04:42 +0400
committerThomas Müller <thomas.mueller@tmit.eu>2013-10-02 17:04:42 +0400
commit621ab1c7eee6d26b596b255605083f7958d11083 (patch)
tree47d919d5cd12da8d6d50defae78cc7df462f9282 /lib/private/user.php
parent4d4eda0f0625f2375003c434d433a08782e0a874 (diff)
fixing various PHPDoc comments
Diffstat (limited to 'lib/private/user.php')
-rw-r--r--lib/private/user.php14
1 files changed, 10 insertions, 4 deletions
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) {