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

@ -6,8 +6,9 @@
class Asset { class Asset {
/** /**
* All of the asset containers. Asset containers are created through the * All of the instantiated asset containers.
* container method, and are managed as singletons. *
* Asset containers are created through the container method, and are singletons.
* *
* @var array * @var array
*/ */

View File

@ -10,10 +10,10 @@ class Auth {
/** /**
* The current user of the application. * The current user of the application.
* *
* If no user is logged in, this variable will be NULL. Otherwise, it will contain * If no user is logged in, this will be NULL. Otherwise, it will contain the result
* the result of the "by_id" closure in the authentication configuration file. * 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 * @var object
* @see user() * @see user()

View File

@ -10,8 +10,10 @@ class Cache {
public static $drivers = array(); public static $drivers = array();
/** /**
* Get a cache driver instance. If no driver name is specified, the default * Get a cache driver instance.
* cache driver will be returned as defined in the cache configuration file. *
* If no driver name is specified, the default cache driver will be returned
* as defined in the cache configuration file.
* *
* @param string $driver * @param string $driver
* @return Cache\Driver * @return Cache\Driver

View File

@ -70,9 +70,6 @@ public static function set($key, $value)
/** /**
* Parse a configuration key. * Parse a configuration key.
* *
* The value on the left side of the dot is the configuration file
* name, while the right side of the dot is the item within that file.
*
* @param string $key * @param string $key
* @return array * @return array
*/ */
@ -93,9 +90,6 @@ private static function parse($key)
/** /**
* Load all of the configuration items from a file. * Load all of the configuration items from a file.
* *
* Laravel supports environment specific configuration files. So, the base configuration
* array will be loaded first, then any environment specific options will be merged in.
*
* @param string $file * @param string $file
* @param string $module * @param string $module
* @return bool * @return bool
@ -106,6 +100,9 @@ private static function load($module, $file)
$path = ($module === 'application') ? CONFIG_PATH : MODULE_PATH.$module.'/config/'; $path = ($module === 'application') ? CONFIG_PATH : MODULE_PATH.$module.'/config/';
// Load the base configuration file. Once that is loaded, we will merge any environment
// specific configuration options into the base array. This allows for the convenient
// cascading of configuration options depending on the application environment.
$config = (file_exists($base = $path.$file.EXT)) ? require $base : array(); $config = (file_exists($base = $path.$file.EXT)) ? require $base : array();
if (isset($_SERVER['LARAVEL_ENV']) and file_exists($path = $path.$_SERVER['LARAVEL_ENV'].'/'.$file.EXT)) if (isset($_SERVER['LARAVEL_ENV']) and file_exists($path = $path.$_SERVER['LARAVEL_ENV'].'/'.$file.EXT))

View File

@ -90,9 +90,6 @@ public function get($language = null, $default = null)
/** /**
* Parse a language key. * Parse a language key.
* *
* The value on the left side of the dot is the language file name,
* while the right side of the dot is the item within that file.
*
* @param string $key * @param string $key
* @param string $language * @param string $language
* @return array * @return array