Commit 3ac22873 authored by Taylor Otwell's avatar Taylor Otwell

fixing API comments.

parent ee373db5
......@@ -10,11 +10,11 @@ class Arr {
* in multiple arrays is also supported.
*
* <code>
* // Returns "taylor"
* $item = Arr::get(array('name' => 'taylor'), 'name', $default);
* // Returns "taylor"
* $item = Arr::get(array('name' => 'taylor'), 'name', $default);
*
* // Returns "taylor"
* $item = Arr::get(array('name' => array('is' => 'taylor')), 'name.is');
* // Returns "taylor"
* $item = Arr::get(array('name' => array('is' => 'taylor')), 'name.is');
* </code>
*
* @param array $array
......
......@@ -21,14 +21,14 @@ class Asset {
* expressive code and a clean API.
*
* <code>
* // Get the default asset container
* $container = Asset::container();
* // Get the default asset container
* $container = Asset::container();
*
* // Get the "footer" asset contanier
* $container = Asset::container('footer');
* // Get the "footer" asset contanier
* $container = Asset::container('footer');
*
* // Add an asset to the "footer" container
* Asset::container('footer')->add('jquery', 'js/jquery.js');
* // Add an asset to the "footer" container
* Asset::container('footer')->add('jquery', 'js/jquery.js');
* </code>
*
* @param string $container
......@@ -46,14 +46,13 @@ class Asset {
/**
* Magic Method for calling methods on the default Asset container.
* This allows a convenient API for working with the default container.
*
* <code>
* // Add jQuery to the default container
* Asset::script('jquery', 'js/jquery.js');
* // 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');
* // Equivalent call using the container method
* Asset::container()->script('jquery', 'js/jquery.js');
* </code>
*/
public static function __callStatic($method, $parameters)
......@@ -98,8 +97,8 @@ class Asset_Container {
* extension, you may use the style or script methods to register assets.
*
* <code>
* // Register a jQuery asset
* Asset::add('jquery', 'js/jquery.js');
* // Register a jQuery asset
* Asset::add('jquery', 'js/jquery.js');
* </code>
*
* You may also specify asset dependencies. This will instruct the class to
......@@ -107,11 +106,11 @@ class Asset_Container {
* 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 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'));
* // Register jQuery UI with multiple dependencies
* Asset::add('jquery-ui', 'js/jquery-ui.js', array('jquery', 'fader'));
* </code>
*
* @param string $name
......@@ -227,7 +226,7 @@ class Asset_Container {
* Get the link to a single registered CSS asset.
*
* <code>
* echo $container->get_style('common');
* echo $container->get_style('common');
* </code>
*
* @param string $name
......@@ -242,7 +241,7 @@ class Asset_Container {
* Get the link to a single registered JavaScript asset.
*
* <code>
* echo $container->get_script('jquery');
* echo $container->get_script('jquery');
* </code>
*
* @param string $name
......
......@@ -31,10 +31,10 @@ class Auth {
* Determine if the current user of the application is authenticated.
*
* <code>
* if (Auth::check())
* {
* // The user is logged in...
* }
* if (Auth::check())
* {
* // The user is logged in...
* }
* </code>
*
* @return bool
......@@ -53,7 +53,7 @@ class Auth {
* of the closure will be cached and returned.
*
* <code>
* $email = Auth::user()->email;
* $email = Auth::user()->email;
* </code>
*
* @return object
......@@ -79,10 +79,10 @@ class Auth {
* by the Hash class when authenticating.
*
* <code>
* if (Auth::login('test@gmail.com', 'secret'))
* {
* // The credentials are valid...
* }
* if (Auth::login('test@gmail.com', 'secret'))
* {
* // The credentials are valid...
* }
* </code>
*
* @param string $username
......
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