Browse Source

Explicitly add `@param` tags for overwritten methods instead of
relying on inheritance.

ndm2 12 years ago
parent
commit
3e034ab026

+ 1 - 0
src/Cache/Engine/ApcEngine.php

@@ -182,6 +182,7 @@ class ApcEngine extends CacheEngine {
  * 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) {

+ 1 - 0
src/Cache/Engine/FileEngine.php

@@ -425,6 +425,7 @@ class FileEngine extends CacheEngine {
 /**
  * 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) {

+ 1 - 0
src/Cache/Engine/MemcachedEngine.php

@@ -340,6 +340,7 @@ class MemcachedEngine extends CacheEngine {
  * 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) {

+ 1 - 0
src/Cache/Engine/RedisEngine.php

@@ -227,6 +227,7 @@ class RedisEngine extends CacheEngine {
  * 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) {

+ 1 - 0
src/Cache/Engine/WincacheEngine.php

@@ -189,6 +189,7 @@ class WincacheEngine extends CacheEngine {
  * 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) {

+ 1 - 0
src/Cache/Engine/XcacheEngine.php

@@ -184,6 +184,7 @@ class XcacheEngine extends CacheEngine {
  * 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) {

+ 3 - 0
src/Routing/Route/PluginShortRoute.php

@@ -44,6 +44,9 @@ class PluginShortRoute extends Route {
  * 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()) {

+ 2 - 0
src/TestSuite/ControllerTestCase.php

@@ -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) {

+ 2 - 0
src/View/Helper/NumberHelper.php

@@ -67,6 +67,8 @@ class NumberHelper extends Helper {
 /**
  * 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) {

+ 3 - 0
src/View/Helper/TextHelper.php

@@ -82,6 +82,9 @@ class TextHelper extends Helper {
 
 /**
  * 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) {

+ 2 - 0
src/View/Helper/TimeHelper.php

@@ -66,6 +66,8 @@ class TimeHelper extends Helper {
 /**
  * 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) {