improving class comments.

This commit is contained in:
Taylor Otwell
2011-08-13 22:19:04 -05:00
parent 47d2207c67
commit 21a6040a79
5 changed files with 13 additions and 16 deletions

View File

@@ -10,10 +10,10 @@ class Auth {
/**
* The current user of the application.
*
* If no user is logged in, this variable will be NULL. Otherwise, it will contain
* the result of the "by_id" closure in the authentication configuration file.
* If no user is logged in, this will be NULL. Otherwise, it will contain the result
* of the "by_id" closure in the authentication configuration file.
*
* However, the user should typically be accessed via the "user" method.
* Typically, the user should be accessed via the "user" method.
*
* @var object
* @see user()