Skip to content

Commit

Permalink
Explicitly add @param tags for overwritten methods instead of
Browse files Browse the repository at this point in the history
relying on inheritance.
  • Loading branch information
ndm2 committed Feb 22, 2014
1 parent 166ecc2 commit 3e034ab
Show file tree
Hide file tree
Showing 11 changed files with 18 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/Cache/Engine/ApcEngine.php
Expand Up @@ -182,6 +182,7 @@ public function groups() {
* Increments the group value to simulate deletion of all keys under a group
* old values will remain in storage until they expire.
*
* @param string $group name of the group to be cleared
* @return boolean success
*/
public function clearGroup($group) {
Expand Down
1 change: 1 addition & 0 deletions src/Cache/Engine/FileEngine.php
Expand Up @@ -425,6 +425,7 @@ public function key($key) {
/**
* Recursively deletes all files under any directory named as $group
*
* @param string $group name of the group to be cleared
* @return boolean success
*/
public function clearGroup($group) {
Expand Down
1 change: 1 addition & 0 deletions src/Cache/Engine/MemcachedEngine.php
Expand Up @@ -340,6 +340,7 @@ public function groups() {
* Increments the group value to simulate deletion of all keys under a group
* old values will remain in storage until they expire.
*
* @param string $group name of the group to be cleared
* @return boolean success
*/
public function clearGroup($group) {
Expand Down
1 change: 1 addition & 0 deletions src/Cache/Engine/RedisEngine.php
Expand Up @@ -227,6 +227,7 @@ public function groups() {
* Increments the group value to simulate deletion of all keys under a group
* old values will remain in storage until they expire.
*
* @param string $group name of the group to be cleared
* @return boolean success
*/
public function clearGroup($group) {
Expand Down
1 change: 1 addition & 0 deletions src/Cache/Engine/WincacheEngine.php
Expand Up @@ -189,6 +189,7 @@ public function groups() {
* Increments the group value to simulate deletion of all keys under a group
* old values will remain in storage until they expire.
*
* @param string $group name of the group to be cleared
* @return boolean success
*/
public function clearGroup($group) {
Expand Down
1 change: 1 addition & 0 deletions src/Cache/Engine/XcacheEngine.php
Expand Up @@ -184,6 +184,7 @@ public function groups() {
* Increments the group value to simulate deletion of all keys under a group
* old values will remain in storage until they expire.
*
* @param string $group name of the group to be cleared
* @return boolean success
*/
public function clearGroup($group) {
Expand Down
3 changes: 3 additions & 0 deletions src/Routing/Route/PluginShortRoute.php
Expand Up @@ -44,6 +44,9 @@ public function parse($url) {
* are not the same the match is an auto fail.
*
* @param array $url Array of parameters to convert to a string.
* @param array $context An array of the current request context.
* Contains information such as the current host, scheme, port, and base
* directory.
* @return mixed either false or a string URL.
*/
public function match($url, $context = array()) {
Expand Down
2 changes: 2 additions & 0 deletions src/TestSuite/ControllerTestCase.php
Expand Up @@ -47,6 +47,8 @@ class ControllerTestDispatcher extends Dispatcher {
/**
* Returns the test controller
*
* @param \Cake\Network\Request $request Request object
* @param \Cake\Network\Response $response Response for the controller.
* @return Controller
*/
protected function _getController($request, $response) {
Expand Down
2 changes: 2 additions & 0 deletions src/View/Helper/NumberHelper.php
Expand Up @@ -67,6 +67,8 @@ public function __construct(View $View, $settings = array()) {
/**
* Call methods from Cake\Utility\Number utility class
*
* @param string $method Method to invoke
* @param array $params Array of params for the method.
* @return mixed Whatever is returned by called method, or false on failure
*/
public function __call($method, $params) {
Expand Down
3 changes: 3 additions & 0 deletions src/View/Helper/TextHelper.php
Expand Up @@ -82,6 +82,9 @@ public function __construct(View $View, $settings = array()) {

/**
* Call methods from String utility class
*
* @param string $method Method to invoke
* @param array $params Array of params for the method.
* @return mixed Whatever is returned by called method, or false on failure
*/
public function __call($method, $params) {
Expand Down
2 changes: 2 additions & 0 deletions src/View/Helper/TimeHelper.php
Expand Up @@ -66,6 +66,8 @@ public function __construct(View $View, $settings = array()) {
/**
* Call methods from Cake\Utility\Time utility class
*
* @param string $method Method to invoke
* @param array $params Array of params for the method.
* @return mixed Whatever is returned by called method, or false on failure
*/
public function __call($method, $params) {
Expand Down

0 comments on commit 3e034ab

Please sign in to comment.