style fixes for public user api

This commit is contained in:
Georg Ehrke 2012-09-08 16:17:01 +02:00
parent 439ede2a1d
commit 89f3afe2fe
1 changed files with 13 additions and 25 deletions

View File

@ -34,8 +34,6 @@ namespace OCP;
* This class provides access to the user management. You can get information about the currently logged in user and the permissions for example * This class provides access to the user management. You can get information about the currently logged in user and the permissions for example
*/ */
class User { class User {
/** /**
* @brief get the user id of the user currently logged in. * @brief get the user id of the user currently logged in.
* @return string uid or false * @return string uid or false
@ -44,7 +42,6 @@ class User {
return \OC_USER::getUser(); return \OC_USER::getUser();
} }
/** /**
* @brief Get a list of all users * @brief Get a list of all users
* @returns array with all uids * @returns array with all uids
@ -55,7 +52,6 @@ class User {
return \OC_USER::getUsers(); return \OC_USER::getUsers();
} }
/** /**
* @brief Check if the user is logged in * @brief Check if the user is logged in
* @returns true/false * @returns true/false
@ -66,7 +62,6 @@ class User {
return \OC_USER::isLoggedIn(); return \OC_USER::isLoggedIn();
} }
/** /**
* @brief check if a user exists * @brief check if a user exists
* @param string $uid the username * @param string $uid the username
@ -76,7 +71,6 @@ class User {
return \OC_USER::userExists( $uid ); return \OC_USER::userExists( $uid );
} }
/** /**
* @brief Loggs the user out including all the session data * @brief Loggs the user out including all the session data
* @returns true * @returns true
@ -87,7 +81,6 @@ class User {
return \OC_USER::logout(); return \OC_USER::logout();
} }
/** /**
* @brief Check if the password is correct * @brief Check if the password is correct
* @param $uid The username * @param $uid The username
@ -100,7 +93,6 @@ class User {
return \OC_USER::checkPassword( $uid, $password ); return \OC_USER::checkPassword( $uid, $password );
} }
/** /**
* Check if the user is a admin, redirects to home if not * Check if the user is a admin, redirects to home if not
*/ */
@ -108,7 +100,6 @@ class User {
\OC_Util::checkAdminUser(); \OC_Util::checkAdminUser();
} }
/** /**
* Check if the user is logged in, redirects to home if not. With * Check if the user is logged in, redirects to home if not. With
* redirect URL parameter to the request URI. * redirect URL parameter to the request URI.
@ -116,7 +107,4 @@ class User {
public static function checkLoggedIn() { public static function checkLoggedIn() {
\OC_Util::checkLoggedIn(); \OC_Util::checkLoggedIn();
} }
} }