From af455b41214f240a40c6805bc74d0d0b0cfbc7ab Mon Sep 17 00:00:00 2001 From: euromark Date: Fri, 5 Jul 2013 17:19:22 +0200 Subject: [PATCH] correct return types in doc blocks --- lib/Cake/Console/Command/Task/ExtractTask.php | 1 + lib/Cake/Console/ConsoleErrorHandler.php | 1 + lib/Cake/Controller/Component/Acl/AclInterface.php | 2 ++ lib/Cake/Model/Behavior/TranslateBehavior.php | 1 + lib/Cake/Model/Validator/CakeValidationSet.php | 1 + lib/Cake/Network/CakeSocket.php | 1 + lib/Cake/Test/Case/Core/ConfigureTest.php | 2 +- lib/Cake/Test/Case/I18n/I18nTest.php | 2 +- lib/Cake/Test/Case/Model/Datasource/Database/MysqlTest.php | 2 +- lib/Cake/Test/Case/Model/ModelReadTest.php | 3 ++- lib/Cake/Test/Case/Utility/SecurityTest.php | 2 +- lib/Cake/Test/Case/View/HelperTest.php | 2 +- lib/Cake/View/XmlView.php | 4 ++-- lib/Cake/basics.php | 2 ++ 14 files changed, 18 insertions(+), 8 deletions(-) diff --git a/lib/Cake/Console/Command/Task/ExtractTask.php b/lib/Cake/Console/Command/Task/ExtractTask.php index 4648c1e47..fbc963894 100644 --- a/lib/Cake/Console/Command/Task/ExtractTask.php +++ b/lib/Cake/Console/Command/Task/ExtractTask.php @@ -247,6 +247,7 @@ class ExtractTask extends AppShell { * @param string $domain * @param string $msgid * @param array $details + * @return void */ protected function _addTranslation($domain, $msgid, $details = array()) { if (empty($this->_translations[$domain][$msgid])) { diff --git a/lib/Cake/Console/ConsoleErrorHandler.php b/lib/Cake/Console/ConsoleErrorHandler.php index 1165031d9..e249ccfe3 100644 --- a/lib/Cake/Console/ConsoleErrorHandler.php +++ b/lib/Cake/Console/ConsoleErrorHandler.php @@ -96,6 +96,7 @@ class ConsoleErrorHandler { * Wrapper for exit(), used for testing. * * @param int $code The exit code. + * @return void */ protected function _stop($code = 0) { exit($code); diff --git a/lib/Cake/Controller/Component/Acl/AclInterface.php b/lib/Cake/Controller/Component/Acl/AclInterface.php index 6ad29ae47..f6794e9e2 100644 --- a/lib/Cake/Controller/Component/Acl/AclInterface.php +++ b/lib/Cake/Controller/Component/Acl/AclInterface.php @@ -28,6 +28,7 @@ interface AclInterface { * @param string $aro ARO The requesting object identifier. * @param string $aco ACO The controlled object identifier. * @param string $action Action (defaults to *) + * @return boolean Success */ public function check($aro, $aco, $action = "*"); @@ -65,6 +66,7 @@ interface AclInterface { * Initialization method for the Acl implementation * * @param AclComponent $component + * @return void */ public function initialize(Component $component); diff --git a/lib/Cake/Model/Behavior/TranslateBehavior.php b/lib/Cake/Model/Behavior/TranslateBehavior.php index eff7b4060..1335f06a8 100644 --- a/lib/Cake/Model/Behavior/TranslateBehavior.php +++ b/lib/Cake/Model/Behavior/TranslateBehavior.php @@ -628,6 +628,7 @@ class TranslateBehavior extends ModelBehavior { * * @param Model $Model Model instance * @param string $field The field to update. + * @return void */ protected function _removeField(Model $Model, $field) { if (array_key_exists($field, $this->settings[$Model->alias])) { diff --git a/lib/Cake/Model/Validator/CakeValidationSet.php b/lib/Cake/Model/Validator/CakeValidationSet.php index 208d0582a..e17e0213a 100644 --- a/lib/Cake/Model/Validator/CakeValidationSet.php +++ b/lib/Cake/Model/Validator/CakeValidationSet.php @@ -331,6 +331,7 @@ class CakeValidationSet implements ArrayAccess, IteratorAggregate, Countable { * * @param string $index name of the rule * @param CakeValidationRule|array rule to add to $index + * @return void */ public function offsetSet($index, $rule) { $this->setRule($index, $rule); diff --git a/lib/Cake/Network/CakeSocket.php b/lib/Cake/Network/CakeSocket.php index 43f5318c4..3fcebad6e 100644 --- a/lib/Cake/Network/CakeSocket.php +++ b/lib/Cake/Network/CakeSocket.php @@ -186,6 +186,7 @@ class CakeSocket { * * @param int $code * @param string $message + * @return void */ protected function _connectionErrorHandler($code, $message) { $this->_connectionErrors[] = $message; diff --git a/lib/Cake/Test/Case/Core/ConfigureTest.php b/lib/Cake/Test/Case/Core/ConfigureTest.php index 0376632cf..65e7717ca 100644 --- a/lib/Cake/Test/Case/Core/ConfigureTest.php +++ b/lib/Cake/Test/Case/Core/ConfigureTest.php @@ -447,7 +447,7 @@ class ConfigureTest extends CakeTestCase { /** * Test dumping only some of the data. * - * @return + * @return void */ public function testDumpPartial() { Configure::config('test_reader', new PhpReader(TMP)); diff --git a/lib/Cake/Test/Case/I18n/I18nTest.php b/lib/Cake/Test/Case/I18n/I18nTest.php index ff4f562ff..80303e2c5 100644 --- a/lib/Cake/Test/Case/I18n/I18nTest.php +++ b/lib/Cake/Test/Case/I18n/I18nTest.php @@ -194,7 +194,7 @@ class I18nTest extends CakeTestCase { /** * Assertions for rules zero. * - * @return + * @return void */ public function assertRulesZero() { $singular = $this->__singular(); diff --git a/lib/Cake/Test/Case/Model/Datasource/Database/MysqlTest.php b/lib/Cake/Test/Case/Model/Datasource/Database/MysqlTest.php index 29a8bc671..2fd7bed05 100644 --- a/lib/Cake/Test/Case/Model/Datasource/Database/MysqlTest.php +++ b/lib/Cake/Test/Case/Model/Datasource/Database/MysqlTest.php @@ -2508,7 +2508,7 @@ class MysqlTest extends CakeTestCase { /** * Test that array conditions with only one element work. * - * @return + * @return void */ public function testArrayConditionsOneElement() { $conditions = array('id' => array(1)); diff --git a/lib/Cake/Test/Case/Model/ModelReadTest.php b/lib/Cake/Test/Case/Model/ModelReadTest.php index 620afcd5d..0ecbec7e8 100644 --- a/lib/Cake/Test/Case/Model/ModelReadTest.php +++ b/lib/Cake/Test/Case/Model/ModelReadTest.php @@ -3765,7 +3765,7 @@ class ModelReadTest extends BaseModelTest { /** * Test find(neighbors) with missing fields so no neighbors are found. * - * @return + * @return void */ public function testFindNeighborsNoPrev() { $this->loadFixtures('User', 'Article', 'Comment', 'Tag', 'ArticlesTag', 'Attachment'); @@ -3786,6 +3786,7 @@ class ModelReadTest extends BaseModelTest { ); $this->assertEquals($expected, $result); } + /** * testFindCombinedRelations method * diff --git a/lib/Cake/Test/Case/Utility/SecurityTest.php b/lib/Cake/Test/Case/Utility/SecurityTest.php index 850042985..f1a0e33f8 100644 --- a/lib/Cake/Test/Case/Utility/SecurityTest.php +++ b/lib/Cake/Test/Case/Utility/SecurityTest.php @@ -265,7 +265,7 @@ class SecurityTest extends CakeTestCase { /** * Test that rijndael() can still decrypt values with a fixed iv. * - * @return + * @return void */ public function testRijndaelBackwardCompatibility() { $this->skipIf(!function_exists('mcrypt_encrypt')); diff --git a/lib/Cake/Test/Case/View/HelperTest.php b/lib/Cake/Test/Case/View/HelperTest.php index af95a8549..e3d6db33c 100644 --- a/lib/Cake/Test/Case/View/HelperTest.php +++ b/lib/Cake/Test/Case/View/HelperTest.php @@ -309,7 +309,7 @@ class HelperTest extends CakeTestCase { /** * test setEntity with setting a scope. * - * @return + * @return void */ public function testSetEntityScoped() { $this->Helper->setEntity('HelperTestPost', true); diff --git a/lib/Cake/View/XmlView.php b/lib/Cake/View/XmlView.php index e77698eec..6fcfb0b3f 100644 --- a/lib/Cake/View/XmlView.php +++ b/lib/Cake/View/XmlView.php @@ -94,9 +94,9 @@ class XmlView extends View { } /** - * Serialize view vars + * Serialize view vars. * - * @param array $serialize The viewVars that need to be serialized + * @param array $serialize The viewVars that need to be serialized. * @return string The serialized data */ protected function _serialize($serialize) { diff --git a/lib/Cake/basics.php b/lib/Cake/basics.php index 816f42794..ebeff8c1b 100644 --- a/lib/Cake/basics.php +++ b/lib/Cake/basics.php @@ -68,6 +68,7 @@ if (!function_exists('debug')) { * @param boolean $var Variable to show debug information for. * @param boolean $showHtml If set to true, the method prints the debug data in a browser-friendly way. * @param boolean $showFrom If set to true, the method prints from where the function was called. + * @return void * @link http://book.cakephp.org/2.0/en/development/debugging.html#basic-debugging * @link http://book.cakephp.org/2.0/en/core-libraries/global-constants-and-functions.html#debug */ @@ -235,6 +236,7 @@ if (!function_exists('pr')) { * * @see debug() * @param array $var Variable to print out + * @return void * @link http://book.cakephp.org/2.0/en/core-libraries/global-constants-and-functions.html#pr */ function pr($var) {