diff --git a/lib/Cake/Console/Command/CommandListShell.php b/lib/Cake/Console/Command/CommandListShell.php index 755166f41..ca6620a5b 100644 --- a/lib/Cake/Console/Command/CommandListShell.php +++ b/lib/Cake/Console/Command/CommandListShell.php @@ -77,7 +77,7 @@ class CommandListShell extends AppShell { /** * Output text. * - * @param array $shellList + * @param array $shellList The shell list. * @return void */ protected function _asText($shellList) { @@ -95,7 +95,7 @@ class CommandListShell extends AppShell { /** * Output as XML * - * @param array $shellList + * @param array $shellList The shell list. * @return void */ protected function _asXml($shellList) { diff --git a/lib/Cake/Console/Command/CompletionShell.php b/lib/Cake/Console/Command/CompletionShell.php index b57c84145..57e86f949 100644 --- a/lib/Cake/Console/Command/CompletionShell.php +++ b/lib/Cake/Console/Command/CompletionShell.php @@ -144,7 +144,7 @@ class CompletionShell extends AppShell { /** * Emit results as a string, space delimited * - * @param array $options + * @param array $options The options to output * @return void */ protected function _output($options = array()) { diff --git a/lib/Cake/Console/Command/ConsoleShell.php b/lib/Cake/Console/Command/ConsoleShell.php index 8134a638e..a40381459 100644 --- a/lib/Cake/Console/Command/ConsoleShell.php +++ b/lib/Cake/Console/Command/ConsoleShell.php @@ -193,7 +193,7 @@ class ConsoleShell extends AppShell { /** * Override main() to handle action * - * @param string $command + * @param string $command The command to run. * @return void */ public function main($command = null) { @@ -218,7 +218,7 @@ class ConsoleShell extends AppShell { /** * Determine the method to process the current command * - * @param string $command + * @param string $command The command to run. * @return string or false */ protected function _method($command) { @@ -256,7 +256,7 @@ class ConsoleShell extends AppShell { /** * Bind an association * - * @param mixed $command + * @param mixed $command The command to run. * @return void */ protected function _bind($command) { @@ -283,7 +283,7 @@ class ConsoleShell extends AppShell { /** * Unbind an association * - * @param mixed $command + * @param mixed $command The command to run. * @return void */ protected function _unbind($command) { @@ -320,7 +320,7 @@ class ConsoleShell extends AppShell { /** * Perform a find * - * @param mixed $command + * @param mixed $command The command to run. * @return void */ protected function _find($command) { @@ -382,7 +382,7 @@ class ConsoleShell extends AppShell { /** * Save a record * - * @param mixed $command + * @param mixed $command The command to run. * @return void */ protected function _save($command) { @@ -406,7 +406,7 @@ class ConsoleShell extends AppShell { /** * Show the columns for a model * - * @param mixed $command + * @param mixed $command The command to run. * @return void */ protected function _columns($command) { @@ -455,7 +455,7 @@ class ConsoleShell extends AppShell { /** * Parse an array URL and show the equivalent URL as a string * - * @param mixed $command + * @param mixed $command The command to run. * @return void */ protected function _routeToString($command) { @@ -471,7 +471,7 @@ class ConsoleShell extends AppShell { /** * Parse a string URL and show as an array * - * @param mixed $command + * @param mixed $command The command to run. * @return void */ protected function _routeToArray($command) { @@ -483,7 +483,7 @@ class ConsoleShell extends AppShell { /** * Tells if the specified model is included in the list of available models * - * @param string $modelToCheck + * @param string $modelToCheck The model to check. * @return boolean true if is an available model, false otherwise */ protected function _isValidModel($modelToCheck) { diff --git a/lib/Cake/Console/Command/SchemaShell.php b/lib/Cake/Console/Command/SchemaShell.php index 6df8a32ea..ded5f2e05 100644 --- a/lib/Cake/Console/Command/SchemaShell.php +++ b/lib/Cake/Console/Command/SchemaShell.php @@ -311,8 +311,8 @@ class SchemaShell extends AppShell { * Create database from Schema object * Should be called via the run method * - * @param CakeSchema $Schema - * @param string $table + * @param CakeSchema $Schema The schema instance to create. + * @param string $table The table name. * @return void */ protected function _create(CakeSchema $Schema, $table = null) { @@ -362,8 +362,8 @@ class SchemaShell extends AppShell { * Update database with Schema object * Should be called via the run method * - * @param CakeSchema $Schema - * @param string $table + * @param CakeSchema &$Schema The schema instance + * @param string $table The table name. * @return void */ protected function _update(&$Schema, $table = null) { @@ -417,9 +417,9 @@ class SchemaShell extends AppShell { /** * Runs sql from _create() or _update() * - * @param array $contents - * @param string $event - * @param CakeSchema $Schema + * @param array $contents The contents to execute. + * @param string $event The event to fire + * @param CakeSchema $Schema The schema instance. * @return void */ protected function _run($contents, $event, CakeSchema $Schema) { diff --git a/lib/Cake/Console/Command/Task/CommandTask.php b/lib/Cake/Console/Command/Task/CommandTask.php index 9c90fc6be..fca006a72 100644 --- a/lib/Cake/Console/Command/Task/CommandTask.php +++ b/lib/Cake/Console/Command/Task/CommandTask.php @@ -53,9 +53,9 @@ class CommandTask extends AppShell { /** * Scan the provided paths for shells, and append them into $shellList * - * @param string $type - * @param array $shells - * @param array $shellList + * @param string $type The type of object. + * @param array $shells The shell name. + * @param array &$shellList List of shells. * @return void */ protected function _appendShells($type, $shells, &$shellList) { @@ -90,7 +90,7 @@ class CommandTask extends AppShell { /** * Return a list of subcommands for a given command * - * @param string $commandName + * @param string $commandName The command you want subcommands from. * @return array */ public function subCommands($commandName) { @@ -127,7 +127,7 @@ class CommandTask extends AppShell { /** * Get Shell instance for the given command * - * @param mixed $commandName + * @param mixed $commandName The command you want. * @return mixed */ public function getShell($commandName) { @@ -157,7 +157,7 @@ class CommandTask extends AppShell { /** * Get Shell instance for the given command * - * @param mixed $commandName + * @param mixed $commandName The command to get options for. * @return array */ public function options($commandName) { diff --git a/lib/Cake/Console/Command/Task/ControllerTask.php b/lib/Cake/Console/Command/Task/ControllerTask.php index 5a4553466..831aeff61 100644 --- a/lib/Cake/Console/Command/Task/ControllerTask.php +++ b/lib/Cake/Console/Command/Task/ControllerTask.php @@ -224,10 +224,10 @@ class ControllerTask extends BakeTask { /** * Confirm a to be baked controller with the user * - * @param string $controllerName - * @param string $useDynamicScaffold - * @param array $helpers - * @param array $components + * @param string $controllerName The name of the controller. + * @param string $useDynamicScaffold Whether or not to use dynamic scaffolds. + * @param array $helpers The list of helpers to include. + * @param array $components The list of components to include. * @return void */ public function confirmController($controllerName, $useDynamicScaffold, $helpers, $components) { diff --git a/lib/Cake/Console/Command/Task/DbConfigTask.php b/lib/Cake/Console/Command/Task/DbConfigTask.php index 737d2cec7..f202b89df 100644 --- a/lib/Cake/Console/Command/Task/DbConfigTask.php +++ b/lib/Cake/Console/Command/Task/DbConfigTask.php @@ -199,7 +199,7 @@ class DbConfigTask extends AppShell { /** * Output verification message and bake if it looks good * - * @param array $config + * @param array $config The config data. * @return boolean True if user says it looks good, false otherwise */ protected function _verify($config) { diff --git a/lib/Cake/Console/Command/Task/ExtractTask.php b/lib/Cake/Console/Command/Task/ExtractTask.php index 794fe2134..4986960e6 100644 --- a/lib/Cake/Console/Command/Task/ExtractTask.php +++ b/lib/Cake/Console/Command/Task/ExtractTask.php @@ -242,10 +242,10 @@ class ExtractTask extends AppShell { * * Takes care of duplicate translations * - * @param string $category - * @param string $domain - * @param string $msgid - * @param array $details + * @param string $category The category + * @param string $domain The domain + * @param string $msgid The message string + * @param array $details The file and line references * @return void */ protected function _addTranslation($category, $domain, $msgid, $details = array()) { @@ -582,10 +582,10 @@ class ExtractTask extends AppShell { /** * Prepare a file to be stored * - * @param string $category - * @param string $domain - * @param string $header - * @param string $sentence + * @param string $category The category + * @param string $domain The domain + * @param string $header The header content. + * @param string $sentence The sentence to store. * @return void */ protected function _store($category, $domain, $header, $sentence) { @@ -678,7 +678,7 @@ class ExtractTask extends AppShell { /** * Get the strings from the position forward * - * @param integer $position Actual position on tokens array + * @param integer &$position Actual position on tokens array * @param integer $target Number of strings to extract * @return array Strings extracted */ diff --git a/lib/Cake/Console/Command/Task/FixtureTask.php b/lib/Cake/Console/Command/Task/FixtureTask.php index 0be6d36dd..519bea29c 100644 --- a/lib/Cake/Console/Command/Task/FixtureTask.php +++ b/lib/Cake/Console/Command/Task/FixtureTask.php @@ -316,7 +316,7 @@ class FixtureTask extends BakeTask { * Generate String representation of Records * * @param array $tableInfo Table schema array - * @param integer $recordCount + * @param integer $recordCount The number of records to generate. * @return array Array of records to use in the fixture. */ protected function _generateRecords($tableInfo, $recordCount = 1) { diff --git a/lib/Cake/Console/Command/Task/ModelTask.php b/lib/Cake/Console/Command/Task/ModelTask.php index 9f7935e7c..ae1e137ed 100644 --- a/lib/Cake/Console/Command/Task/ModelTask.php +++ b/lib/Cake/Console/Command/Task/ModelTask.php @@ -401,7 +401,7 @@ class ModelTask extends BakeTask { * * @param string $fieldName Name of field to be validated. * @param array $metaData metadata for field - * @param string $primaryKey + * @param string $primaryKey The primary key field. * @return array Array of validation for the field. */ public function fieldValidation($fieldName, $metaData, $primaryKey = 'id') { @@ -510,7 +510,7 @@ class ModelTask extends BakeTask { /** * Handles associations * - * @param Model $model + * @param Model $model The model object * @return array Associations */ public function doAssociations($model) { @@ -562,7 +562,7 @@ class ModelTask extends BakeTask { /** * Handles behaviors * - * @param Model $model + * @param Model $model The model object. * @return array Behaviors */ public function doActsAs($model) { diff --git a/lib/Cake/Console/Command/Task/PluginTask.php b/lib/Cake/Console/Command/Task/PluginTask.php index e37e437c3..760ed9145 100644 --- a/lib/Cake/Console/Command/Task/PluginTask.php +++ b/lib/Cake/Console/Command/Task/PluginTask.php @@ -73,7 +73,7 @@ class PluginTask extends AppShell { /** * Interactive interface * - * @param string $plugin + * @param string $plugin The plugin name. * @return void */ protected function _interactive($plugin = null) { @@ -184,7 +184,7 @@ class PluginTask extends AppShell { /** * find and change $this->path to the user selection * - * @param array $pathOptions + * @param array $pathOptions The list of paths to look in. * @return void */ public function findPath($pathOptions) { diff --git a/lib/Cake/Console/Command/Task/TestTask.php b/lib/Cake/Console/Command/Task/TestTask.php index 78afac367..d6f0e3c5b 100644 --- a/lib/Cake/Console/Command/Task/TestTask.php +++ b/lib/Cake/Console/Command/Task/TestTask.php @@ -102,7 +102,7 @@ class TestTask extends BakeTask { /** * Handles interactive baking * - * @param string $type + * @param string $type The type of object to bake a test for. * @return string|boolean */ protected function _interactive($type = null) { diff --git a/lib/Cake/Console/Command/Task/ViewTask.php b/lib/Cake/Console/Command/Task/ViewTask.php index 7f94de83f..86d133774 100644 --- a/lib/Cake/Console/Command/Task/ViewTask.php +++ b/lib/Cake/Console/Command/Task/ViewTask.php @@ -298,7 +298,7 @@ class ViewTask extends BakeTask { * Bake a view file for each of the supplied actions * * @param array $actions Array of actions to make files for. - * @param array $vars + * @param array $vars The template variables. * @return void */ public function bakeActions($actions, $vars) { @@ -454,7 +454,7 @@ class ViewTask extends BakeTask { /** * Returns associations for controllers models. * - * @param Model $model + * @param Model $model The Model instance. * @return array $associations */ protected function _associations(Model $model) { diff --git a/lib/Cake/Console/Command/TestShell.php b/lib/Cake/Console/Command/TestShell.php index bd7e9d277..992d1a315 100644 --- a/lib/Cake/Console/Command/TestShell.php +++ b/lib/Cake/Console/Command/TestShell.php @@ -334,9 +334,9 @@ class TestShell extends Shell { /** * Find the test case for the passed file. The file could itself be a test. * - * @param string $file - * @param string $category - * @param boolean $throwOnMissingFile + * @param string $file The file to map. + * @param string $category The test file category. + * @param boolean $throwOnMissingFile Whether or not to throw an exception. * @return array array(type, case) * @throws Exception */ @@ -411,7 +411,7 @@ class TestShell extends Shell { /** * For the given file, what category of test is it? returns app, core or the name of the plugin * - * @param string $file + * @param string $file The file to map. * @return string */ protected function _mapFileToCategory($file) { diff --git a/lib/Cake/Console/Command/UpgradeShell.php b/lib/Cake/Console/Command/UpgradeShell.php index a64d05468..d4b3b0c1e 100644 --- a/lib/Cake/Console/Command/UpgradeShell.php +++ b/lib/Cake/Console/Command/UpgradeShell.php @@ -554,6 +554,7 @@ class UpgradeShell extends AppShell { /** * Replace cakeError with built-in exceptions. * NOTE: this ignores calls where you've passed your own secondary parameters to cakeError(). + * * @return void */ public function exceptions() { @@ -661,7 +662,7 @@ class UpgradeShell extends AppShell { * Find all php files in the folder (honoring recursive) and determine where CakePHP expects the file to be * If the file is not exactly where CakePHP expects it - move it. * - * @param string $path + * @param string $path The path to move files in. * @param array $options array(recursive, checkFolder) * @return void */ @@ -763,7 +764,7 @@ class UpgradeShell extends AppShell { /** * Searches the paths and finds files based on extension. * - * @param string $extensions + * @param string $extensions The extensions to include. Defaults to none. * @return void */ protected function _findFiles($extensions = '') { diff --git a/lib/Cake/Console/ConsoleInputArgument.php b/lib/Cake/Console/ConsoleInputArgument.php index 7380893bf..32b032d30 100644 --- a/lib/Cake/Console/ConsoleInputArgument.php +++ b/lib/Cake/Console/ConsoleInputArgument.php @@ -132,7 +132,7 @@ class ConsoleInputArgument { /** * Check that $value is a valid choice for this argument. * - * @param string $value + * @param string $value The choice to validate. * @return boolean * @throws ConsoleException */ diff --git a/lib/Cake/Console/ConsoleInputOption.php b/lib/Cake/Console/ConsoleInputOption.php index 4d68c9f9e..7e45421bc 100644 --- a/lib/Cake/Console/ConsoleInputOption.php +++ b/lib/Cake/Console/ConsoleInputOption.php @@ -177,7 +177,7 @@ class ConsoleInputOption { /** * Check that a value is a valid choice for this option. * - * @param string $value + * @param string $value The choice to validate. * @return boolean * @throws ConsoleException */ diff --git a/lib/Cake/Console/ConsoleOutput.php b/lib/Cake/Console/ConsoleOutput.php index 5e1ce9bec..8b8f9f967 100644 --- a/lib/Cake/Console/ConsoleOutput.php +++ b/lib/Cake/Console/ConsoleOutput.php @@ -203,7 +203,7 @@ class ConsoleOutput { /** * Replace tags with color codes. * - * @param array $matches. + * @param array $matches An array of matches to replace. * @return string */ protected function _replaceTags($matches) { diff --git a/lib/Cake/Console/HelpFormatter.php b/lib/Cake/Console/HelpFormatter.php index c3b40c354..b2a7ceb51 100644 --- a/lib/Cake/Console/HelpFormatter.php +++ b/lib/Cake/Console/HelpFormatter.php @@ -159,7 +159,7 @@ class HelpFormatter { /** * Iterate over a collection and find the longest named thing. * - * @param array $collection + * @param array $collection The collection to find a max length of. * @return integer */ protected function _getMaxLength($collection) {