added comment to auth class.

2011-07-07 23:01:44 -05:00 · 2011-07-07 23:01:44 -05:00 · 22c1353cea
parent 70e35fb3d7
commit 22c1353cea
1 changed files with 4 additions and 1 deletions
--- a/system/auth.php
+++ b/system/auth.php
@ -53,6 +53,9 @@ public static function user()
 	/**
 	 * 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 @@ public static function login($username, $password)
 	}

 	/**
-	 * Logout the current user of the application.
+	 * Logout the user of the application.
 	 *
 	 * @return void
 	 */