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:
commit
34e55be4d9
@ -364,9 +364,11 @@ class Command
|
|||||||
* Adds an argument.
|
* Adds an argument.
|
||||||
*
|
*
|
||||||
* @param string $name The argument name
|
* @param string $name The argument name
|
||||||
* @param int $mode The argument mode: InputArgument::REQUIRED or InputArgument::OPTIONAL
|
* @param int|null $mode The argument mode: self::REQUIRED or self::OPTIONAL
|
||||||
* @param string $description A description text
|
* @param string $description A description text
|
||||||
* @param mixed $default The default value (for InputArgument::OPTIONAL mode only)
|
* @param string|string[]|null $default The default value (for self::OPTIONAL mode only)
|
||||||
|
*
|
||||||
|
* @throws InvalidArgumentException When argument mode is not valid
|
||||||
*
|
*
|
||||||
* @return $this
|
* @return $this
|
||||||
*/
|
*/
|
||||||
@ -381,10 +383,12 @@ class Command
|
|||||||
* Adds an option.
|
* Adds an option.
|
||||||
*
|
*
|
||||||
* @param string $name The option name
|
* @param string $name The option name
|
||||||
* @param string $shortcut The shortcut (can be null)
|
* @param string|array $shortcut The shortcuts, can be null, a string of shortcuts delimited by | or an array of shortcuts
|
||||||
* @param int $mode The option mode: One of the InputOption::VALUE_* constants
|
* @param int|null $mode The option mode: One of the VALUE_* constants
|
||||||
* @param string $description A description text
|
* @param string $description A description text
|
||||||
* @param mixed $default The default value (must be null for InputOption::VALUE_NONE)
|
* @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
|
* @return $this
|
||||||
*/
|
*/
|
||||||
|
Reference in New Issue
Block a user