[Phpdoc] Cleaning/fixing

symfony · Apr 23, 2011 · 4ec78d1 · 4ec78d1
1 parent 9fe145e
commit 4ec78d1
Show file tree

Hide file tree

Showing 11 changed files with 25 additions and 23 deletions.
diff --git a/Application.php b/Application.php
@@ -640,8 +640,8 @@ public function asText($namespace = null)
     /**
      * Returns an XML representation of the Application.
      *
-     * @param string $namespace An optional namespace name
-     * @param Boolean $asDom Whether to return a DOM or an XML string
+     * @param string  $namespace An optional namespace name
+     * @param Boolean $asDom     Whether to return a DOM or an XML string
      *
      * @return string|DOMDocument An XML string representing the Application
      */

diff --git a/Formatter/OutputFormatter.php b/Formatter/OutputFormatter.php
@@ -72,8 +72,8 @@ public function isDecorated()
     /**
      * Sets a new style.
      *
-     * @param   string                          $name     The style name
-     * @param   OutputFormatterStyleInterface   $options  The style instance
+     * @param string                        $name  The style name
+     * @param OutputFormatterStyleInterface $style The style instance
      *
      * @api
      */

diff --git a/Formatter/OutputFormatterInterface.php b/Formatter/OutputFormatterInterface.php
@@ -41,8 +41,8 @@ function isDecorated();
     /**
      * Sets a new style.
      *
-     * @param   string                          $name     The style name
-     * @param   OutputFormatterStyleInterface   $options  The style instance
+     * @param string                        $name  The style name
+     * @param OutputFormatterStyleInterface $style The style instance
      *
      * @api
      */

diff --git a/Helper/HelperSet.php b/Helper/HelperSet.php
@@ -38,7 +38,7 @@ public function __construct(array $helpers = array())
      * Sets a helper.
      *
      * @param HelperInterface $value The helper instance
-     * @param string                    $alias An alias
+     * @param string          $alias An alias
      */
     public function set(HelperInterface $helper, $alias = null)
     {

diff --git a/Input/ArgvInput.php b/Input/ArgvInput.php
@@ -111,7 +111,7 @@ private function parseShortOption($token)
     /**
      * Parses a short option set.
      *
-     * @param string $token The current token
+     * @param string $name The current token
      *
      * @throws \RuntimeException When option given doesn't exist
      */

diff --git a/Input/ArrayInput.php b/Input/ArrayInput.php
@@ -29,7 +29,7 @@ class ArrayInput extends Input
     /**
      * Constructor.
      *
-     * @param array           $param An array of parameters
+     * @param array           $parameters An array of parameters
      * @param InputDefinition $definition A InputDefinition instance
      *
      * @api
@@ -63,7 +63,7 @@ public function getFirstArgument()
      * This method is to be used to introspect the input parameters
      * before it has been validated. It must be used carefully.
      *
-     * @param string|array $value The values to look for in the raw parameters (can be an array)
+     * @param string|array $values The values to look for in the raw parameters (can be an array)
      *
      * @return Boolean true if the value is contained in the raw parameters
      */

diff --git a/Output/ConsoleOutput.php b/Output/ConsoleOutput.php
@@ -33,9 +33,10 @@ class ConsoleOutput extends StreamOutput
     /**
      * Constructor.
      *
-     * @param integer $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL, self::VERBOSITY_VERBOSE)
-     * @param Boolean $decorated Whether to decorate messages or not (null for auto-guessing)
-     * @param OutputFormatter   $formatter  Output formatter instance
+     * @param integer         $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL,
+     *                                   self::VERBOSITY_VERBOSE)
+     * @param Boolean         $decorated Whether to decorate messages or not (null for auto-guessing)
+     * @param OutputFormatter $formatter Output formatter instance
      *
      * @api
      */

diff --git a/Output/Output.php b/Output/Output.php
@@ -35,9 +35,9 @@ abstract class Output implements OutputInterface
     /**
      * Constructor.
      *
-     * @param integer                   $verbosity  The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL, self::VERBOSITY_VERBOSE)
-     * @param Boolean                   $decorated  Whether to decorate messages or not (null for auto-guessing)
-     * @param OutputFormatterInterface  $formatter  Output formatter instance
+     * @param integer                  $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL, self::VERBOSITY_VERBOSE)
+     * @param Boolean                  $decorated Whether to decorate messages or not (null for auto-guessing)
+     * @param OutputFormatterInterface $formatter Output formatter instance
      *
      * @api
      */
@@ -55,7 +55,7 @@ public function __construct($verbosity = self::VERBOSITY_NORMAL, $decorated = nu
     /**
      * Sets output formatter.
      *
-     * @param   OutputFormatterInterface    $formatter
+     * @param OutputFormatterInterface $formatter
      *
      * @api
      */

diff --git a/Output/OutputInterface.php b/Output/OutputInterface.php
@@ -90,7 +90,7 @@ function isDecorated();
     /**
      * Sets output formatter.
      *
-     * @param   OutputFormatterInterface    $formatter
+     * @param OutputFormatterInterface $formatter
      *
      * @api
      */

diff --git a/Output/StreamOutput.php b/Output/StreamOutput.php
@@ -35,10 +35,11 @@ class StreamOutput extends Output
     /**
      * Constructor.
      *
-     * @param mixed   $stream    A stream resource
-     * @param integer $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL, self::VERBOSITY_VERBOSE)
-     * @param Boolean $decorated Whether to decorate messages or not (null for auto-guessing)
-     * @param OutputFormatter   $formatter  Output formatter instance
+     * @param mixed           $stream    A stream resource
+     * @param integer         $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL,
+     *                                   self::VERBOSITY_VERBOSE)
+     * @param Boolean         $decorated Whether to decorate messages or not (null for auto-guessing)
+     * @param OutputFormatter $formatter Output formatter instance
      *
      * @throws \InvalidArgumentException When first argument is not a real stream
      *

diff --git a/Tester/ApplicationTester.php b/Tester/ApplicationTester.php
@@ -27,7 +27,7 @@ class ApplicationTester
     /**
      * Constructor.
      *
-     * @param Application $application A Application instance to test.
+     * @param Application $application An Application instance to test.
      */
     public function __construct(Application $application)
     {