Commit d197a97a authored by Taylor Otwell's avatar Taylor Otwell

remove comment bloat.

parent 83ab6092
...@@ -9,14 +9,6 @@ class Arr { ...@@ -9,14 +9,6 @@ class Arr {
* also be accessed using JavaScript "dot" style notation. Retrieving items nested * also be accessed using JavaScript "dot" style notation. Retrieving items nested
* in multiple arrays is also supported. * in multiple arrays is also supported.
* *
* <code>
* // Returns "taylor"
* $item = Arr::get(array('name' => 'taylor'), 'name', $default);
*
* // Returns "taylor"
* $item = Arr::get(array('name' => array('is' => 'taylor')), 'name.is');
* </code>
*
* @param array $array * @param array $array
* @param string $key * @param string $key
* @param mixed $default * @param mixed $default
......
...@@ -21,17 +21,6 @@ class Asset { ...@@ -21,17 +21,6 @@ class Asset {
* Containers provide a convenient method of grouping assets while maintaining * Containers provide a convenient method of grouping assets while maintaining
* expressive code and a clean API. * expressive code and a clean API.
* *
* <code>
* // Get the default asset container
* $container = Asset::container();
*
* // Get the "footer" asset contanier
* $container = Asset::container('footer');
*
* // Add an asset to the "footer" container
* Asset::container('footer')->add('jquery', 'js/jquery.js');
* </code>
*
* @param string $container * @param string $container
* @return Asset_Container * @return Asset_Container
*/ */
...@@ -47,14 +36,6 @@ class Asset { ...@@ -47,14 +36,6 @@ class Asset {
/** /**
* Magic Method for calling methods on the default Asset container. * Magic Method for calling methods on the default Asset container.
*
* <code>
* // Add jQuery to the default container
* Asset::script('jquery', 'js/jquery.js');
*
* // Equivalent call using the container method
* Asset::container()->script('jquery', 'js/jquery.js');
* </code>
*/ */
public static function __callStatic($method, $parameters) public static function __callStatic($method, $parameters)
{ {
...@@ -97,23 +78,10 @@ class Asset_Container { ...@@ -97,23 +78,10 @@ class Asset_Container {
* asset being registered (CSS or JavaScript). If you are using a non-standard * asset being registered (CSS or JavaScript). If you are using a non-standard
* extension, you may use the style or script methods to register assets. * extension, you may use the style or script methods to register assets.
* *
* <code>
* // Register a jQuery asset
* Asset::add('jquery', 'js/jquery.js');
* </code>
*
* You may also specify asset dependencies. This will instruct the class to * You may also specify asset dependencies. This will instruct the class to
* only link to the registered asset after its dependencies have been linked. * only link to the registered asset after its dependencies have been linked.
* For example, you may wish to make jQuery UI dependent on jQuery. * For example, you may wish to make jQuery UI dependent on jQuery.
* *
* <code>
* // Register jQuery UI as dependent on jQuery
* Asset::add('jquery-ui', 'js/jquery-ui.js', 'jquery');
*
* // Register jQuery UI with multiple dependencies
* Asset::add('jquery-ui', 'js/jquery-ui.js', array('jquery', 'fader'));
* </code>
*
* @param string $name * @param string $name
* @param string $source * @param string $source
* @param array $dependencies * @param array $dependencies
...@@ -226,10 +194,6 @@ class Asset_Container { ...@@ -226,10 +194,6 @@ class Asset_Container {
/** /**
* Get the link to a single registered CSS asset. * Get the link to a single registered CSS asset.
* *
* <code>
* echo $container->get_style('common');
* </code>
*
* @param string $name * @param string $name
* @return string * @return string
*/ */
...@@ -241,10 +205,6 @@ class Asset_Container { ...@@ -241,10 +205,6 @@ class Asset_Container {
/** /**
* Get the link to a single registered JavaScript asset. * Get the link to a single registered JavaScript asset.
* *
* <code>
* echo $container->get_script('jquery');
* </code>
*
* @param string $name * @param string $name
* @return string * @return string
*/ */
......
...@@ -30,13 +30,6 @@ class Auth { ...@@ -30,13 +30,6 @@ class Auth {
/** /**
* Determine if the current user of the application is authenticated. * Determine if the current user of the application is authenticated.
* *
* <code>
* if (Auth::check())
* {
* // The user is logged in...
* }
* </code>
*
* @return bool * @return bool
* @see login * @see login
*/ */
...@@ -52,10 +45,6 @@ class Auth { ...@@ -52,10 +45,6 @@ class Auth {
* the "by_id" closure in the authentication configuration file. The result * the "by_id" closure in the authentication configuration file. The result
* of the closure will be cached and returned. * of the closure will be cached and returned.
* *
* <code>
* $email = Auth::user()->email;
* </code>
*
* @return object * @return object
* @see $user * @see $user
*/ */
...@@ -78,13 +67,6 @@ class Auth { ...@@ -78,13 +67,6 @@ class Auth {
* The password passed to the method should be plain text, as it will be hashed * The password passed to the method should be plain text, as it will be hashed
* by the Hash class when authenticating. * by the Hash class when authenticating.
* *
* <code>
* if (Auth::login('test@gmail.com', 'secret'))
* {
* // The credentials are valid...
* }
* </code>
*
* @param string $username * @param string $username
* @param string $password * @param string $password
* @return bool * @return bool
......
...@@ -47,22 +47,6 @@ class Cache { ...@@ -47,22 +47,6 @@ class Cache {
/** /**
* Get an item from the cache. * Get an item from the cache.
* *
* If the cached item doesn't exist, the specified default value will be returned.
*
* <code>
* // Get the "name" item from the cache
* $name = Cache::get('name');
*
* // Get the "name" item, but return "Fred" if it doesn't exist
* $name = Cache::get('name', 'Fred');
* </code>
*
* The driver may also be specified:
*
* <code>
* $name = Cache::get('name', null, 'memcached');
* </code>
*
* @param string $key * @param string $key
* @param mixed $default * @param mixed $default
* @param string $driver * @param string $driver
...@@ -82,14 +66,6 @@ class Cache { ...@@ -82,14 +66,6 @@ class Cache {
* Get an item from the cache. If the item doesn't exist in the cache, store * Get an item from the cache. If the item doesn't exist in the cache, store
* the default value in the cache and return it. * the default value in the cache and return it.
* *
* <code>
* // Get the name item. If it doesn't exist, store "Fred" for 30 minutes
* $name = Cache::remember('name', 'Fred', 30);
*
* // Closures may also be used as default values
* $name = Cache::remember('votes', function() {return Vote::count();}, 30);
* </code>
*
* @param string $key * @param string $key
* @param mixed $default * @param mixed $default
* @param int $minutes * @param int $minutes
......
...@@ -32,14 +32,6 @@ class Config { ...@@ -32,14 +32,6 @@ class Config {
* If the name of a configuration file is passed without specifying an item, the * If the name of a configuration file is passed without specifying an item, the
* entire configuration array will be returned. * entire configuration array will be returned.
* *
* <code>
* // Get the application timezone
* $timezone = Config::get('application.timezone');
*
* // Get the application configuration array
* $application = Config::get('application');
* </code>
*
* @param string $key * @param string $key
* @param string $default * @param string $default
* @return array * @return array
...@@ -63,14 +55,6 @@ class Config { ...@@ -63,14 +55,6 @@ class Config {
* *
* If a configuration item is not specified, the entire configuration array will be set. * If a configuration item is not specified, the entire configuration array will be set.
* *
* <code>
* // Set the application timezone
* Config::set('application.timezone', 'America/Chicago');
*
* // Set the application configuration array
* Config::set('application', array());
* </code>
*
* @param string $key * @param string $key
* @param mixed $value * @param mixed $value
* @return void * @return void
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment