minor #20813 [Console] Review Application docblocks (ogizanagi)

fabpot · fabpot · commit 7f85f6dc1e3a · 2016-12-13T16:27:53.000+01:00
This PR was squashed before being merged into the 2.7 branch (closes #20813). Discussion ---------- [Console] Review Application docblocks | Q | A | ------------- | --- | Branch? | 2.7 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | N/A | License | MIT | Doc PR | N/A ~I know there must be a lot of other places in the core where there is some repeated or useless informations in docblocks, but everytime I dig into the `Application` class, I see this, and I don't want to repeat things for consistency when adding new methods 😅 (for instance in #20808, the `setCatchThrowables / areThrowablesCaught ` methods do not need a docblock description IMHO).~ ~This PR adapts docblocks where:~ - ~A docblock description is not required, as everything can be expressed in the `@return / @param` argument (the case mentioned above)~ - ~Information is redundant between description and tags, and the context does not have to be reminded again:~ ```diff /** * Adds an array of command objects. * * If a Command is not enabled it will not be added. * - * @param Command[] $commands An array of commands + * @param Command[] $commands */ public function addCommands(array $commands) { foreach ($commands as $command) { $this->add($command); } } ``` Commits ------- d8c18cc [Console] Review Application docblocks
diff --git a/src/Symfony/Component/Console/Application.php b/src/Symfony/Component/Console/Application.php
@@ -102,8 +102,6 @@ public function setDispatcher(EventDispatcherInterface $dispatcher)
      * @param OutputInterface $output An Output instance
      *
      * @return int 0 if everything went fine, or an error code
-     *
-     * @throws \Exception When doRun returns Exception
      */
     public function run(InputInterface $input = null, OutputInterface $output = null)
     {
@@ -387,7 +385,7 @@ public function add(Command $command)
      *
      * @return Command A Command object
      *
-     * @throws \InvalidArgumentException When command name given does not exist
+     * @throws \InvalidArgumentException When given command name does not exist
      */
     public function get($name)
     {
@@ -831,8 +829,6 @@ 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)
     {

Original file line number	Diff line number	Diff line change
`@@ -102,8 +102,6 @@ public function setDispatcher(EventDispatcherInterface $dispatcher)`
`102`	`102`	`* @param OutputInterface $output An Output instance`
`103`	`103`	`*`
`104`	`104`	`* @return int 0 if everything went fine, or an error code`
`105`		`- *`
`106`		`- * @throws \Exception When doRun returns Exception`
`107`	`105`	`*/`
`108`	`106`	`public function run(InputInterface $input = null, OutputInterface $output = null)`
`109`	`107`	`{`
`@@ -387,7 +385,7 @@ public function add(Command $command)`
`387`	`385`	`*`
`388`	`386`	`* @return Command A Command object`
`389`	`387`	`*`
`390`		`- * @throws \InvalidArgumentException When command name given does not exist`
	`388`	`+ * @throws \InvalidArgumentException When given command name does not exist`
`391`	`389`	`*/`
`392`	`390`	`public function get($name)`
`393`	`391`	`{`
`@@ -831,8 +829,6 @@ protected function configureIO(InputInterface $input, OutputInterface $output)`
`831`	`829`	`* @param OutputInterface $output An Output instance`
`832`	`830`	`*`
`833`	`831`	`* @return int 0 if everything went fine, or an error code`
`834`		`- *`
`835`		`- * @throws \Exception when the command being run threw an exception`
`836`	`832`	`*/`
`837`	`833`	`protected function doRunCommand(Command $command, InputInterface $input, OutputInterface $output)`
`838`	`834`	`{`