Skip to content

Commit af5ff96

Browse files
committed
minor #11483 fix some docblocks (xabbuh)
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
2 parents 6f21d59 + 86552ae commit af5ff96

File tree

4 files changed

+11
-5
lines changed

4 files changed

+11
-5
lines changed

Application.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -884,6 +884,8 @@ protected function configureIO(InputInterface $input, OutputInterface $output)
884884
* @param OutputInterface $output An Output instance
885885
*
886886
* @return int 0 if everything went fine, or an error code
887+
*
888+
* @throws \Exception when the command being run threw an exception
887889
*/
888890
protected function doRunCommand(Command $command, InputInterface $input, OutputInterface $output)
889891
{

Helper/DescriptorHelper.php

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,11 @@ public function __construct()
4848
*
4949
* @param OutputInterface $output
5050
* @param object $object
51-
* @param string $format
51+
* @param string|null $format
5252
* @param bool $raw
53-
* @param string $namespace
53+
* @param string|null $namespace
54+
*
55+
* @throws \InvalidArgumentException when the given format is not supported
5456
*/
5557
public function describe(OutputInterface $output, $object, $format = null, $raw = false, $namespace = null)
5658
{

Helper/DialogHelper.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ public function askHiddenResponse(OutputInterface $output, $question, $fallback
321321
* @param OutputInterface $output An Output instance
322322
* @param string|array $question The question to ask
323323
* @param callable $validator A PHP callback
324-
* @param int $attempts Max number of times to ask before giving up (false by default, which means infinite)
324+
* @param int|false $attempts Max number of times to ask before giving up (false by default, which means infinite)
325325
* @param string $default The default answer if none is given by the user
326326
* @param array $autocomplete List of values to autocomplete
327327
*
@@ -350,7 +350,7 @@ public function askAndValidate(OutputInterface $output, $question, $validator, $
350350
* @param OutputInterface $output An Output instance
351351
* @param string|array $question The question to ask
352352
* @param callable $validator A PHP callback
353-
* @param int $attempts Max number of times to ask before giving up (false by default, which means infinite)
353+
* @param int|false $attempts Max number of times to ask before giving up (false by default, which means infinite)
354354
* @param bool $fallback In case the response can not be hidden, whether to fallback on non-hidden question or not
355355
*
356356
* @return string The response
@@ -444,7 +444,7 @@ private function hasSttyAvailable()
444444
* @param callable $interviewer A callable that will ask for a question and return the result
445445
* @param OutputInterface $output An Output instance
446446
* @param callable $validator A PHP callback
447-
* @param int $attempts Max number of times to ask before giving up ; false will ask infinitely
447+
* @param int|false $attempts Max number of times to ask before giving up ; false will ask infinitely
448448
*
449449
* @return string The validated response
450450
*

Helper/TableHelper.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,8 @@ public function __construct()
7878
* @param int $layout self::LAYOUT_*
7979
*
8080
* @return TableHelper
81+
*
82+
* @throws InvalidArgumentException when the table layout is not known
8183
*/
8284
public function setLayout($layout)
8385
{

0 commit comments

Comments
 (0)