Permalink
Browse files

Fix docblocks.

  • Loading branch information...
1 parent 14228fa commit 1dbafe1d4f70b1cc7fb549733726f974c5483dc0 @majna majna committed Feb 17, 2012
@@ -153,7 +153,6 @@ public function cakeOnIncludePath() {
* Looks for a skeleton template of a Cake application,
* and if not found asks the user for a path. When there is a path
* this method will make a deep copy of the skeleton to the project directory.
- * A default home page will be added, and the tmp file storage will be chmod'ed to 0777.
*
* @param string $path Project path
* @param string $skel Path to copy from
@@ -467,8 +467,9 @@ public function generateConstructor($type, $fullClassName) {
* Generate the uses() calls for a type & classname
*
* @param string $type The Type of object you are generating tests for eg. controller
+ * @param string $realType The package name for the class.
* @param string $className The Classname of the class the test is being generated for.
- * @return array Constructor snippets for the thing you are building.
+ * @return array An array containing used classes
*/
public function generateUses($type, $realType, $className) {
$uses = array();
@@ -391,9 +391,9 @@ public function rawQuery($sql, $params = array()) {
*
* - log - Whether or not the query should be logged to the memory log.
*
- * @param string $sql
+ * @param string $sql SQL statement
* @param array $options
- * @param array $params values to be bided to the query
+ * @param array $params values to be bound to the query
* @return mixed Resource or object representing the result set, or false on failure
*/
public function execute($sql, $options = array(), $params = array()) {
@@ -892,6 +892,7 @@ public function showLog($sorted = false) {
* Log given SQL query.
*
* @param string $sql SQL statement
+ * @param array $params Values binded to the query (prepared statements)
* @return void
*/
public function logQuery($sql, $params = array()) {
@@ -745,7 +745,7 @@ public function implementedEvents() {
/**
* Returns the CakeEventManager manager instance that is handling any callbacks.
* You can use this instance to register any new listeners or callbacks to the
- * controller events, or create your own events and trigger them at will.
+ * model events, or create your own events and trigger them at will.
*
* @return CakeEventManager
*/
@@ -2994,7 +2994,7 @@ public function query($sql) {
*
* Will validate the currently set data. Use Model::set() or Model::create() to set the active data.
*
- * @param string $options An optional array of custom options to be made available in the beforeValidate callback
+ * @param array $options An optional array of custom options to be made available in the beforeValidate callback
* @return boolean True if there are no errors
*/
public function validates($options = array()) {
@@ -947,7 +947,8 @@ public function config($config = null) {
/**
* Send an email using the specified content, template and layout
- *
+ *
+ * @param mixed $content String with message or array with messages
* @return array
* @throws SocketException
*/
@@ -538,7 +538,7 @@ protected function _mapOptions($method, $options) {
*
* @param string $method Name of the method you are preparing callbacks for.
* @param array $options Array of options being parsed
- * @param string $callbacks Additional Keys that contain callbacks
+ * @param array $callbacks Additional Keys that contain callbacks
* @return array Array of options with callbacks added.
*/
protected function _prepareCallbacks($method, $options, $callbacks = array()) {

0 comments on commit 1dbafe1

Please sign in to comment.