Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Fix remaining doc block errors in Console/
  • Loading branch information
markstory committed May 28, 2014
1 parent 8f5acb0 commit f6c868d
Show file tree
Hide file tree
Showing 19 changed files with 60 additions and 59 deletions.
4 changes: 2 additions & 2 deletions lib/Cake/Console/Command/CommandListShell.php
Expand Up @@ -77,7 +77,7 @@ public function main() {
/**
* Output text.
*
* @param array $shellList
* @param array $shellList The shell list.
* @return void
*/
protected function _asText($shellList) {
Expand All @@ -95,7 +95,7 @@ protected function _asText($shellList) {
/**
* Output as XML
*
* @param array $shellList
* @param array $shellList The shell list.
* @return void
*/
protected function _asXml($shellList) {
Expand Down
2 changes: 1 addition & 1 deletion lib/Cake/Console/Command/CompletionShell.php
Expand Up @@ -144,7 +144,7 @@ public function getOptionParser() {
/**
* Emit results as a string, space delimited
*
* @param array $options
* @param array $options The options to output
* @return void
*/
protected function _output($options = array()) {
Expand Down
20 changes: 10 additions & 10 deletions lib/Cake/Console/Command/ConsoleShell.php
Expand Up @@ -193,7 +193,7 @@ public function help() {
/**
* Override main() to handle action
*
* @param string $command
* @param string $command The command to run.
* @return void
*/
public function main($command = null) {
Expand All @@ -218,7 +218,7 @@ public function main($command = null) {
/**
* 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) {
Expand Down Expand Up @@ -256,7 +256,7 @@ protected function _models() {
/**
* Bind an association
*
* @param mixed $command
* @param mixed $command The command to run.
* @return void
*/
protected function _bind($command) {
Expand All @@ -283,7 +283,7 @@ protected function _bind($command) {
/**
* Unbind an association
*
* @param mixed $command
* @param mixed $command The command to run.
* @return void
*/
protected function _unbind($command) {
Expand Down Expand Up @@ -320,7 +320,7 @@ protected function _unbind($command) {
/**
* Perform a find
*
* @param mixed $command
* @param mixed $command The command to run.
* @return void
*/
protected function _find($command) {
Expand Down Expand Up @@ -382,7 +382,7 @@ protected function _find($command) {
/**
* Save a record
*
* @param mixed $command
* @param mixed $command The command to run.
* @return void
*/
protected function _save($command) {
Expand All @@ -406,7 +406,7 @@ protected function _save($command) {
/**
* Show the columns for a model
*
* @param mixed $command
* @param mixed $command The command to run.
* @return void
*/
protected function _columns($command) {
Expand Down Expand Up @@ -455,7 +455,7 @@ protected function _routesShow() {
/**
* 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) {
Expand All @@ -471,7 +471,7 @@ protected function _routeToString($command) {
/**
* 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) {
Expand All @@ -483,7 +483,7 @@ protected function _routeToArray($command) {
/**
* 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) {
Expand Down
14 changes: 7 additions & 7 deletions lib/Cake/Console/Command/SchemaShell.php
Expand Up @@ -311,8 +311,8 @@ protected function _loadSchema() {
* 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) {
Expand Down Expand Up @@ -362,8 +362,8 @@ protected function _create(CakeSchema $Schema, $table = null) {
* 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) {
Expand Down Expand Up @@ -417,9 +417,9 @@ protected function _update(&$Schema, $table = null) {
/**
* 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) {
Expand Down
12 changes: 6 additions & 6 deletions lib/Cake/Console/Command/Task/CommandTask.php
Expand Up @@ -53,9 +53,9 @@ public function getShellList() {
/**
* 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) {
Expand Down Expand Up @@ -90,7 +90,7 @@ public function commands() {
/**
* 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) {
Expand Down Expand Up @@ -127,7 +127,7 @@ public function subCommands($commandName) {
/**
* Get Shell instance for the given command
*
* @param mixed $commandName
* @param mixed $commandName The command you want.
* @return mixed
*/
public function getShell($commandName) {
Expand Down Expand Up @@ -157,7 +157,7 @@ public function getShell($commandName) {
/**
* 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) {
Expand Down
8 changes: 4 additions & 4 deletions lib/Cake/Console/Command/Task/ControllerTask.php
Expand Up @@ -224,10 +224,10 @@ protected function _interactive() {
/**
* 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) {
Expand Down
2 changes: 1 addition & 1 deletion lib/Cake/Console/Command/Task/DbConfigTask.php
Expand Up @@ -199,7 +199,7 @@ protected function _interactive() {
/**
* 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) {
Expand Down
18 changes: 9 additions & 9 deletions lib/Cake/Console/Command/Task/ExtractTask.php
Expand Up @@ -242,10 +242,10 @@ public function execute() {
*
* 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()) {
Expand Down Expand Up @@ -582,10 +582,10 @@ protected function _buildFiles() {
/**
* 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) {
Expand Down Expand Up @@ -678,7 +678,7 @@ protected function _writeHeader() {
/**
* 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
*/
Expand Down
2 changes: 1 addition & 1 deletion lib/Cake/Console/Command/Task/FixtureTask.php
Expand Up @@ -316,7 +316,7 @@ protected function _generateSchema($tableInfo) {
* 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) {
Expand Down
6 changes: 3 additions & 3 deletions lib/Cake/Console/Command/Task/ModelTask.php
Expand Up @@ -401,7 +401,7 @@ public function initValidations() {
*
* @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') {
Expand Down Expand Up @@ -510,7 +510,7 @@ public function fieldValidation($fieldName, $metaData, $primaryKey = 'id') {
/**
* Handles associations
*
* @param Model $model
* @param Model $model The model object
* @return array Associations
*/
public function doAssociations($model) {
Expand Down Expand Up @@ -562,7 +562,7 @@ public function doAssociations($model) {
/**
* Handles behaviors
*
* @param Model $model
* @param Model $model The model object.
* @return array Behaviors
*/
public function doActsAs($model) {
Expand Down
4 changes: 2 additions & 2 deletions lib/Cake/Console/Command/Task/PluginTask.php
Expand Up @@ -73,7 +73,7 @@ public function execute() {
/**
* Interactive interface
*
* @param string $plugin
* @param string $plugin The plugin name.
* @return void
*/
protected function _interactive($plugin = null) {
Expand Down Expand Up @@ -184,7 +184,7 @@ protected function _modifyBootstrap($plugin) {
/**
* 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) {
Expand Down
2 changes: 1 addition & 1 deletion lib/Cake/Console/Command/Task/TestTask.php
Expand Up @@ -102,7 +102,7 @@ public function execute() {
/**
* 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) {
Expand Down
4 changes: 2 additions & 2 deletions lib/Cake/Console/Command/Task/ViewTask.php
Expand Up @@ -298,7 +298,7 @@ protected function _loadController() {
* 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) {
Expand Down Expand Up @@ -454,7 +454,7 @@ public function getOptionParser() {
/**
* Returns associations for controllers models.
*
* @param Model $model
* @param Model $model The Model instance.
* @return array $associations
*/
protected function _associations(Model $model) {
Expand Down
8 changes: 4 additions & 4 deletions lib/Cake/Console/Command/TestShell.php
Expand Up @@ -334,9 +334,9 @@ public function available() {
/**
* 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
*/
Expand Down Expand Up @@ -411,7 +411,7 @@ protected function _mapFileToCase($file, $category, $throwOnMissingFile = true)
/**
* 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) {
Expand Down
5 changes: 3 additions & 2 deletions lib/Cake/Console/Command/UpgradeShell.php
Expand Up @@ -554,6 +554,7 @@ public function components() {
/**
* 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() {
Expand Down Expand Up @@ -661,7 +662,7 @@ protected function _moveAppClasses() {
* 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
*/
Expand Down Expand Up @@ -763,7 +764,7 @@ protected function _filesRegexpUpdate($patterns) {
/**
* 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 = '') {
Expand Down
2 changes: 1 addition & 1 deletion lib/Cake/Console/ConsoleInputArgument.php
Expand Up @@ -132,7 +132,7 @@ public function isRequired() {
/**
* Check that $value is a valid choice for this argument.
*
* @param string $value
* @param string $value The choice to validate.
* @return boolean
* @throws ConsoleException
*/
Expand Down

0 comments on commit f6c868d

Please sign in to comment.