Browse Source

Merge pull request #1052 from sergiigrebeniuk/hotfix-phpdoc

phpdoc fixes
Taylor Otwell 12 years ago
parent
commit
f5123f935a

+ 4 - 3
laravel/blade.php

@@ -95,7 +95,6 @@ class Blade {
 	 *
 	 *
 	 * @param  string  $view
 	 * @param  string  $view
 	 * @param  string  $path
 	 * @param  string  $path
-	 * @param  string  $compiled
 	 * @return bool
 	 * @return bool
 	 */
 	 */
 	public static function expired($view, $path)
 	public static function expired($view, $path)
@@ -106,7 +105,7 @@ class Blade {
 	/**
 	/**
 	 * Compiles the specified file containing Blade pseudo-code into valid PHP.
 	 * Compiles the specified file containing Blade pseudo-code into valid PHP.
 	 *
 	 *
-	 * @param  string  $path
+	 * @param  string  $view
 	 * @return string
 	 * @return string
 	 */
 	 */
 	public static function compile($view)
 	public static function compile($view)
@@ -168,6 +167,7 @@ class Blade {
 	 * Extract a variable value out of a Blade expression.
 	 * Extract a variable value out of a Blade expression.
 	 *
 	 *
 	 * @param  string  $value
 	 * @param  string  $value
+	 * @param  string  $expression
 	 * @return string
 	 * @return string
 	 */
 	 */
 	protected static function extract($value, $expression)
 	protected static function extract($value, $expression)
@@ -403,6 +403,7 @@ class Blade {
 	/**
 	/**
 	 * Rewrites Blade yield section statements into valid PHP.
 	 * Rewrites Blade yield section statements into valid PHP.
 	 *
 	 *
+	 * @param  string  $value
 	 * @return string
 	 * @return string
 	 */
 	 */
 	protected static function compile_yield_sections($value)
 	protected static function compile_yield_sections($value)
@@ -468,7 +469,7 @@ class Blade {
 	/**
 	/**
 	 * Get the fully qualified path for a compiled view.
 	 * Get the fully qualified path for a compiled view.
 	 *
 	 *
-	 * @param  string  $view
+	 * @param  string  $path
 	 * @return string
 	 * @return string
 	 */
 	 */
 	public static function compiled($path)
 	public static function compiled($path)

+ 1 - 0
laravel/cache/drivers/driver.php

@@ -67,6 +67,7 @@ abstract class Driver {
 	 * @param  string  $key
 	 * @param  string  $key
 	 * @param  mixed   $default
 	 * @param  mixed   $default
 	 * @param  int     $minutes
 	 * @param  int     $minutes
+	 * @param  string  $function
 	 * @return mixed
 	 * @return mixed
 	 */
 	 */
 	public function remember($key, $default, $minutes, $function = 'put')
 	public function remember($key, $default, $minutes, $function = 'put')

+ 1 - 0
laravel/cache/drivers/memcached.php

@@ -20,6 +20,7 @@ class Memcached extends Sectionable {
 	 * Create a new Memcached cache driver instance.
 	 * Create a new Memcached cache driver instance.
 	 *
 	 *
 	 * @param  Memcached  $memcache
 	 * @param  Memcached  $memcache
+	 * @param  string     $key
 	 * @return void
 	 * @return void
 	 */
 	 */
 	public function __construct(\Memcached $memcache, $key)
 	public function __construct(\Memcached $memcache, $key)

+ 1 - 0
laravel/cache/drivers/sectionable.php

@@ -63,6 +63,7 @@ abstract class Sectionable extends Driver {
 	 * @param  string  $key
 	 * @param  string  $key
 	 * @param  mixed   $default
 	 * @param  mixed   $default
 	 * @param  int     $minutes
 	 * @param  int     $minutes
+	 * @param  string  $function
 	 * @return mixed
 	 * @return mixed
 	 */
 	 */
 	public function remember_in_section($section, $key, $default, $minutes, $function = 'put')
 	public function remember_in_section($section, $key, $default, $minutes, $function = 'put')

+ 0 - 1
laravel/cli/tasks/help.php

@@ -8,7 +8,6 @@ class Help extends Task {
 	/**
 	/**
 	 * List available artisan commands. 
 	 * List available artisan commands. 
 	 *
 	 *
-	 * @param  array  $arguments
 	 * @return void
 	 * @return void
 	 */
 	 */
 	public function commands()
 	public function commands()

+ 1 - 0
laravel/cli/tasks/test/runner.php

@@ -10,6 +10,7 @@ class Runner extends Task {
 	/**
 	/**
 	 * Run all of the unit tests for the application.
 	 * Run all of the unit tests for the application.
 	 *
 	 *
+	 * @param  array  $bundles
 	 * @return void
 	 * @return void
 	 */
 	 */
 	public function run($bundles = array())
 	public function run($bundles = array())

+ 1 - 0
laravel/database/eloquent/model.php

@@ -567,6 +567,7 @@ abstract class Model {
 	 * Get a given attribute from the model.
 	 * Get a given attribute from the model.
 	 *
 	 *
 	 * @param  string  $key
 	 * @param  string  $key
+	 * @return mixed
 	 */
 	 */
 	public function get_attribute($key)
 	public function get_attribute($key)
 	{
 	{

+ 3 - 2
laravel/database/eloquent/relationships/belongs_to.php

@@ -79,8 +79,9 @@ class Belongs_To extends Relationship {
 	/**
 	/**
 	 * Match eagerly loaded child models to their parent models.
 	 * Match eagerly loaded child models to their parent models.
 	 *
 	 *
-	 * @param  array  $children
-	 * @param  array  $parents
+	 * @param  string  $relationship
+	 * @param  array   $children
+	 * @param  array   $parents
 	 * @return void
 	 * @return void
 	 */
 	 */
 	public function match($relationship, &$children, $parents)
 	public function match($relationship, &$children, $parents)

+ 3 - 2
laravel/database/eloquent/relationships/has_many.php

@@ -83,8 +83,9 @@ class Has_Many extends Has_One_Or_Many {
 	/**
 	/**
 	 * Match eagerly loaded child models to their parent models.
 	 * Match eagerly loaded child models to their parent models.
 	 *
 	 *
-	 * @param  array  $parents
-	 * @param  array  $children
+	 * @param  string  $relationship
+	 * @param  array   $parents
+	 * @param  array   $children
 	 * @return void
 	 * @return void
 	 */
 	 */
 	public function match($relationship, &$parents, $children)
 	public function match($relationship, &$parents, $children)

+ 7 - 4
laravel/database/eloquent/relationships/has_many_and_belongs_to.php

@@ -61,6 +61,8 @@ class Has_Many_And_Belongs_To extends Relationship {
 	 *
 	 *
 	 * By default, the name is the models sorted and joined with underscores.
 	 * By default, the name is the models sorted and joined with underscores.
 	 *
 	 *
+	 * @param  Model   $model
+	 * @param  string  $associated
 	 * @return string
 	 * @return string
 	 */
 	 */
 	protected function joining($model, $associated)
 	protected function joining($model, $associated)
@@ -86,7 +88,7 @@ class Has_Many_And_Belongs_To extends Relationship {
 	 * Insert a new record into the joining table of the association.
 	 * Insert a new record into the joining table of the association.
 	 *
 	 *
 	 * @param  int    $id
 	 * @param  int    $id
-	 * @param  array  $joining
+	 * @param  array  $attributes
 	 * @return bool
 	 * @return bool
 	 */
 	 */
 	public function attach($id, $attributes = array())
 	public function attach($id, $attributes = array())
@@ -317,8 +319,9 @@ class Has_Many_And_Belongs_To extends Relationship {
 	/**
 	/**
 	 * Match eagerly loaded child models to their parent models.
 	 * Match eagerly loaded child models to their parent models.
 	 *
 	 *
-	 * @param  array  $parents
-	 * @param  array  $children
+	 * @param  string  $relationship
+	 * @param  array   $parents
+	 * @param  array   $children
 	 * @return void
 	 * @return void
 	 */
 	 */
 	public function match($relationship, &$parents, $children)
 	public function match($relationship, &$parents, $children)
@@ -383,7 +386,7 @@ class Has_Many_And_Belongs_To extends Relationship {
 	/**
 	/**
 	 * Set the columns on the joining table that should be fetched.
 	 * Set the columns on the joining table that should be fetched.
 	 *
 	 *
-	 * @param  array         $column
+	 * @param  array         $columns
 	 * @return Relationship
 	 * @return Relationship
 	 */
 	 */
 	public function with($columns)
 	public function with($columns)

+ 3 - 2
laravel/database/eloquent/relationships/has_one.php

@@ -30,8 +30,9 @@ class Has_One extends Has_One_Or_Many {
 	/**
 	/**
 	 * Match eagerly loaded child models to their parent models.
 	 * Match eagerly loaded child models to their parent models.
 	 *
 	 *
-	 * @param  array  $parents
-	 * @param  array  $children
+	 * @param  string  $relationship
+	 * @param  array   $parents
+	 * @param  array   $children
 	 * @return void
 	 * @return void
 	 */
 	 */
 	public function match($relationship, &$parents, $children)
 	public function match($relationship, &$parents, $children)

+ 1 - 0
laravel/database/query.php

@@ -475,6 +475,7 @@ class Query {
 	 * @param  string  $column
 	 * @param  string  $column
 	 * @param  string  $operator
 	 * @param  string  $operator
 	 * @param  mixed   $value
 	 * @param  mixed   $value
+	 * @return Query
 	 */
 	 */
 	public function having($column, $operator, $value)
 	public function having($column, $operator, $value)
 	{
 	{

+ 1 - 1
laravel/database/schema.php

@@ -44,7 +44,7 @@ class Schema {
 	 * Rename a database table in the schema.
 	 * Rename a database table in the schema.
 	 *
 	 *
 	 * @param  string  $table
 	 * @param  string  $table
-	 * @param  string  $name
+	 * @param  string  $new_name
 	 * @return void
 	 * @return void
 	 */
 	 */
 	public static function rename($table, $new_name)
 	public static function rename($table, $new_name)

+ 2 - 2
laravel/database/schema/grammars/grammar.php

@@ -9,7 +9,7 @@ abstract class Grammar extends \Laravel\Database\Grammar {
 	 * Generate the SQL statement for creating a foreign key.
 	 * Generate the SQL statement for creating a foreign key.
 	 *
 	 *
 	 * @param  Table    $table
 	 * @param  Table    $table
-	 * @param  Command  $command
+	 * @param  Fluent  $command
 	 * @return string
 	 * @return string
 	 */
 	 */
 	public function foreign(Table $table, Fluent $command)
 	public function foreign(Table $table, Fluent $command)
@@ -54,7 +54,7 @@ abstract class Grammar extends \Laravel\Database\Grammar {
 	 * Drop a constraint from the table.
 	 * Drop a constraint from the table.
 	 *
 	 *
 	 * @param  Table   $table
 	 * @param  Table   $table
-	 * @param  Fluent  $fluent
+	 * @param  Fluent  $command
 	 * @return string
 	 * @return string
 	 */
 	 */
 	protected function drop_constraint(Table $table, Fluent $command)
 	protected function drop_constraint(Table $table, Fluent $command)

+ 1 - 1
laravel/database/schema/grammars/mysql.php

@@ -323,7 +323,7 @@ class MySQL extends Grammar {
 	 * Drop a foreign key constraint from the table.
 	 * Drop a foreign key constraint from the table.
 	 *
 	 *
 	 * @param  Table   $table
 	 * @param  Table   $table
-	 * @param  Fluent  $fluent
+	 * @param  Fluent  $command
 	 * @return string
 	 * @return string
 	 */
 	 */
 	public function drop_foreign(Table $table, Fluent $command)
 	public function drop_foreign(Table $table, Fluent $command)

+ 1 - 1
laravel/database/schema/grammars/postgres.php

@@ -309,7 +309,7 @@ class Postgres extends Grammar {
 	 * Drop a foreign key constraint from the table.
 	 * Drop a foreign key constraint from the table.
 	 *
 	 *
 	 * @param  Table   $table
 	 * @param  Table   $table
-	 * @param  Fluent  $fluent
+	 * @param  Fluent  $command
 	 * @return string
 	 * @return string
 	 */
 	 */
 	public function drop_foreign(Table $table, Fluent $command)
 	public function drop_foreign(Table $table, Fluent $command)

+ 1 - 1
laravel/database/schema/grammars/sqlserver.php

@@ -327,7 +327,7 @@ class SQLServer extends Grammar {
 	 * Drop a foreign key constraint from the table.
 	 * Drop a foreign key constraint from the table.
 	 *
 	 *
 	 * @param  Table   $table
 	 * @param  Table   $table
-	 * @param  Fluent  $fluent
+	 * @param  Fluent  $command
 	 * @return string
 	 * @return string
 	 */
 	 */
 	public function drop_foreign(Table $table, Fluent $command)
 	public function drop_foreign(Table $table, Fluent $command)

+ 1 - 0
laravel/database/schema/table.php

@@ -113,6 +113,7 @@ class Table {
 	 *
 	 *
 	 * @param  string|array  $columns
 	 * @param  string|array  $columns
 	 * @param  string        $name
 	 * @param  string        $name
+	 * @return Fluent
 	 */
 	 */
 	public function foreign($columns, $name = null)
 	public function foreign($columns, $name = null)
 	{
 	{

+ 1 - 1
laravel/event.php

@@ -176,7 +176,7 @@ class Event {
 	 *		$responses = Event::fire(array('start', 'loading'), $parameters);
 	 *		$responses = Event::fire(array('start', 'loading'), $parameters);
 	 * </code>
 	 * </code>
 	 *
 	 *
-	 * @param  string|array  $event
+	 * @param  string|array  $events
 	 * @param  array         $parameters
 	 * @param  array         $parameters
 	 * @param  bool          $halt
 	 * @param  bool          $halt
 	 * @return array
 	 * @return array

+ 1 - 1
laravel/form.php

@@ -20,7 +20,7 @@ class Form {
 	 * Registers a custom macro.
 	 * Registers a custom macro.
 	 *
 	 *
 	 * @param  string   $name
 	 * @param  string   $name
-	 * @param  Closure  $input
+	 * @param  Closure  $macro
 	 * @return void
 	 * @return void
 	 */
 	 */
 	public static function macro($name, $macro)
 	public static function macro($name, $macro)

+ 1 - 1
laravel/helpers.php

@@ -543,7 +543,7 @@ function render($view, $data = array())
 /**
 /**
  * Get the rendered contents of a partial from a loop.
  * Get the rendered contents of a partial from a loop.
  *
  *
- * @param  string  $view
+ * @param  string  $partial
  * @param  array   $data
  * @param  array   $data
  * @param  string  $iterator
  * @param  string  $iterator
  * @param  string  $empty
  * @param  string  $empty

+ 1 - 1
laravel/html.php

@@ -13,7 +13,7 @@ class HTML {
 	 * Registers a custom macro.
 	 * Registers a custom macro.
 	 *
 	 *
 	 * @param  string   $name
 	 * @param  string   $name
-	 * @param  Closure  $input
+	 * @param  Closure  $macro
 	 * @return void
 	 * @return void
 	 */
 	 */
 	public static function macro($name, $macro)
 	public static function macro($name, $macro)

+ 1 - 0
laravel/ioc.php

@@ -85,6 +85,7 @@ class IoC {
 	 * </code>
 	 * </code>
 	 *
 	 *
 	 * @param  string  $type
 	 * @param  string  $type
+	 * @param  array   $parameters
 	 * @return mixed
 	 * @return mixed
 	 */
 	 */
 	public static function resolve($type, $parameters = array())
 	public static function resolve($type, $parameters = array())

+ 2 - 1
laravel/log.php

@@ -64,7 +64,8 @@ class Log {
 	 * Format a log message for logging.
 	 * Format a log message for logging.
 	 *
 	 *
 	 * @param  string  $type
 	 * @param  string  $type
-	 * @param  
+	 * @param  string  $message
+	 * @return string
 	 */
 	 */
 	protected static function format($type, $message)
 	protected static function format($type, $message)
 	{
 	{

+ 1 - 0
laravel/pluralizer.php

@@ -24,6 +24,7 @@ class Pluralizer {
 	/**
 	/**
 	 * Create a new pluralizer instance.
 	 * Create a new pluralizer instance.
 	 *
 	 *
+	 * @param  array  $config
 	 * @return void
 	 * @return void
 	 */
 	 */
 	public function __construct($config)
 	public function __construct($config)

+ 2 - 0
laravel/profiling/profiler.php

@@ -39,6 +39,8 @@ class Profiler {
 	/**
 	/**
 	 * Add a log entry to the log entries array.
 	 * Add a log entry to the log entries array.
 	 *
 	 *
+	 * @param  string  $type
+	 * @param  string  $message
 	 * @return void
 	 * @return void
 	 */
 	 */
 	public static function log($type, $message)
 	public static function log($type, $message)

+ 1 - 1
laravel/redirect.php

@@ -6,7 +6,7 @@ class Redirect extends Response {
 	 * Create a redirect response to application root.
 	 * Create a redirect response to application root.
 	 *
 	 *
 	 * @param  int       $status
 	 * @param  int       $status
-	 * @param  bool      $secure
+	 * @param  bool      $https
 	 * @return Redirect
 	 * @return Redirect
 	 */
 	 */
 	public static function home($status = 302, $https = null)
 	public static function home($status = 302, $https = null)

+ 1 - 0
laravel/request.php

@@ -119,6 +119,7 @@ class Request {
 	/**
 	/**
 	 * Determine if the request accepts a given content type.
 	 * Determine if the request accepts a given content type.
 	 *
 	 *
+	 * @param  string  $type
 	 * @return bool
 	 * @return bool
 	 */
 	 */
 	public static function accepts($type)
 	public static function accepts($type)

+ 1 - 1
laravel/routing/router.php

@@ -292,7 +292,7 @@ class Router {
 	/**
 	/**
 	 * Register a controller with the router.
 	 * Register a controller with the router.
 	 *
 	 *
-	 * @param  string|array  $controller
+	 * @param  string|array  $controllers
 	 * @param  string|array  $defaults
 	 * @param  string|array  $defaults
 	 * @param  bool          $https
 	 * @param  bool          $https
 	 * @return void
 	 * @return void

+ 1 - 0
laravel/validator.php

@@ -637,6 +637,7 @@ class Validator {
 	 *
 	 *
 	 * @param  string  $attribute
 	 * @param  string  $attribute
 	 * @param  mixed   $value
 	 * @param  mixed   $value
+	 * @param  array   $parameters
 	 * @return bool
 	 * @return bool
 	 */
 	 */
 	protected function validate_match($attribute, $value, $parameters)
 	protected function validate_match($attribute, $value, $parameters)

+ 1 - 1
laravel/view.php

@@ -255,7 +255,7 @@ class View implements ArrayAccess {
 	 *		});
 	 *		});
 	 * </code>
 	 * </code>
 	 *
 	 *
-	 * @param  string|array  $view
+	 * @param  string|array  $views
 	 * @param  Closure       $composer
 	 * @param  Closure       $composer
 	 * @return void
 	 * @return void
 	 */
 	 */