Prechádzať zdrojové kódy

[Console][Formatter] Added missing PHPDoc @throws and fixed some minor typos and grammatical errors

Javier Eguíluz 13 rokov pred
rodič
commit
3ad02bd5f9

+ 4 - 2
src/Symfony/Component/Console/Formatter/OutputFormatter.php

@@ -32,7 +32,7 @@ class OutputFormatter implements OutputFormatterInterface
      * Initializes console output formatter.
      *
      * @param   Boolean $decorated  Whether this formatter should actually decorate strings
-     * @param   array   $styles     Array of "name => FormatterStyle" instance
+     * @param   array   $styles     Array of "name => FormatterStyle" instances
      *
      * @api
      */
@@ -53,7 +53,7 @@ class OutputFormatter implements OutputFormatterInterface
     /**
      * Sets the decorated flag.
      *
-     * @param Boolean $decorated Whether to decorated the messages or not
+     * @param Boolean $decorated Whether to decorate the messages or not
      *
      * @api
      */
@@ -108,6 +108,8 @@ class OutputFormatter implements OutputFormatterInterface
      *
      * @return  OutputFormatterStyleInterface
      *
+     * @throws  \InvalidArgumentException When style isn't defined
+     *
      * @api
      */
     public function getStyle($name)

+ 1 - 1
src/Symfony/Component/Console/Formatter/OutputFormatterInterface.php

@@ -23,7 +23,7 @@ interface OutputFormatterInterface
     /**
      * Sets the decorated flag.
      *
-     * @param Boolean $decorated Whether to decorated the messages or not
+     * @param Boolean $decorated Whether to decorate the messages or not
      *
      * @api
      */

+ 10 - 1
src/Symfony/Component/Console/Formatter/OutputFormatterStyle.php

@@ -79,6 +79,8 @@ class OutputFormatterStyle implements OutputFormatterStyleInterface
      *
      * @param   string  $color  color name
      *
+     * @throws \InvalidArgumentException When the color name isn't defined
+     *
      * @api
      */
     public function setForeground($color = null)
@@ -105,6 +107,8 @@ class OutputFormatterStyle implements OutputFormatterStyleInterface
      *
      * @param   string  $color  color name
      *
+     * @throws \InvalidArgumentException When the color name isn't defined
+     *
      * @api
      */
     public function setBackground($color = null)
@@ -131,6 +135,8 @@ class OutputFormatterStyle implements OutputFormatterStyleInterface
      *
      * @param   string  $option     option name
      *
+     * @throws \InvalidArgumentException When the option name isn't defined
+     *
      * @api
      */
     public function setOption($option)
@@ -152,6 +158,9 @@ class OutputFormatterStyle implements OutputFormatterStyleInterface
      * Unsets some specific style option.
      *
      * @param   string  $option     option name
+     *
+     * @throws \InvalidArgumentException When the option name isn't defined
+     *
      */
     public function unsetOption($option)
     {
@@ -170,7 +179,7 @@ class OutputFormatterStyle implements OutputFormatterStyleInterface
     }
 
     /**
-     * Set multiple style options at once.
+     * Sets multiple style options at once.
      *
      * @param   array   $options
      */

+ 1 - 1
src/Symfony/Component/Console/Formatter/OutputFormatterStyleInterface.php

@@ -55,7 +55,7 @@ interface OutputFormatterStyleInterface
     function unsetOption($option);
 
     /**
-     * Set multiple style options at once.
+     * Sets multiple style options at once.
      *
      * @param   array   $options
      */