From 3ac228732954ad2e7a09e41f8f6534b70a5c5f84 Mon Sep 17 00:00:00 2001
From: Taylor Otwell <taylorotwell@gmail.com>
Date: Sat, 13 Aug 2011 21:43:33 -0500
Subject: [PATCH] fixing API comments.

---
 system/arr.php   |  8 ++++----
 system/asset.php | 37 ++++++++++++++++++-------------------
 system/auth.php  | 18 +++++++++---------
 3 files changed, 31 insertions(+), 32 deletions(-)

diff --git a/system/arr.php b/system/arr.php
index 671e356e..d3b59d2e 100644
--- a/system/arr.php
+++ b/system/arr.php
@@ -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
diff --git a/system/asset.php b/system/asset.php
index cb704547..b99efecd 100644
--- a/system/asset.php
+++ b/system/asset.php
@@ -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
diff --git a/system/auth.php b/system/auth.php
index 21a32dd6..4c63f383 100644
--- a/system/auth.php
+++ b/system/auth.php
@@ -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