[FramworkBundle] fix phpdoc of commands

Tobion · Tobion · commit 5361f83be8ff · 2013-03-07T14:36:36.000+01:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/AssetsInstallCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/AssetsInstallCommand.php
@@ -15,7 +15,6 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
-use Symfony\Component\Console\Output\Output;
 use Symfony\Component\Finder\Finder;
 
 /**
@@ -26,7 +25,7 @@
 class AssetsInstallCommand extends ContainerAwareCommand
 {
     /**
-     * @see Command
+     * {@inheritdoc}
      */
     protected function configure()
     {
@@ -62,9 +61,9 @@ protected function configure()
     }
 
     /**
-     * @see Command
+     * {@inheritdoc}
      *
-     * @throws \InvalidArgumentException When the target directory does not exist
+     * @throws \InvalidArgumentException When the target directory does not exist or symlink cannot be used
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/CacheClearCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/CacheClearCommand.php
@@ -28,7 +28,7 @@ class CacheClearCommand extends ContainerAwareCommand
     protected $name;
 
     /**
-     * @see Command
+     * {@inheritdoc}
      */
     protected function configure()
     {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/CacheWarmupCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/CacheWarmupCommand.php
@@ -23,7 +23,7 @@
 class CacheWarmupCommand extends ContainerAwareCommand
 {
     /**
-     * @see Command
+     * {@inheritdoc}
      */
     protected function configure()
     {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/ConfigDumpReferenceCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/ConfigDumpReferenceCommand.php
@@ -25,7 +25,7 @@
 class ConfigDumpReferenceCommand extends ContainerDebugCommand
 {
     /**
-     * @see Command
+     * {@inheritdoc}
      */
     protected function configure()
     {
@@ -53,7 +53,9 @@ protected function configure()
     }
 
     /**
-     * @see Command
+     * {@inheritdoc}
+     *
+     * @throws \LogicException
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/ContainerAwareCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/ContainerAwareCommand.php
@@ -23,7 +23,7 @@
 abstract class ContainerAwareCommand extends Command implements ContainerAwareInterface
 {
     /**
-     * @var ContainerInterface
+     * @var ContainerInterface|null
      */
     private $container;
 
@@ -40,7 +40,7 @@ protected function getContainer()
     }
 
     /**
-     * @see ContainerAwareInterface::setContainer()
+     * {@inheritdoc}
      */
     public function setContainer(ContainerInterface $container = null)
     {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/ContainerDebugCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/ContainerDebugCommand.php
@@ -29,12 +29,12 @@
 class ContainerDebugCommand extends ContainerAwareCommand
 {
     /**
-     * @var ContainerBuilder
+     * @var ContainerBuilder|null
      */
     protected $containerBuilder;
 
     /**
-     * @see Command
+     * {@inheritdoc}
      */
     protected function configure()
     {
@@ -74,7 +74,9 @@ protected function configure()
     }
 
     /**
-     * @see Command
+     * {@inheritdoc}
+     *
+     * @throws \LogicException
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
@@ -307,7 +309,7 @@ protected function getContainerBuilder()
      *
      * @param string $serviceId The service id to resolve
      *
-     * @return \Symfony\Component\DependencyInjection\Definition|\Symfony\Component\DependencyInjection\Alias
+     * @return Definition|Alias
      */
     protected function resolveServiceDefinition($serviceId)
     {
@@ -328,7 +330,7 @@ protected function resolveServiceDefinition($serviceId)
      * Renders list of tagged services grouped by tag
      *
      * @param OutputInterface $output
-     * @param bool            $showPrivate
+     * @param Boolean         $showPrivate
      */
     protected function outputTags(OutputInterface $output, $showPrivate = false)
     {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/RouterApacheDumperCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/RouterApacheDumperCommand.php
@@ -26,7 +26,7 @@
 class RouterApacheDumperCommand extends ContainerAwareCommand
 {
     /**
-     * {@inheritDoc}
+     * {@inheritdoc}
      */
     public function isEnabled()
     {
@@ -42,7 +42,7 @@ public function isEnabled()
     }
 
     /**
-     * @see Command
+     * {@inheritdoc}
      */
     protected function configure()
     {
@@ -65,7 +65,7 @@ protected function configure()
     }
 
     /**
-     * @see Command
+     * {@inheritdoc}
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/RouterDebugCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/RouterDebugCommand.php
@@ -24,7 +24,7 @@
 class RouterDebugCommand extends ContainerAwareCommand
 {
     /**
-     * {@inheritDoc}
+     * {@inheritdoc}
      */
     public function isEnabled()
     {
@@ -40,7 +40,7 @@ public function isEnabled()
     }
 
     /**
-     * @see Command
+     * {@inheritdoc}
      */
     protected function configure()
     {
@@ -60,7 +60,9 @@ protected function configure()
     }
 
     /**
-     * @see Command
+     * {@inheritdoc}
+     *
+     * @throws \InvalidArgumentException When route does not exist
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/RouterMatchCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/RouterMatchCommand.php
@@ -25,7 +25,7 @@
 class RouterMatchCommand extends ContainerAwareCommand
 {
     /**
-     * {@inheritDoc}
+     * {@inheritdoc}
      */
     public function isEnabled()
     {
@@ -41,7 +41,7 @@ public function isEnabled()
     }
 
     /**
-     * @see Command
+     * {@inheritdoc}
      */
     protected function configure()
     {
@@ -61,7 +61,7 @@ protected function configure()
     }
 
     /**
-     * @see Command
+     * {@inheritdoc}
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/ServerRunCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/ServerRunCommand.php
@@ -25,7 +25,7 @@
 class ServerRunCommand extends ContainerAwareCommand
 {
     /**
-     * {@inheritDoc}
+     * {@inheritdoc}
      */
     public function isEnabled()
     {
@@ -37,7 +37,7 @@ public function isEnabled()
     }
 
     /**
-     * @see Command
+     * {@inheritdoc}
      */
     protected function configure()
     {
@@ -74,7 +74,7 @@ protected function configure()
     }
 
     /**
-     * @see Command
+     * {@inheritdoc}
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/TranslationUpdateCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/TranslationUpdateCommand.php
@@ -33,7 +33,7 @@ class TranslationUpdateCommand extends ContainerAwareCommand
     protected $catalogue;
 
     /**
-     * {@inheritDoc}
+     * {@inheritdoc}
      */
     protected function configure()
     {
@@ -74,7 +74,7 @@ protected function configure()
     }
 
     /**
-     * {@inheritDoc}
+     * {@inheritdoc}
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
diff --git a/src/Symfony/Component/DependencyInjection/ContainerAwareInterface.php b/src/Symfony/Component/DependencyInjection/ContainerAwareInterface.php
@@ -23,7 +23,7 @@ interface ContainerAwareInterface
     /**
      * Sets the Container.
      *
-     * @param ContainerInterface $container A ContainerInterface instance
+     * @param ContainerInterface|null $container A ContainerInterface instance or null
      *
      * @api
      */

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,6 @@`
`15`	`15`	`use Symfony\Component\Console\Input\InputOption;`
`16`	`16`	`use Symfony\Component\Console\Input\InputInterface;`
`17`	`17`	`use Symfony\Component\Console\Output\OutputInterface;`
`18`		`-use Symfony\Component\Console\Output\Output;`
`19`	`18`	`use Symfony\Component\Finder\Finder;`
`20`	`19`
`21`	`20`	`/**`
`@@ -26,7 +25,7 @@`
`26`	`25`	`class AssetsInstallCommand extends ContainerAwareCommand`
`27`	`26`	`{`
`28`	`27`	`/**`
`29`		`- * @see Command`
	`28`	`+ * {@inheritdoc}`
`30`	`29`	`*/`
`31`	`30`	`protected function configure()`
`32`	`31`	`{`
`@@ -62,9 +61,9 @@ protected function configure()`
`62`	`61`	`}`
`63`	`62`
`64`	`63`	`/**`
`65`		`- * @see Command`
	`64`	`+ * {@inheritdoc}`
`66`	`65`	`*`
`67`		`- * @throws \InvalidArgumentException When the target directory does not exist`
	`66`	`+ * @throws \InvalidArgumentException When the target directory does not exist or symlink cannot be used`
`68`	`67`	`*/`
`69`	`68`	`protected function execute(InputInterface $input, OutputInterface $output)`
`70`	`69`	`{`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ class CacheClearCommand extends ContainerAwareCommand`
`28`	`28`	`protected $name;`
`29`	`29`
`30`	`30`	`/**`
`31`		`- * @see Command`
	`31`	`+ * {@inheritdoc}`
`32`	`32`	`*/`
`33`	`33`	`protected function configure()`
`34`	`34`	`{`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`class CacheWarmupCommand extends ContainerAwareCommand`
`24`	`24`	`{`
`25`	`25`	`/**`
`26`		`- * @see Command`
	`26`	`+ * {@inheritdoc}`
`27`	`27`	`*/`
`28`	`28`	`protected function configure()`
`29`	`29`	`{`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@`
`25`	`25`	`class ConfigDumpReferenceCommand extends ContainerDebugCommand`
`26`	`26`	`{`
`27`	`27`	`/**`
`28`		`- * @see Command`
	`28`	`+ * {@inheritdoc}`
`29`	`29`	`*/`
`30`	`30`	`protected function configure()`
`31`	`31`	`{`
`@@ -53,7 +53,9 @@ protected function configure()`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`/**`
`56`		`- * @see Command`
	`56`	`+ * {@inheritdoc}`
	`57`	`+ *`
	`58`	`+ * @throws \LogicException`
`57`	`59`	`*/`
`58`	`60`	`protected function execute(InputInterface $input, OutputInterface $output)`
`59`	`61`	`{`
Original file line number	Diff line number	Diff line change
`@@ -29,12 +29,12 @@`
`29`	`29`	`class ContainerDebugCommand extends ContainerAwareCommand`
`30`	`30`	`{`
`31`	`31`	`/**`
`32`		`- * @var ContainerBuilder`
	`32`	`+ * @var ContainerBuilder\|null`
`33`	`33`	`*/`
`34`	`34`	`protected $containerBuilder;`
`35`	`35`
`36`	`36`	`/**`
`37`		`- * @see Command`
	`37`	`+ * {@inheritdoc}`
`38`	`38`	`*/`
`39`	`39`	`protected function configure()`
`40`	`40`	`{`
`@@ -74,7 +74,9 @@ protected function configure()`
`74`	`74`	`}`
`75`	`75`
`76`	`76`	`/**`
`77`		`- * @see Command`
	`77`	`+ * {@inheritdoc}`
	`78`	`+ *`
	`79`	`+ * @throws \LogicException`
`78`	`80`	`*/`
`79`	`81`	`protected function execute(InputInterface $input, OutputInterface $output)`
`80`	`82`	`{`
`@@ -307,7 +309,7 @@ protected function getContainerBuilder()`
`307`	`309`	`*`
`308`	`310`	`* @param string $serviceId The service id to resolve`
`309`	`311`	`*`
`310`		`- * @return \Symfony\Component\DependencyInjection\Definition\|\Symfony\Component\DependencyInjection\Alias`
	`312`	`+ * @return Definition\|Alias`
`311`	`313`	`*/`
`312`	`314`	`protected function resolveServiceDefinition($serviceId)`
`313`	`315`	`{`
`@@ -328,7 +330,7 @@ protected function resolveServiceDefinition($serviceId)`
`328`	`330`	`* Renders list of tagged services grouped by tag`
`329`	`331`	`*`
`330`	`332`	`* @param OutputInterface $output`
`331`		`- * @param bool $showPrivate`
	`333`	`+ * @param Boolean $showPrivate`
`332`	`334`	`*/`
`333`	`335`	`protected function outputTags(OutputInterface $output, $showPrivate = false)`
`334`	`336`	`{`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@`
`26`	`26`	`class RouterApacheDumperCommand extends ContainerAwareCommand`
`27`	`27`	`{`
`28`	`28`	`/**`
`29`		`- * {@inheritDoc}`
	`29`	`+ * {@inheritdoc}`
`30`	`30`	`*/`
`31`	`31`	`public function isEnabled()`
`32`	`32`	`{`
`@@ -42,7 +42,7 @@ public function isEnabled()`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`/**`
`45`		`- * @see Command`
	`45`	`+ * {@inheritdoc}`
`46`	`46`	`*/`
`47`	`47`	`protected function configure()`
`48`	`48`	`{`
`@@ -65,7 +65,7 @@ protected function configure()`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`/**`
`68`		`- * @see Command`
	`68`	`+ * {@inheritdoc}`
`69`	`69`	`*/`
`70`	`70`	`protected function execute(InputInterface $input, OutputInterface $output)`
`71`	`71`	`{`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`	`class RouterDebugCommand extends ContainerAwareCommand`
`25`	`25`	`{`
`26`	`26`	`/**`
`27`		`- * {@inheritDoc}`
	`27`	`+ * {@inheritdoc}`
`28`	`28`	`*/`
`29`	`29`	`public function isEnabled()`
`30`	`30`	`{`
`@@ -40,7 +40,7 @@ public function isEnabled()`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`/**`
`43`		`- * @see Command`
	`43`	`+ * {@inheritdoc}`
`44`	`44`	`*/`
`45`	`45`	`protected function configure()`
`46`	`46`	`{`
`@@ -60,7 +60,9 @@ protected function configure()`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`/**`
`63`		`- * @see Command`
	`63`	`+ * {@inheritdoc}`
	`64`	`+ *`
	`65`	`+ * @throws \InvalidArgumentException When route does not exist`
`64`	`66`	`*/`
`65`	`67`	`protected function execute(InputInterface $input, OutputInterface $output)`
`66`	`68`	`{`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ class TranslationUpdateCommand extends ContainerAwareCommand`
`33`	`33`	`protected $catalogue;`
`34`	`34`
`35`	`35`	`/**`
`36`		`- * {@inheritDoc}`
	`36`	`+ * {@inheritdoc}`
`37`	`37`	`*/`
`38`	`38`	`protected function configure()`
`39`	`39`	`{`
`@@ -74,7 +74,7 @@ protected function configure()`
`74`	`74`	`}`
`75`	`75`
`76`	`76`	`/**`
`77`		`- * {@inheritDoc}`
	`77`	`+ * {@inheritdoc}`
`78`	`78`	`*/`
`79`	`79`	`protected function execute(InputInterface $input, OutputInterface $output)`
`80`	`80`	`{`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ interface ContainerAwareInterface`
`23`	`23`	`/**`
`24`	`24`	`* Sets the Container.`
`25`	`25`	`*`
`26`		`- * @param ContainerInterface $container A ContainerInterface instance`
	`26`	`+ * @param ContainerInterface\|null $container A ContainerInterface instance or null`
`27`	`27`	`*`
`28`	`28`	`* @api`
`29`	`29`	`*/`