Merge pull request #306 from sparksp/patch-1

PHPDoc fixes

application/controllers/base.php

@@ -7,7 +7,7 @@ class Base_Controller extends Controller {
 	 *
 	 * @param  string    $method
 	 * @param  array     $parameters
-	 * @return Response
+	 * @return Laravel\Response
 	 */
 	public function __call($method, $parameters)
 	{

laravel/autoloader.php

@@ -183,8 +183,8 @@ class Autoloader {
 	/**
 	 * Map namespaces to directories.
 	 *
-	 * @param  string  $namespace
-	 * @param  string  $path
+	 * @param  array  $mappings
+	 * @return void
 	 */
 	public static function namespaces($mappings)
 	{

laravel/bundle.php

@@ -27,8 +27,7 @@ class Bundle {
 	 * Register a bundle for the application.
 	 *
 	 * @param  string  $bundle
-	 * @param  string  $location
-	 * @param  string  $handles
+	 * @param  mixed   $config  Array of 'location', 'handles' and 'auto'; or string of location.
 	 * @return void
 	 */
 	public static function register($bundle, $config = array())
@@ -111,7 +110,7 @@ class Bundle {
 	 *
 	 * If no bundle is assigned to handle the URI, the default bundle is returned.
 	 *
-	 * @param  string  $bundle
+	 * @param  string  $uri
 	 * @return string
 	 */
 	public static function handles($uri)

laravel/cache.php

@@ -23,7 +23,7 @@ class Cache {
 	 * </code>
 	 *
 	 * @param  string        $driver
-	 * @return Cache\Driver
+	 * @return Cache\Drivers\Driver
 	 */
 	public static function driver($driver = null)
 	{
@@ -41,7 +41,7 @@ class Cache {
 	 * Create a new cache driver instance.
 	 *
 	 * @param  string  $driver
-	 * @return Driver
+	 * @return Cache\Drivers\Driver
 	 */
 	protected static function factory($driver)
 	{

laravel/cache/drivers/database.php

@@ -101,7 +101,7 @@ class Database extends Driver {
 	/**
 	 * Get a query builder for the database table.
 	 *
-	 * @return Query
+	 * @return Laravel\Database\Query
 	 */
 	protected function table()
 	{

laravel/cache/drivers/driver.php

@@ -23,7 +23,6 @@ abstract class Driver {
 	 *
 	 * @param  string  $key
 	 * @param  mixed   $default
-	 * @param  string  $driver
 	 * @return mixed
 	 */
 	public function get($key, $default = null)

laravel/cache/drivers/redis.php

@@ -5,14 +5,14 @@ class Redis extends Driver {
 	/**
 	 * The Redis database instance.
 	 *
-	 * @var Redis
+	 * @var Laravel\Redis
 	 */
 	protected $redis;
 
 	/**
 	 * Create a new Redis cache driver instance.
 	 *
-	 * @param  Redis  $redis
+	 * @param  Laravel\Redis  $redis
 	 * @return void
 	 */
 	public function __construct(\Laravel\Redis $redis)

laravel/cli/console.php

@@ -6,7 +6,7 @@ class Console {
 	 * Parse the command line arguments and return the results.
 	 *
 	 * @param  array  $argv
-	 * @param  array
+	 * @return array
 	 */
 	public static function options($argv)
 	{

laravel/cli/tasks/migrate/database.php

@@ -74,7 +74,7 @@ class Database {
 	/**
 	 * Get a database query instance for the migration table.
 	 *
-	 * @return Query
+	 * @return Laravel\Database\Query
 	 */
 	protected function table()
 	{

laravel/cli/tasks/migrate/resolver.php

@@ -14,7 +14,7 @@ class Resolver {
 	/**
 	 * Create a new instance of the migration resolver.
 	 *
-	 * @param  Database  $datbase
+	 * @param  Database  $database
 	 * @return void
 	 */
 	public function __construct(Database $database)

laravel/cli/tasks/test/runner.php

@@ -41,7 +41,7 @@ class Runner extends Task {
 	/**
 	 * Run the tests for a given bundle.
 	 *
-	 * @param  array  $arguments
+	 * @param  array  $bundles
 	 * @return void
 	 */
 	public function bundle($bundles = array())

laravel/cookie.php

@@ -113,7 +113,7 @@ class Cookie {
 	 * @param  string  $path
 	 * @param  string  $domain
 	 * @param  bool    $secure
-	 * @return bool
+	 * @return void
 	 */
 	public static function put($name, $value, $minutes = 0, $path = '/', $domain = null, $secure = false)
 	{

laravel/database.php

@@ -26,7 +26,7 @@ class Database {
 	 * </code>
 	 *
 	 * @param  string      $connection
-	 * @return Connection
+	 * @return Database\Connection
 	 */
 	public static function connection($connection = null)
 	{
@@ -62,7 +62,7 @@ class Database {
 	 * Create a new database connector instance.
 	 *
 	 * @param  string     $driver
-	 * @return Connector
+	 * @return Database\Connectors\Connector
 	 */
 	protected static function connector($driver)
 	{
@@ -90,7 +90,7 @@ class Database {
 	 *
 	 * @param  string          $table
 	 * @param  string          $connection
-	 * @return Queries\Query
+	 * @return Database\Query
 	 */
 	public static function table($table, $connection = null)
 	{

laravel/database/query.php

@@ -625,7 +625,7 @@ class Query {
 	/**
 	 * Get an aggregate value.
 	 *
-	 * @param  string  $aggregate
+	 * @param  string  $aggregator
 	 * @param  string  $column
 	 * @return mixed
 	 */

laravel/database/schema/table.php

@@ -99,7 +99,9 @@ class Table {
 	/**
 	 * Create a new index on the table.
 	 *
-	 * @param  string|array
+	 * @param  string|array  $columns
+	 * @param  string        $name
+	 * @return Fluent
 	 */
 	public function index($columns, $name)
 	{
@@ -237,7 +239,6 @@ class Table {
 	 * Add a float column to the table.
 	 *
 	 * @param  string  $name
-	 * @param  bool    $increment
 	 * @return Fluent
 	 */
 	public function float($name)

laravel/file.php

@@ -93,7 +93,7 @@ class File {
 	/**
 	 * Get the file size of a given file.
 	 *
-	 * @param  string  $file
+	 * @param  string  $path
 	 * @return int
 	 */
 	public static function size($path)
@@ -149,7 +149,7 @@ class File {
 	 *		$image = File::is(array('jpg', 'png', 'gif'), 'path/to/file');
 	 * </code>
 	 *
-	 * @param  array|string  $extension
+	 * @param  array|string  $extensions
 	 * @param  string        $path
 	 * @return bool
 	 */

laravel/form.php

@@ -186,6 +186,7 @@ class Form {
 	 *		echo Form::input('text', 'email', 'example@gmail.com');
 	 * </code>
 	 *
+	 * @param  string  $type
 	 * @param  string  $name
 	 * @param  mixed   $value
 	 * @param  array   $attributes
@@ -389,7 +390,7 @@ class Form {
 	 *
 	 * @param  string  $value
 	 * @param  string  $display
-	 * @return string  $selected
+	 * @param  string  $selected
 	 * @return string
 	 */
 	protected static function option($value, $display, $selected)
@@ -506,6 +507,7 @@ class Form {
 	 * </code>
 	 *
 	 * @param  string  $url
+	 * @param  string  $name
 	 * @param  array   $attributes
 	 * @return string
 	 */
@@ -519,7 +521,6 @@ class Form {
 	/**
 	 * Create a HTML button element.
 	 *
-	 * @param  string  $name
 	 * @param  string  $value
 	 * @param  array   $attributes
 	 * @return string

laravel/helpers.php

@@ -26,7 +26,7 @@ function __($key, $replacements = array(), $language = null)
 	return Laravel\Lang::line($key, $replacements, $language);
 }
 
-/**a
+/**
  * Get an item from an array using "dot" notation.
  *
  * <code>

laravel/html.php

@@ -173,6 +173,7 @@ class HTML {
 	 * @param  string  $title
 	 * @param  array   $parameters
 	 * @param  array   $attributes
+	 * @param  bool    $https
 	 * @return string
 	 */
 	public static function link_to_route($name, $title, $parameters = array(), $attributes = array(), $https = false)

laravel/ioc.php

@@ -21,6 +21,7 @@ class IoC {
 	 *
 	 * @param  string   $name
 	 * @param  Closure  $resolver
+	 * @param  bool     $singleton
 	 * @return void
 	 */
 	public static function register($name, Closure $resolver, $singleton = false)

laravel/memcached.php

@@ -5,7 +5,7 @@ class Memcached {
 	/**
 	 * The Memcached connection instance.
 	 *
-	 * @var Memcache
+	 * @var Memcached
 	 */
 	protected static $connection;
 
@@ -20,7 +20,7 @@ class Memcached {
 	 *		Memcached::connection()->set('name', 'Taylor');
 	 * </code>
 	 *
-	 * @return Memcache
+	 * @return Memcached
 	 */
 	public static function connection()
 	{
@@ -36,7 +36,7 @@ class Memcached {
 	 * Create a new Memcached connection instance.
 	 *
 	 * @param  array     $servers
-	 * @return Memcache
+	 * @return Memcached
 	 */
 	protected static function connect($servers)
 	{

laravel/messages.php

@@ -12,6 +12,7 @@ class Messages {
 	/**
 	 * Create a new Messages instance.
 	 *
+	 * @param  array  $messages
 	 * @return void
 	 */
 	public function __construct($messages = array())

laravel/paginator.php

@@ -71,10 +71,10 @@ class Paginator {
 	 * Create a new Paginator instance.
 	 *
 	 * @param  array  $results
-	 * @param  int    $last
 	 * @param  int    $page
 	 * @param  int    $total
 	 * @param  int    $per_page
+	 * @param  int    $last
 	 * @return void
 	 */
 	protected function __construct($results, $page, $total, $per_page, $last)
@@ -246,6 +246,7 @@ class Paginator {
 	 *		echo $paginator->previous('Go Back');
 	 * </code>
 	 *
+	 * @param  string  $text
 	 * @return string
 	 */
 	public function previous($text = null)
@@ -266,6 +267,7 @@ class Paginator {
 	 *		echo $paginator->next('Skip Forwards');
 	 * </code>
 	 *
+	 * @param  string  $text
 	 * @return string
 	 */
 	public function next($text = null)
@@ -364,7 +366,7 @@ class Paginator {
 	 *
 	 * @param  int     $page
 	 * @param  string  $text
-	 * @param  string  $attributes
+	 * @param  string  $class
 	 * @return string
 	 */
 	protected function link($page, $text, $class)

laravel/redirect.php

@@ -28,7 +28,7 @@ class Redirect extends Response {
 	 *
 	 * @param  string    $url
 	 * @param  int       $status
-	 * @return Response
+	 * @return Redirect
 	 */
 	public static function to_secure($url, $status = 302)
 	{
@@ -82,7 +82,7 @@ class Redirect extends Response {
 	 *
 	 * @param  string          $key
 	 * @param  mixed           $value
-	 * @return Response
+	 * @return Redirect
 	 */
 	public function with($key, $value)
 	{

laravel/routing/filter.php

@@ -155,6 +155,7 @@ class Filter_Collection {
 	 *
 	 * @param  string|array  $filters
 	 * @param  mixed         $parameters
+	 * @return void
 	 */
 	public function __construct($filters, $parameters = null)
 	{

laravel/routing/route.php

@@ -142,7 +142,7 @@ class Route {
 	 *
 	 * If the route belongs to a bundle, the bundle's global filters are returned too.
 	 *
-	 * @param  string  $filter
+	 * @param  string  $event
 	 * @return array
 	 */
 	protected function filters($event)

laravel/routing/router.php

@@ -254,8 +254,8 @@ class Router {
 	/**
 	 * Locate the URI segment matching a controller name.
 	 *
-	 * @param  string  $directory
 	 * @param  array   $segments
+	 * @param  string  $directory
 	 * @return int
 	 */
 	protected static function locate($segments, $directory)

laravel/session.php

@@ -5,7 +5,7 @@ class Session {
 	/**
 	 * The session singleton instance for the request.
 	 *
-	 * @var Payload
+	 * @var Session\Payload
 	 */
 	public static $instance;
 
@@ -31,7 +31,7 @@ class Session {
 	 * Create a new session driver instance.
 	 *
 	 * @param  string  $driver
-	 * @return Driver
+	 * @return Session\Drivers\Driver
 	 */
 	public static function factory($driver)
 	{
@@ -71,7 +71,7 @@ class Session {
 	 *		Session::instance()->put('name', 'Taylor');
 	 * </code>
 	 *
-	 * @return Payload
+	 * @return Session\Payload
 	 */
 	public static function instance()
 	{

laravel/session/drivers/apc.php

@@ -5,14 +5,14 @@ class APC implements Driver {
 	/**
 	 * The APC cache driver instance.
 	 *
-	 * @var Cache\Drivers\APC
+	 * @var Laravel\Cache\Drivers\APC
 	 */
 	private $apc;
 
 	/**
 	 * Create a new APC session driver instance.
 	 *
-	 * @param  Cache\Drivers\APC  $apc
+	 * @param  Laravel\Cache\Drivers\APC  $apc
 	 * @return void
 	 */
 	public function __construct(\Laravel\Cache\Drivers\APC $apc)

laravel/session/drivers/memcached.php

@@ -5,14 +5,14 @@ class Memcached implements Driver {
 	/**
 	 * The Memcache cache driver instance.
 	 *
-	 * @var Cache\Drivers\Memcached
+	 * @var Laravel\Cache\Drivers\Memcached
 	 */
 	private $memcached;
 
 	/**
 	 * Create a new Memcached session driver instance.
 	 *
-	 * @param  Memcached  $memcached
+	 * @param  Laravel\Cache\Drivers\Memcached  $memcached
 	 * @return void
 	 */
 	public function __construct(\Laravel\Cache\Drivers\Memcached $memcached)

laravel/session/drivers/redis.php

@@ -5,14 +5,14 @@ class Redis implements Driver {
 	/**
 	 * The Redis cache driver instance.
 	 *
-	 * @var Cache\Drivers\Redis
+	 * @var Laravel\Cache\Drivers\Redis
 	 */
 	protected $redis;
 
 	/**
 	 * Create a new Redis session driver.
 	 *
-	 * @param  Cache\Drivers\Redis  $redis
+	 * @param  Laravel\Cache\Drivers\Redis  $redis
 	 * @return void
 	 */
 	public function __construct(\Laravel\Cache\Drivers\Redis $redis)

laravel/session/payload.php

@@ -202,7 +202,7 @@ class Payload {
 	 *		Session::keep(array('name', 'email'));
 	 * </code>
 	 *
-	 * @param  string|array  $key
+	 * @param  string|array  $keys
 	 * @return void
 	 */
 	public function keep($keys)

laravel/str.php

@@ -154,6 +154,7 @@ class Str {
 	 * </code>
 	 *
 	 * @param  string  $value
+	 * @param  int     $count
 	 * @return string
 	 */
 	public static function plural($value, $count = 2)
@@ -177,7 +178,7 @@ class Str {
 	 * </code>
 	 *
 	 * @param  string  $value
-	 * @param  int     $length
+	 * @param  int     $words
 	 * @param  string  $end
 	 * @return string
 	 */

laravel/validator.php

@@ -946,7 +946,7 @@ class Validator {
 	/**
 	 * Get the database connection for the Validator.
 	 *
-	 * @return Connection
+	 * @return Database\Connection
 	 */
 	protected function db()
 	{

laravel/view.php

@@ -183,7 +183,7 @@ class View implements ArrayAccess {
 	 * </code>
 	 *
 	 * @param  string   $view
-	 * @param  Closure  
+	 * @param  Closure  $composer
 	 * @return void
 	 */
 	public static function composer($view, $composer)

paths.php

@@ -68,17 +68,28 @@ foreach ($paths as $name => $path)
 	$GLOBALS['laravel_paths'][$name] = realpath($path).DS;
 }
 
-// --------------------------------------------------------------
-// Define a global path helper function.
-// --------------------------------------------------------------
+/**
+ * A global path helper function.
+ * 
+ * <code>
+ *     $storage = path('storage');
+ * </code>
+ * 
+ * @param  string  $path
+ * @return string
+ */
 function path($path)
 {
 	return $GLOBALS['laravel_paths'][$path];
 }
 
-// --------------------------------------------------------------
-// Define a global path setter function.
-// --------------------------------------------------------------
+/**
+ * A global path setter function.
+ * 
+ * @param  string  $path
+ * @param  string  $value
+ * @return void
+ */
 function set_path($path, $value)
 {
 	$GLOBALS['laravel_paths'][$path] = $value;