From 21a6040a79f7c685408d67dffdebeafba068d214 Mon Sep 17 00:00:00 2001 From: Taylor Otwell Date: Sat, 13 Aug 2011 22:19:04 -0500 Subject: [PATCH] improving class comments. --- system/asset.php | 5 +++-- system/auth.php | 6 +++--- system/cache.php | 6 ++++-- system/config.php | 9 +++------ system/lang.php | 3 --- 5 files changed, 13 insertions(+), 16 deletions(-) diff --git a/system/asset.php b/system/asset.php index b99efecd..dacf8694 100644 --- a/system/asset.php +++ b/system/asset.php @@ -6,8 +6,9 @@ use System\HTML; class Asset { /** - * All of the asset containers. Asset containers are created through the - * container method, and are managed as singletons. + * All of the instantiated asset containers. + * + * Asset containers are created through the container method, and are singletons. * * @var array */ diff --git a/system/auth.php b/system/auth.php index 4c63f383..65e6c009 100644 --- a/system/auth.php +++ b/system/auth.php @@ -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() diff --git a/system/cache.php b/system/cache.php index 90c12219..437f5275 100644 --- a/system/cache.php +++ b/system/cache.php @@ -10,8 +10,10 @@ class Cache { public static $drivers = array(); /** - * Get a cache driver instance. If no driver name is specified, the default - * cache driver will be returned as defined in the cache configuration file. + * Get a cache driver instance. + * + * If no driver name is specified, the default cache driver will be returned + * as defined in the cache configuration file. * * @param string $driver * @return Cache\Driver diff --git a/system/config.php b/system/config.php index 6118662f..c6b75ad0 100644 --- a/system/config.php +++ b/system/config.php @@ -70,9 +70,6 @@ class Config { /** * 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 * @return array */ @@ -93,9 +90,6 @@ class Config { /** * 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 $module * @return bool @@ -106,6 +100,9 @@ class 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(); if (isset($_SERVER['LARAVEL_ENV']) and file_exists($path = $path.$_SERVER['LARAVEL_ENV'].'/'.$file.EXT)) diff --git a/system/lang.php b/system/lang.php index 5e5c6537..b6c90c5c 100644 --- a/system/lang.php +++ b/system/lang.php @@ -90,9 +90,6 @@ class Lang { /** * 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 $language * @return array