Permalink
Browse files

Fix more doc blocks

  • Loading branch information...
1 parent b0a9e0d commit b221b021bc270725f2e183293aed8d4c5a101964 @bcrowe bcrowe committed Jan 31, 2014
@@ -77,7 +77,7 @@ public function each(callable $c) {
*
* @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 @@ public function filter(callable $c) {
*
* @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) {
View
@@ -1119,7 +1119,7 @@ public function orHaving($conditions, $types = []) {
* 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 @@ public function delete($table = null) {
* ->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) {
@@ -39,7 +39,7 @@ class Collection {
/**
* Schema dialect instance.
*
- * @var
+ * @var Cake\Database\Schema\BaseSchema
*/
protected $_dialect;
@@ -87,7 +87,7 @@ public function errorInfo();
* 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);
@@ -22,7 +22,7 @@
* 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
*/
View
@@ -269,7 +269,7 @@ public static function config($key, $config = null) {
* 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();
@@ -105,7 +105,7 @@ public function disposition($disposition = null) {
* 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) {
View
@@ -499,6 +499,7 @@ public function find($type = 'all', $options = []) {
* 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);
@@ -93,6 +93,7 @@ public function property($name = null) {
* 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) {
@@ -355,6 +355,7 @@ public function cascadeDelete(Entity $entity, $options = []) {
* 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) {
@@ -114,6 +114,7 @@ public function eagerLoader(array $options) {
* 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) {
@@ -90,6 +90,7 @@ public function property($name = null) {
* 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) {
View
@@ -985,7 +985,7 @@ public function hydrate($enable = null) {
/**
* 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) {
@@ -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;
@@ -20,6 +20,11 @@
*/
class RulesProvider {
+/**
+ * The class to proxy, defaults to \Cake\Validation\Validation in construction
+ *
+ * @var object
+ */
protected $_class;
/**
@@ -29,7 +29,7 @@ class DateTime implements InputInterface {
/**
* Select box widget.
*
- * @var Cake\View\Input\Select;
+ * @var Cake\View\Input\Select
*/
protected $_select;

0 comments on commit b221b02

Please sign in to comment.