added comment to auth class.

22c1353c · Taylor Otwell · 70e35fb3 · 22c1353c
Commit 22c1353c authored Jul 08, 2011 by Taylor Otwell
Hide whitespace changes
Inline Side-by-side

Showing with 4 additions and 1 deletion

auth.php system/auth.php +4 -1

No files found.
--- a/system/auth.php
+++ b/system/auth.php
@@ -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
 	 */