Browse Source

Fix API doc errors in Console/

mark_story 12 years ago
parent
commit
bb58bbe642

+ 4 - 4
lib/Cake/Console/Shell.php

@@ -254,7 +254,7 @@ class Shell extends Object {
 /**
  * Lazy loads models using the loadModel() method if declared in $uses
  *
- * @param string $name
+ * @param string $name The name of the model to look for.
  * @return void
  */
 	public function __isset($name) {
@@ -446,7 +446,7 @@ class Shell extends Object {
 /**
  * Display the help in the correct format
  *
- * @param string $command
+ * @param string $command The command to get help for.
  * @return void
  */
 	protected function _displayHelp($command) {
@@ -477,7 +477,7 @@ class Shell extends Object {
 /**
  * Overload get for lazy building of tasks
  *
- * @param string $name
+ * @param string $name The property name to access.
  * @return Shell Object of Task
  */
 	public function __get($name) {
@@ -819,7 +819,7 @@ class Shell extends Object {
 /**
  * creates the singular name for use in views.
  *
- * @param string $name
+ * @param string $name The plural underscored value.
  * @return string $name
  */
 	protected function _singularName($name) {

+ 1 - 1
lib/Cake/Console/ShellDispatcher.php

@@ -317,7 +317,7 @@ class ShellDispatcher {
 /**
  * Parses out the paths from from the argv
  *
- * @param array $args
+ * @param array $args The argv to parse.
  * @return void
  */
 	protected function _parsePaths($args) {

+ 1 - 1
lib/Cake/Console/TaskCollection.php

@@ -43,7 +43,7 @@ class TaskCollection extends ObjectCollection {
 /**
  * Constructor
  *
- * @param Shell $Shell
+ * @param Shell $Shell The shell this task collection is attached to.
  */
 	public function __construct(Shell $Shell) {
 		$this->_Shell = $Shell;