Skip to content

Commit

Permalink
Correct doc blocks according to cs guidelines.
Browse files Browse the repository at this point in the history
Remove superfluous empty lines.
  • Loading branch information
euromark committed Jul 3, 2014
1 parent 65d14c7 commit 974ca85
Show file tree
Hide file tree
Showing 271 changed files with 1,383 additions and 1,528 deletions.
3 changes: 1 addition & 2 deletions app/Config/Schema/db_acl.php
Expand Up @@ -19,7 +19,6 @@
*/

/**
*
* Using the Schema command line utility
* cake schema run create DbAcl
*
Expand All @@ -30,7 +29,7 @@ class DbAclSchema extends CakeSchema {
* Before event.
*
* @param array $event The event data.
* @return boolean success
* @return bool success
*/
public function before($event = array()) {
return true;
Expand Down
1 change: 0 additions & 1 deletion app/Config/Schema/i18n.php
Expand Up @@ -19,7 +19,6 @@
*/

/**
*
* Using the Schema command line utility
*
* Use it to configure database for i18n
Expand Down
1 change: 0 additions & 1 deletion app/Config/core.php
Expand Up @@ -278,7 +278,6 @@
//Configure::write('Config.timezone', 'Europe/Paris');

/**
*
* Cache Engine Configuration
* Default settings provided below
*
Expand Down
2 changes: 0 additions & 2 deletions app/View/Emails/html/default.ctp
@@ -1,7 +1,5 @@
<?php
/**
*
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
Expand Down
2 changes: 0 additions & 2 deletions app/View/Emails/text/default.ctp
@@ -1,7 +1,5 @@
<?php
/**
*
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
Expand Down
2 changes: 0 additions & 2 deletions app/View/Errors/error400.ctp
@@ -1,7 +1,5 @@
<?php
/**
*
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
Expand Down
2 changes: 0 additions & 2 deletions app/View/Errors/error500.ctp
@@ -1,7 +1,5 @@
<?php
/**
*
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
Expand Down
2 changes: 0 additions & 2 deletions app/View/Layouts/Emails/html/default.ctp
@@ -1,7 +1,5 @@
<?php
/**
*
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
Expand Down
2 changes: 0 additions & 2 deletions app/View/Layouts/Emails/text/default.ctp
@@ -1,7 +1,5 @@
<?php
/**
*
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
Expand Down
2 changes: 0 additions & 2 deletions app/View/Layouts/ajax.ctp
@@ -1,7 +1,5 @@
<?php
/**
*
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
Expand Down
2 changes: 0 additions & 2 deletions app/View/Layouts/default.ctp
@@ -1,7 +1,5 @@
<?php
/**
*
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
Expand Down
2 changes: 0 additions & 2 deletions app/View/Layouts/error.ctp
@@ -1,7 +1,5 @@
<?php
/**
*
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
Expand Down
2 changes: 0 additions & 2 deletions app/View/Layouts/flash.ctp
@@ -1,7 +1,5 @@
<?php
/**
*
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
Expand Down
2 changes: 0 additions & 2 deletions app/View/Pages/home.ctp
@@ -1,7 +1,5 @@
<?php
/**
*
*
* @link http://cakephp.org CakePHP(tm) Project
* @package app.View.Pages
* @since CakePHP(tm) v 0.10.0.1076
Expand Down
2 changes: 0 additions & 2 deletions app/index.php
@@ -1,7 +1,5 @@
<?php
/**
*
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
Expand Down
22 changes: 11 additions & 11 deletions lib/Cake/Cache/Cache.php
Expand Up @@ -160,7 +160,7 @@ public static function config($name = null, $settings = array()) {
* Finds and builds the instance of the required engine class.
*
* @param string $name Name of the config array that needs an engine instance built
* @return boolean
* @return bool
* @throws CacheException
*/
protected static function _buildEngine($name) {
Expand Down Expand Up @@ -201,7 +201,7 @@ public static function configured() {
* the Engine instance is also unset.
*
* @param string $name A currently configured cache config you wish to remove.
* @return boolean success of the removal, returns false when the config does not exist.
* @return bool success of the removal, returns false when the config does not exist.
*/
public static function drop($name) {
if (!isset(self::$_config[$name])) {
Expand Down Expand Up @@ -269,7 +269,7 @@ public static function set($settings = array(), $value = null, $config = 'defaul
* Permanently remove all expired and deleted data
*
* @param string $config [optional] The config name you wish to have garbage collected. Defaults to 'default'
* @param integer $expires [optional] An expires timestamp. Defaults to NULL
* @param int $expires [optional] An expires timestamp. Defaults to NULL
* @return void
*/
public static function gc($config = 'default', $expires = null) {
Expand All @@ -292,7 +292,7 @@ public static function gc($config = 'default', $expires = null) {
* @param string $key Identifier for the data
* @param mixed $value Data to be cached - anything except a resource
* @param string $config Optional string configuration name to write to. Defaults to 'default'
* @return boolean True if the data was successfully cached, false on failure
* @return bool True if the data was successfully cached, false on failure
*/
public static function write($key, $value, $config = 'default') {
$settings = self::settings($config);
Expand Down Expand Up @@ -362,7 +362,7 @@ public static function read($key, $config = 'default') {
* Increment a number under the key and return incremented value.
*
* @param string $key Identifier for the data
* @param integer $offset How much to add
* @param int $offset How much to add
* @param string $config Optional string configuration name. Defaults to 'default'
* @return mixed new value, or false if the data doesn't exist, is not integer,
* or if there was an error fetching it.
Expand Down Expand Up @@ -390,7 +390,7 @@ public static function increment($key, $offset = 1, $config = 'default') {
* Decrement a number under the key and return decremented value.
*
* @param string $key Identifier for the data
* @param integer $offset How much to subtract
* @param int $offset How much to subtract
* @param string $config Optional string configuration name. Defaults to 'default'
* @return mixed new value, or false if the data doesn't exist, is not integer,
* or if there was an error fetching it
Expand Down Expand Up @@ -429,7 +429,7 @@ public static function decrement($key, $offset = 1, $config = 'default') {
*
* @param string $key Identifier for the data
* @param string $config name of the configuration to use. Defaults to 'default'
* @return boolean True if the value was successfully deleted, false if it didn't exist or couldn't be removed
* @return bool True if the value was successfully deleted, false if it didn't exist or couldn't be removed
*/
public static function delete($key, $config = 'default') {
$settings = self::settings($config);
Expand All @@ -453,9 +453,9 @@ public static function delete($key, $config = 'default') {
/**
* Delete all keys from the cache.
*
* @param boolean $check if true will check expiration, otherwise delete all
* @param bool $check if true will check expiration, otherwise delete all
* @param string $config name of the configuration to use. Defaults to 'default'
* @return boolean True if the cache was successfully cleared, false otherwise
* @return bool True if the cache was successfully cleared, false otherwise
*/
public static function clear($check = false, $config = 'default') {
if (!self::isInitialized($config)) {
Expand All @@ -471,7 +471,7 @@ public static function clear($check = false, $config = 'default') {
*
* @param string $group name of the group to be cleared
* @param string $config name of the configuration to use. Defaults to 'default'
* @return boolean True if the cache group was successfully cleared, false otherwise
* @return bool True if the cache group was successfully cleared, false otherwise
*/
public static function clearGroup($group, $config = 'default') {
if (!self::isInitialized($config)) {
Expand All @@ -486,7 +486,7 @@ public static function clearGroup($group, $config = 'default') {
* Check if Cache has initialized a working config for the given name.
*
* @param string $config name of the configuration to use. Defaults to 'default'
* @return boolean Whether or not the config name has been initialized.
* @return bool Whether or not the config name has been initialized.
*/
public static function isInitialized($config = 'default') {
if (Configure::read('Cache.disable')) {
Expand Down
20 changes: 10 additions & 10 deletions lib/Cake/Cache/CacheEngine.php
Expand Up @@ -42,7 +42,7 @@ abstract class CacheEngine {
* Called automatically by the cache frontend
*
* @param array $settings Associative array of parameters for the engine
* @return boolean True if the engine has been successfully initialized, false if not
* @return bool True if the engine has been successfully initialized, false if not
*/
public function init($settings = array()) {
$settings += $this->settings + array(
Expand All @@ -67,7 +67,7 @@ public function init($settings = array()) {
*
* Permanently remove all expired and deleted data
*
* @param integer $expires [optional] An expires timestamp, invalidating all data before.
* @param int $expires [optional] An expires timestamp, invalidating all data before.
* @return void
*/
public function gc($expires = null) {
Expand All @@ -78,8 +78,8 @@ public function gc($expires = null) {
*
* @param string $key Identifier for the data
* @param mixed $value Data to be cached
* @param integer $duration How long to cache for.
* @return boolean True if the data was successfully cached, false on failure
* @param int $duration How long to cache for.
* @return bool True if the data was successfully cached, false on failure
*/
abstract public function write($key, $value, $duration);

Expand All @@ -95,7 +95,7 @@ abstract public function read($key);
* Increment a number under the key and return incremented value
*
* @param string $key Identifier for the data
* @param integer $offset How much to add
* @param int $offset How much to add
* @return New incremented value, false otherwise
*/
abstract public function increment($key, $offset = 1);
Expand All @@ -104,7 +104,7 @@ abstract public function increment($key, $offset = 1);
* Decrement a number under the key and return decremented value
*
* @param string $key Identifier for the data
* @param integer $offset How much to subtract
* @param int $offset How much to subtract
* @return New incremented value, false otherwise
*/
abstract public function decrement($key, $offset = 1);
Expand All @@ -113,15 +113,15 @@ abstract public function decrement($key, $offset = 1);
* Delete a key from the cache
*
* @param string $key Identifier for the data
* @return boolean True if the value was successfully deleted, false if it didn't exist or couldn't be removed
* @return bool True if the value was successfully deleted, false if it didn't exist or couldn't be removed
*/
abstract public function delete($key);

/**
* Delete all keys from the cache
*
* @param boolean $check if true will check expiration, otherwise delete all
* @return boolean True if the cache was successfully cleared, false otherwise
* @param bool $check if true will check expiration, otherwise delete all
* @return bool True if the cache was successfully cleared, false otherwise
*/
abstract public function clear($check);

Expand All @@ -131,7 +131,7 @@ abstract public function clear($check);
* the same result.
*
* @param string $group name of the group to be cleared
* @return boolean
* @return bool
*/
public function clearGroup($group) {
return false;
Expand Down
18 changes: 9 additions & 9 deletions lib/Cake/Cache/Engine/ApcEngine.php
Expand Up @@ -38,7 +38,7 @@ class ApcEngine extends CacheEngine {
* To reinitialize the settings call Cache::engine('EngineName', [optional] settings = array());
*
* @param array $settings array of setting for the engine
* @return boolean True if the engine has been successfully initialized, false if not
* @return bool True if the engine has been successfully initialized, false if not
* @see CacheEngine::__defaults
*/
public function init($settings = array()) {
Expand All @@ -55,8 +55,8 @@ public function init($settings = array()) {
*
* @param string $key Identifier for the data
* @param mixed $value Data to be cached
* @param integer $duration How long to cache the data, in seconds
* @return boolean True if the data was successfully cached, false on failure
* @param int $duration How long to cache the data, in seconds
* @return bool True if the data was successfully cached, false on failure
*/
public function write($key, $value, $duration) {
$expires = 0;
Expand Down Expand Up @@ -86,7 +86,7 @@ public function read($key) {
* Increments the value of an integer cached key
*
* @param string $key Identifier for the data
* @param integer $offset How much to increment
* @param int $offset How much to increment
* @return New incremented value, false otherwise
*/
public function increment($key, $offset = 1) {
Expand All @@ -97,7 +97,7 @@ public function increment($key, $offset = 1) {
* Decrements the value of an integer cached key
*
* @param string $key Identifier for the data
* @param integer $offset How much to subtract
* @param int $offset How much to subtract
* @return New decremented value, false otherwise
*/
public function decrement($key, $offset = 1) {
Expand All @@ -108,7 +108,7 @@ public function decrement($key, $offset = 1) {
* Delete a key from the cache
*
* @param string $key Identifier for the data
* @return boolean True if the value was successfully deleted, false if it didn't exist or couldn't be removed
* @return bool True if the value was successfully deleted, false if it didn't exist or couldn't be removed
*/
public function delete($key) {
return apc_delete($key);
Expand All @@ -117,9 +117,9 @@ public function delete($key) {
/**
* Delete all keys from the cache. This will clear every cache config using APC.
*
* @param boolean $check If true, nothing will be cleared, as entries are removed
* @param bool $check If true, nothing will be cleared, as entries are removed
* from APC as they expired. This flag is really only used by FileEngine.
* @return boolean True Returns true.
* @return bool True Returns true.
*/
public function clear($check) {
if ($check) {
Expand Down Expand Up @@ -181,7 +181,7 @@ public function groups() {
* old values will remain in storage until they expire.
*
* @param string $group The group to clear.
* @return boolean success
* @return bool success
*/
public function clearGroup($group) {
apc_inc($this->settings['prefix'] . $group, 1, $success);
Expand Down

0 comments on commit 974ca85

Please sign in to comment.