Browse Source

Fix more doc blocks

Bryan Crowe 12 years ago
parent
commit
b221b021bc

+ 2 - 2
src/Collection/CollectionTrait.php

@@ -77,7 +77,7 @@ trait CollectionTrait {
  *
  * @param callable $c the method that will receive each of the elements and
  * returns true whether or not they should be in the resulting collection.
- * @return \Cake\Collection\Iterator\FilterIterator;
+ * @return \Cake\Collection\Iterator\FilterIterator
  */
 	public function filter(callable $c) {
 		return new FilterIterator($this, $c);
@@ -104,7 +104,7 @@ trait CollectionTrait {
  *
  * @param callable $c the method that will receive each of the elements and
  * returns true whether or not they should be out of the resulting collection.
- * @return \Cake\Collection\Iterator\FilterIterator;
+ * @return \Cake\Collection\Iterator\FilterIterator
  */
 	public function reject(callable $c) {
 		return new FilterIterator($this, function ($key, $value, $items) use ($c) {

+ 2 - 2
src/Database/Query.php

@@ -1119,7 +1119,7 @@ class Query implements ExpressionInterface, IteratorAggregate {
  * Pages should start at 1.
  *
  * @param integer $num The page number you want.
- * @reutrn Query
+ * @return Query
  */
 	public function page($page) {
 		$limit = $this->clause('limit');
@@ -1455,7 +1455,7 @@ class Query implements ExpressionInterface, IteratorAggregate {
  *	->epilog('RETURNING id');
  * }}}
  *
- * @params string|QueryExpression the expression to be appended
+ * @param string|QueryExpression the expression to be appended
  * @return Query
  */
 	public function epilog($expression = null) {

+ 1 - 1
src/Database/Schema/Collection.php

@@ -39,7 +39,7 @@ class Collection {
 /**
  * Schema dialect instance.
  *
- * @var
+ * @var Cake\Database\Schema\BaseSchema
  */
 	protected $_dialect;
 

+ 1 - 1
src/Database/StatementInterface.php

@@ -87,7 +87,7 @@ interface StatementInterface {
  * that binding parameters from this method will not perform any custom type conversion
  * as it would normally happen when calling `bindValue`
  *
- * $param array $params list of values to be bound to query
+ * @param array $params list of values to be bound to query
  * @return boolean true on success, false otherwise
  */
 	public function execute($params = null);

+ 1 - 1
src/Database/TypeConverterTrait.php

@@ -22,7 +22,7 @@ trait TypeConverterTrait {
  * Converts a give value to a suitable database value based on type
  * and return relevant internal statement type
  *
- * @param mixed value
+ * @param mixed $value
  * @param string $type
  * @return array list containing converted value and internal type
  */

+ 1 - 1
src/Log/Log.php

@@ -269,7 +269,7 @@ class Log {
  * Get a logging engine.
  *
  * @param string $name Key name of a configured adapter to get.
- * @return $mixed instance of BaseLog or false if not found
+ * @return mixed Instance of BaseLog or false if not found
  */
 	public static function engine($name) {
 		static::_init();

+ 1 - 1
src/Network/Http/FormData/Part.php

@@ -105,7 +105,7 @@ class Part {
  * Get/set the contentId for a part.
  *
  * @param null|string $id The content id.
- * @return mixed.
+ * @return mixed
  */
 	public function contentId($id = null) {
 		if ($id === null) {

+ 1 - 0
src/ORM/Association.php

@@ -499,6 +499,7 @@ abstract class Association {
  * association. This means that rows in the 'target' table would miss important
  * or required information if the row in 'source' did not exist.
  *
+ * @param \Cake\ORM\Table $side The potential Table with ownership
  * @return boolean
  */
 	public abstract function isOwningSide(Table $side);

+ 1 - 0
src/ORM/Association/BelongsTo.php

@@ -93,6 +93,7 @@ class BelongsTo extends Association {
  * association. This means that rows in the 'target' table would miss important
  * or required information if the row in 'source' did not exist.
  *
+ * @param \Cake\ORM\Table $side The potential Table with ownership
  * @return boolean
  */
 	public function isOwningSide(Table $side) {

+ 1 - 0
src/ORM/Association/BelongsToMany.php

@@ -355,6 +355,7 @@ class BelongsToMany extends Association {
  * Returns boolean true, as both of the tables 'own' rows in the other side
  * of the association via the joint table.
  *
+ * @param \Cake\ORM\Table $side The potential Table with ownership
  * @return boolean
  */
 	public function isOwningSide(Table $side) {

+ 1 - 0
src/ORM/Association/HasMany.php

@@ -114,6 +114,7 @@ class HasMany extends Association {
  * association. This means that rows in the 'target' table would miss important
  * or required information if the row in 'source' did not exist.
  *
+ * @param \Cake\ORM\Table $side The potential Table with ownership
  * @return boolean
  */
 	public function isOwningSide(Table $side) {

+ 1 - 0
src/ORM/Association/HasOne.php

@@ -90,6 +90,7 @@ class HasOne extends Association {
  * association. This means that rows in the 'target' table would miss important
  * or required information if the row in 'source' did not exist.
  *
+ * @param \Cake\ORM\Table $side The potential Table with ownership
  * @return boolean
  */
 	public function isOwningSide(Table $side) {

+ 1 - 1
src/ORM/Query.php

@@ -985,7 +985,7 @@ class Query extends DatabaseQuery {
 /**
  * Decorates the ResultSet iterator with MapReduce routines
  *
- * @param $result Cake\ORM\ResultCollectionTrait original results
+ * @param Cake\ORM\ResultCollectionTrait $result Original results
  * @return Cake\ORM\ResultCollectionTrait
  */
 	protected function _decorateResults($result) {

+ 1 - 1
src/TestSuite/Fixture/TestFixture.php

@@ -83,7 +83,7 @@ class TestFixture {
 /**
  * The Cake\Database\Schema\Table for this fixture.
  *
- * @var Cake\Database\Schema\Table;
+ * @var Cake\Database\Schema\Table
  */
 	protected $_schema;
 

+ 5 - 0
src/Validation/RulesProvider.php

@@ -20,6 +20,11 @@ namespace Cake\Validation;
  */
 class RulesProvider {
 
+/**
+  * The class to proxy, defaults to \Cake\Validation\Validation in construction
+  *
+  * @var object
+  */
 	protected $_class;
 
 /**

+ 1 - 1
src/View/Input/DateTime.php

@@ -29,7 +29,7 @@ class DateTime implements InputInterface {
 /**
  * Select box widget.
  *
- * @var Cake\View\Input\Select;
+ * @var Cake\View\Input\Select
  */
 	protected $_select;