minor #28714 Fix phpdocs (mschop)

This PR was submitted for the master branch but it was merged into the 2.8 branch instead (closes #28714).

Discussion
----------

Fix phpdocs

| Q             | A
| ------------- | ---
| Branch?       | all supported releases and master
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes (I didn't run them, but just changed docs)
| Fixed tickets | None
| License       | MIT

See https://github.com/phan/phan/issues/2025 for details.
Fix phpdocs for Command for preventing static code analysis tools to emit false positives.

Commits
-------

7196e49f7e Fix phpdocs
This commit is contained in:
Fabien Potencier 2018-10-06 09:38:07 +02:00
commit 34e55be4d9
1 changed files with 13 additions and 9 deletions

View File

@ -363,10 +363,12 @@ class Command
/**
* Adds an argument.
*
* @param string $name The argument name
* @param int $mode The argument mode: InputArgument::REQUIRED or InputArgument::OPTIONAL
* @param string $description A description text
* @param mixed $default The default value (for InputArgument::OPTIONAL mode only)
* @param string $name The argument name
* @param int|null $mode The argument mode: self::REQUIRED or self::OPTIONAL
* @param string $description A description text
* @param string|string[]|null $default The default value (for self::OPTIONAL mode only)
*
* @throws InvalidArgumentException When argument mode is not valid
*
* @return $this
*/
@ -380,11 +382,13 @@ class Command
/**
* Adds an option.
*
* @param string $name The option name
* @param string $shortcut The shortcut (can be null)
* @param int $mode The option mode: One of the InputOption::VALUE_* constants
* @param string $description A description text
* @param mixed $default The default value (must be null for InputOption::VALUE_NONE)
* @param string $name The option name
* @param string|array $shortcut The shortcuts, can be null, a string of shortcuts delimited by | or an array of shortcuts
* @param int|null $mode The option mode: One of the VALUE_* constants
* @param string $description A description text
* @param string|string[]|bool|null $default The default value (must be null for self::VALUE_NONE)
*
* @throws InvalidArgumentException If option mode is invalid or incompatible
*
* @return $this
*/