correct return types in doc blocks

This commit is contained in:
euromark 2013-07-05 17:19:22 +02:00
parent ba02678693
commit af455b4121
14 changed files with 18 additions and 8 deletions

View file

@ -247,6 +247,7 @@ class ExtractTask extends AppShell {
* @param string $domain * @param string $domain
* @param string $msgid * @param string $msgid
* @param array $details * @param array $details
* @return void
*/ */
protected function _addTranslation($domain, $msgid, $details = array()) { protected function _addTranslation($domain, $msgid, $details = array()) {
if (empty($this->_translations[$domain][$msgid])) { if (empty($this->_translations[$domain][$msgid])) {

View file

@ -96,6 +96,7 @@ class ConsoleErrorHandler {
* Wrapper for exit(), used for testing. * Wrapper for exit(), used for testing.
* *
* @param int $code The exit code. * @param int $code The exit code.
* @return void
*/ */
protected function _stop($code = 0) { protected function _stop($code = 0) {
exit($code); exit($code);

View file

@ -28,6 +28,7 @@ interface AclInterface {
* @param string $aro ARO The requesting object identifier. * @param string $aro ARO The requesting object identifier.
* @param string $aco ACO The controlled object identifier. * @param string $aco ACO The controlled object identifier.
* @param string $action Action (defaults to *) * @param string $action Action (defaults to *)
* @return boolean Success
*/ */
public function check($aro, $aco, $action = "*"); public function check($aro, $aco, $action = "*");
@ -65,6 +66,7 @@ interface AclInterface {
* Initialization method for the Acl implementation * Initialization method for the Acl implementation
* *
* @param AclComponent $component * @param AclComponent $component
* @return void
*/ */
public function initialize(Component $component); public function initialize(Component $component);

View file

@ -628,6 +628,7 @@ class TranslateBehavior extends ModelBehavior {
* *
* @param Model $Model Model instance * @param Model $Model Model instance
* @param string $field The field to update. * @param string $field The field to update.
* @return void
*/ */
protected function _removeField(Model $Model, $field) { protected function _removeField(Model $Model, $field) {
if (array_key_exists($field, $this->settings[$Model->alias])) { if (array_key_exists($field, $this->settings[$Model->alias])) {

View file

@ -331,6 +331,7 @@ class CakeValidationSet implements ArrayAccess, IteratorAggregate, Countable {
* *
* @param string $index name of the rule * @param string $index name of the rule
* @param CakeValidationRule|array rule to add to $index * @param CakeValidationRule|array rule to add to $index
* @return void
*/ */
public function offsetSet($index, $rule) { public function offsetSet($index, $rule) {
$this->setRule($index, $rule); $this->setRule($index, $rule);

View file

@ -186,6 +186,7 @@ class CakeSocket {
* *
* @param int $code * @param int $code
* @param string $message * @param string $message
* @return void
*/ */
protected function _connectionErrorHandler($code, $message) { protected function _connectionErrorHandler($code, $message) {
$this->_connectionErrors[] = $message; $this->_connectionErrors[] = $message;

View file

@ -447,7 +447,7 @@ class ConfigureTest extends CakeTestCase {
/** /**
* Test dumping only some of the data. * Test dumping only some of the data.
* *
* @return * @return void
*/ */
public function testDumpPartial() { public function testDumpPartial() {
Configure::config('test_reader', new PhpReader(TMP)); Configure::config('test_reader', new PhpReader(TMP));

View file

@ -194,7 +194,7 @@ class I18nTest extends CakeTestCase {
/** /**
* Assertions for rules zero. * Assertions for rules zero.
* *
* @return * @return void
*/ */
public function assertRulesZero() { public function assertRulesZero() {
$singular = $this->__singular(); $singular = $this->__singular();

View file

@ -2508,7 +2508,7 @@ class MysqlTest extends CakeTestCase {
/** /**
* Test that array conditions with only one element work. * Test that array conditions with only one element work.
* *
* @return * @return void
*/ */
public function testArrayConditionsOneElement() { public function testArrayConditionsOneElement() {
$conditions = array('id' => array(1)); $conditions = array('id' => array(1));

View file

@ -3765,7 +3765,7 @@ class ModelReadTest extends BaseModelTest {
/** /**
* Test find(neighbors) with missing fields so no neighbors are found. * Test find(neighbors) with missing fields so no neighbors are found.
* *
* @return * @return void
*/ */
public function testFindNeighborsNoPrev() { public function testFindNeighborsNoPrev() {
$this->loadFixtures('User', 'Article', 'Comment', 'Tag', 'ArticlesTag', 'Attachment'); $this->loadFixtures('User', 'Article', 'Comment', 'Tag', 'ArticlesTag', 'Attachment');
@ -3786,6 +3786,7 @@ class ModelReadTest extends BaseModelTest {
); );
$this->assertEquals($expected, $result); $this->assertEquals($expected, $result);
} }
/** /**
* testFindCombinedRelations method * testFindCombinedRelations method
* *

View file

@ -265,7 +265,7 @@ class SecurityTest extends CakeTestCase {
/** /**
* Test that rijndael() can still decrypt values with a fixed iv. * Test that rijndael() can still decrypt values with a fixed iv.
* *
* @return * @return void
*/ */
public function testRijndaelBackwardCompatibility() { public function testRijndaelBackwardCompatibility() {
$this->skipIf(!function_exists('mcrypt_encrypt')); $this->skipIf(!function_exists('mcrypt_encrypt'));

View file

@ -309,7 +309,7 @@ class HelperTest extends CakeTestCase {
/** /**
* test setEntity with setting a scope. * test setEntity with setting a scope.
* *
* @return * @return void
*/ */
public function testSetEntityScoped() { public function testSetEntityScoped() {
$this->Helper->setEntity('HelperTestPost', true); $this->Helper->setEntity('HelperTestPost', true);

View file

@ -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 * @return string The serialized data
*/ */
protected function _serialize($serialize) { protected function _serialize($serialize) {

View file

@ -68,6 +68,7 @@ if (!function_exists('debug')) {
* @param boolean $var Variable to show debug information for. * @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 $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. * @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/development/debugging.html#basic-debugging
* @link http://book.cakephp.org/2.0/en/core-libraries/global-constants-and-functions.html#debug * @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() * @see debug()
* @param array $var Variable to print out * @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 * @link http://book.cakephp.org/2.0/en/core-libraries/global-constants-and-functions.html#pr
*/ */
function pr($var) { function pr($var) {