added comment to auth class.

This commit is contained in:
Taylor Otwell
2011-07-07 23:01:44 -05:00
parent 70e35fb3d7
commit 22c1353cea

View File

@@ -53,6 +53,9 @@ class Auth {
/**
* Attempt to login a user.
*
* If the user credentials are valid. The user ID will be stored in the session
* and will be considered "logged in" on subsequent requests to the application.
*
* @param string $username
* @param string $password
*/
@@ -78,7 +81,7 @@ class Auth {
}
/**
* Logout the current user of the application.
* Logout the user of the application.
*
* @return void
*/