From 7c07d37fb32b8b2162804290e33184f66d6a4ae4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marc=20W=C3=BCrth?= <ravage@bluewin.ch>
Date: Thu, 24 Oct 2013 13:05:32 +0200
Subject: [PATCH] Some DocBlock improvements for Model.php

---
 lib/Cake/Model/Model.php | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/lib/Cake/Model/Model.php b/lib/Cake/Model/Model.php
index 67852f2ea9a..72c185b84af 100644
--- a/lib/Cake/Model/Model.php
+++ b/lib/Cake/Model/Model.php
@@ -665,7 +665,8 @@ class Model extends Object implements CakeEventListener {
  * Would create a model attached to the posts table on connection2. Dynamic model creation is useful
  * when you want a model object that contains no associations or attached behaviors.
  *
- * @param integer|string|array $id Set this ID for this model on startup, can also be an array of options, see above.
+ * @param boolean|integer|string|array $id Set this ID for this model on startup,
+ * can also be an array of options, see above.
  * @param string $table Name of database table to use.
  * @param string $ds DataSource connection name.
  */
@@ -904,7 +905,7 @@ public function __get($name) {
  * Example: Add a new hasOne binding to the Profile model not
  * defined in the model source code:
  *
- * `$this->User->bindModel( array('hasOne' => array('Profile')) );`
+ * `$this->User->bindModel(array('hasOne' => array('Profile')));`
  *
  * Bindings that are not made permanent will be reset by the next Model::find() call on this
  * model.
@@ -953,7 +954,7 @@ public function bindModel($params, $reset = true) {
  * Example: Turn off the associated Model Support request,
  * to temporarily lighten the User model:
  *
- * `$this->User->unbindModel( array('hasMany' => array('Supportrequest')) );`
+ * `$this->User->unbindModel(array('hasMany' => array('Supportrequest')));`
  *
  * unbound models that are not made permanent will reset with the next call to Model::find()
  *
@@ -1552,7 +1553,7 @@ public function create($data = array(), $filterKey = false) {
 /**
  * This function is a convenient wrapper class to create(false) and, as the name suggests, clears the id, data, and validation errors.
  *
- * @return always boolean TRUE upon success
+ * @return boolean Always true upon success
  * @see Model::create()
  */
 	public function clear() {
@@ -2777,7 +2778,7 @@ public function hasAny($conditions = null) {
  *
  * Used to perform find operations, where the first argument is type of find operation to perform
  * (all / first / count / neighbors / list / threaded),
- * second parameter options for finding ( indexed array, including: 'conditions', 'limit',
+ * second parameter options for finding (indexed array, including: 'conditions', 'limit',
  * 'recursive', 'page', 'fields', 'offset', 'order', 'callbacks')
  *
  * Eg:
@@ -3302,7 +3303,7 @@ public function validates($options = array()) {
  *
  * Additionally it populates the validationErrors property of the model with the same array.
  *
- * @param string $options An optional array of custom options to be made available in the beforeValidate callback
+ * @param array|string $options An optional array of custom options to be made available in the beforeValidate callback
  * @return array Array of invalid fields and their error messages
  * @see Model::validates()
  */