PHPDoc fixes

This commit is contained in:
Phill Sparks 2012-02-04 21:30:52 +00:00
parent f3be544b1a
commit 62072e5281
36 changed files with 74 additions and 56 deletions

View File

@ -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)
{

View File

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

View File

@ -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 @@ public static function routes($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)

View File

@ -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 @@ public static function driver($driver = null)
* Create a new cache driver instance.
*
* @param string $driver
* @return Driver
* @return Cache\Drivers\Driver
*/
protected static function factory($driver)
{

View File

@ -101,7 +101,7 @@ public function forget($key)
/**
* Get a query builder for the database table.
*
* @return Query
* @return Laravel\Database\Query
*/
protected function table()
{

View File

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

View File

@ -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)

View File

@ -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)
{

View File

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

View File

@ -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)

View File

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

View File

@ -113,7 +113,7 @@ public static function get($name, $default = null)
* @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)
{

View File

@ -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 @@ protected static function connect($config)
* Create a new database connector instance.
*
* @param string $driver
* @return Connector
* @return Database\Connectors\Connector
*/
protected static function connector($driver)
{
@ -90,7 +90,7 @@ protected static function connector($driver)
*
* @param string $table
* @param string $connection
* @return Queries\Query
* @return Database\Query
*/
public static function table($table, $connection = null)
{

View File

@ -625,7 +625,7 @@ public function get($columns = array('*'))
/**
* Get an aggregate value.
*
* @param string $aggregate
* @param string $aggregator
* @param string $column
* @return mixed
*/

View File

@ -99,7 +99,9 @@ public function fulltext($columns, $name)
/**
* 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 @@ public function integer($name, $increment = false)
* Add a float column to the table.
*
* @param string $name
* @param bool $increment
* @return Fluent
*/
public function float($name)

View File

@ -93,7 +93,7 @@ public static function type($path)
/**
* 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 @@ public static function mime($extension, $default = 'application/octet-stream')
* $image = File::is(array('jpg', 'png', 'gif'), 'path/to/file');
* </code>
*
* @param array|string $extension
* @param array|string $extensions
* @param string $path
* @return bool
*/

View File

@ -186,6 +186,7 @@ public static function label($name, $value, $attributes = array())
* 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 @@ public static function select($name, $options = array(), $selected = null, $attr
*
* @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 @@ public static function reset($value, $attributes = array())
* </code>
*
* @param string $url
* @param string $name
* @param array $attributes
* @return string
*/
@ -519,7 +521,6 @@ public static function image($url, $name = null, $attributes = array())
/**
* Create a HTML button element.
*
* @param string $name
* @param string $value
* @param array $attributes
* @return string

View File

@ -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>

View File

@ -173,6 +173,7 @@ public static function link_to_secure_asset($url, $title, $attributes = array())
* @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)

View File

@ -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)

View File

@ -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 @@ public static function connection()
* Create a new Memcached connection instance.
*
* @param array $servers
* @return Memcache
* @return Memcached
*/
protected static function connect($servers)
{

View File

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

View File

@ -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 @@ public function slider($adjacent = 3)
* echo $paginator->previous('Go Back');
* </code>
*
* @param string $text
* @return string
*/
public function previous($text = null)
@ -266,6 +267,7 @@ public function previous($text = null)
* echo $paginator->next('Skip Forwards');
* </code>
*
* @param string $text
* @return string
*/
public function next($text = null)
@ -364,7 +366,7 @@ protected function range($start, $end)
*
* @param int $page
* @param string $text
* @param string $attributes
* @param string $class
* @return string
*/
protected function link($page, $text, $class)

View File

@ -28,7 +28,7 @@ public static function to($url, $status = 302, $https = false)
*
* @param string $url
* @param int $status
* @return Response
* @return Redirect
*/
public static function to_secure($url, $status = 302)
{
@ -82,7 +82,7 @@ public static function to_secure_route($route, $parameters = array(), $status =
*
* @param string $key
* @param mixed $value
* @return Response
* @return Redirect
*/
public function with($key, $value)
{

View File

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

View File

@ -142,7 +142,7 @@ public function response()
*
* 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)

View File

@ -254,8 +254,8 @@ protected static function controller($bundle, $method, $destination, $segments)
/**
* 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)

View File

@ -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 @@ public static function start($driver)
* Create a new session driver instance.
*
* @param string $driver
* @return Driver
* @return Session\Drivers\Driver
*/
public static function factory($driver)
{
@ -71,7 +71,7 @@ public static function factory($driver)
* Session::instance()->put('name', 'Taylor');
* </code>
*
* @return Payload
* @return Session\Payload
*/
public static function instance()
{

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

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

View File

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

View File

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

View File

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

View File

@ -68,17 +68,28 @@
$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;