Skip to content

Commit

Permalink
minor #11483 fix some docblocks (xabbuh)
Browse files Browse the repository at this point in the history
This PR was merged into the 2.3 branch.

Discussion
----------

fix some docblocks

| Q             | A
| ------------- | ---
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets |
| License       | MIT
| Doc PR        |

Commits
-------

1775da5 fix some docblocks
  • Loading branch information
fabpot committed Aug 2, 2014
2 parents 6f21d59 + 86552ae commit af5ff96
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 5 deletions.
2 changes: 2 additions & 0 deletions Application.php
Original file line number Diff line number Diff line change
Expand Up @@ -884,6 +884,8 @@ protected function configureIO(InputInterface $input, OutputInterface $output)
* @param OutputInterface $output An Output instance
*
* @return int 0 if everything went fine, or an error code
*
* @throws \Exception when the command being run threw an exception
*/
protected function doRunCommand(Command $command, InputInterface $input, OutputInterface $output)
{
Expand Down
6 changes: 4 additions & 2 deletions Helper/DescriptorHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,11 @@ public function __construct()
*
* @param OutputInterface $output
* @param object $object
* @param string $format
* @param string|null $format
* @param bool $raw
* @param string $namespace
* @param string|null $namespace
*
* @throws \InvalidArgumentException when the given format is not supported
*/
public function describe(OutputInterface $output, $object, $format = null, $raw = false, $namespace = null)
{
Expand Down
6 changes: 3 additions & 3 deletions Helper/DialogHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ public function askHiddenResponse(OutputInterface $output, $question, $fallback
* @param OutputInterface $output An Output instance
* @param string|array $question The question to ask
* @param callable $validator A PHP callback
* @param int $attempts Max number of times to ask before giving up (false by default, which means infinite)
* @param int|false $attempts Max number of times to ask before giving up (false by default, which means infinite)
* @param string $default The default answer if none is given by the user
* @param array $autocomplete List of values to autocomplete
*
Expand Down Expand Up @@ -350,7 +350,7 @@ public function askAndValidate(OutputInterface $output, $question, $validator, $
* @param OutputInterface $output An Output instance
* @param string|array $question The question to ask
* @param callable $validator A PHP callback
* @param int $attempts Max number of times to ask before giving up (false by default, which means infinite)
* @param int|false $attempts Max number of times to ask before giving up (false by default, which means infinite)
* @param bool $fallback In case the response can not be hidden, whether to fallback on non-hidden question or not
*
* @return string The response
Expand Down Expand Up @@ -444,7 +444,7 @@ private function hasSttyAvailable()
* @param callable $interviewer A callable that will ask for a question and return the result
* @param OutputInterface $output An Output instance
* @param callable $validator A PHP callback
* @param int $attempts Max number of times to ask before giving up ; false will ask infinitely
* @param int|false $attempts Max number of times to ask before giving up ; false will ask infinitely
*
* @return string The validated response
*
Expand Down
2 changes: 2 additions & 0 deletions Helper/TableHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,8 @@ public function __construct()
* @param int $layout self::LAYOUT_*
*
* @return TableHelper
*
* @throws InvalidArgumentException when the table layout is not known
*/
public function setLayout($layout)
{
Expand Down

0 comments on commit af5ff96

Please sign in to comment.