[Console] fix phpdoc of Output classes (esp. regarding the new verbosities)

Tobion · Tobion · commit bd61b925a1e3 · 2013-05-14T18:51:31.000+02:00
also add missing information
diff --git a/src/Symfony/Component/Console/Output/ConsoleOutput.php b/src/Symfony/Component/Console/Output/ConsoleOutput.php
@@ -36,10 +36,9 @@ class ConsoleOutput extends StreamOutput implements ConsoleOutputInterface
     /**
      * 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 (one of the VERBOSITY constants in OutputInterface)
+     * @param Boolean|null                  $decorated Whether to decorate messages (null for auto-guessing)
+     * @param OutputFormatterInterface|null $formatter Output formatter instance (null to use default OutputFormatter)
      *
      * @api
      */
diff --git a/src/Symfony/Component/Console/Output/ConsoleOutputInterface.php b/src/Symfony/Component/Console/Output/ConsoleOutputInterface.php
@@ -22,9 +22,16 @@
 interface ConsoleOutputInterface extends OutputInterface
 {
     /**
+     * Gets the OutputInterface for errors.
+     *
      * @return OutputInterface
      */
     public function getErrorOutput();
 
+    /**
+     * Sets the OutputInterface used for errors.
+     *
+     * @param OutputInterface $error
+     */
     public function setErrorOutput(OutputInterface $error);
 }
diff --git a/src/Symfony/Component/Console/Output/Output.php b/src/Symfony/Component/Console/Output/Output.php
@@ -17,10 +17,12 @@
 /**
  * Base class for output classes.
  *
- * There are three levels of verbosity:
+ * There are five levels of verbosity:
  *
- *  * normal: no option passed (normal output - information)
- *  * verbose: -v (more output - debug)
+ *  * normal: no option passed (normal output)
+ *  * verbose: -v (more output)
+ *  * very verbose: -vv (highly extended output)
+ *  * debug: -vvv (all debug output)
  *  * quiet: -q (no output)
  *
  * @author Fabien Potencier <fabien@symfony.com>
@@ -35,9 +37,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
-     * @param OutputFormatterInterface $formatter Output formatter instance
+     * @param integer                       $verbosity The verbosity level (one of the VERBOSITY constants in OutputInterface)
+     * @param Boolean                       $decorated Whether to decorate messages
+     * @param OutputFormatterInterface|null $formatter Output formatter instance (null to use default OutputFormatter)
      *
      * @api
      */
@@ -137,7 +139,7 @@ public function writeln($messages, $type = self::OUTPUT_NORMAL)
      * Writes a message to the output.
      *
      * @param string|array $messages The message as an array of lines or a single string
-     * @param Boolean      $newline  Whether to add a newline or not
+     * @param Boolean      $newline  Whether to add a newline
      * @param integer      $type     The type of output
      *
      * @throws \InvalidArgumentException When unknown output type is given
diff --git a/src/Symfony/Component/Console/Output/OutputInterface.php b/src/Symfony/Component/Console/Output/OutputInterface.php
@@ -36,8 +36,8 @@ interface OutputInterface
      * Writes a message to the output.
      *
      * @param string|array $messages The message as an array of lines or a single string
-     * @param Boolean      $newline  Whether to add a newline or not
-     * @param integer      $type     The type of output (0: normal, 1: raw, 2: plain)
+     * @param Boolean      $newline  Whether to add a newline
+     * @param integer      $type     The type of output (one of the OUTPUT constants)
      *
      * @throws \InvalidArgumentException When unknown output type is given
      *
@@ -49,7 +49,9 @@ public function write($messages, $newline = false, $type = self::OUTPUT_NORMAL);
      * Writes a message to the output and adds a newline at the end.
      *
      * @param string|array $messages The message as an array of lines of a single string
-     * @param integer      $type     The type of output (0: normal, 1: raw, 2: plain)
+     * @param integer      $type     The type of output (one of the OUTPUT constants)
+     *
+     * @throws \InvalidArgumentException When unknown output type is given
      *
      * @api
      */
@@ -58,7 +60,7 @@ public function writeln($messages, $type = self::OUTPUT_NORMAL);
     /**
      * Sets the verbosity of the output.
      *
-     * @param integer $level The level of verbosity
+     * @param integer $level The level of verbosity (one of the VERBOSITY constants)
      *
      * @api
      */
@@ -67,7 +69,7 @@ public function setVerbosity($level);
     /**
      * Gets the current verbosity of the output.
      *
-     * @return integer The current level of verbosity
+     * @return integer The current level of verbosity (one of the VERBOSITY constants)
      *
      * @api
      */
@@ -76,7 +78,7 @@ public function getVerbosity();
     /**
      * Sets the decorated flag.
      *
-     * @param Boolean $decorated Whether to decorate the messages or not
+     * @param Boolean $decorated Whether to decorate the messages
      *
      * @api
      */
diff --git a/src/Symfony/Component/Console/Output/StreamOutput.php b/src/Symfony/Component/Console/Output/StreamOutput.php
@@ -35,11 +35,10 @@ 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 OutputFormatterInterface $formatter Output formatter instance
+     * @param mixed                         $stream    A stream resource
+     * @param integer                       $verbosity The verbosity level (one of the VERBOSITY constants in OutputInterface)
+     * @param Boolean|null                  $decorated Whether to decorate messages (null for auto-guessing)
+     * @param OutputFormatterInterface|null $formatter Output formatter instance (null to use default OutputFormatter)
      *
      * @throws \InvalidArgumentException When first argument is not a real stream
      *

Original file line number	Diff line number	Diff line change
`@@ -36,10 +36,9 @@ class ConsoleOutput extends StreamOutput implements ConsoleOutputInterface`
`36`	`36`	`/**`
`37`	`37`	`* Constructor.`
`38`	`38`	`*`
`39`		`- * @param integer $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL,`
`40`		`- * self::VERBOSITY_VERBOSE)`
`41`		`- * @param Boolean $decorated Whether to decorate messages or not (null for auto-guessing)`
`42`		`- * @param OutputFormatterInterface $formatter Output formatter instance`
	`39`	`+ * @param integer $verbosity The verbosity level (one of the VERBOSITY constants in OutputInterface)`
	`40`	`+ * @param Boolean\|null $decorated Whether to decorate messages (null for auto-guessing)`
	`41`	`+ * @param OutputFormatterInterface\|null $formatter Output formatter instance (null to use default OutputFormatter)`
`43`	`42`	`*`
`44`	`43`	`* @api`
`45`	`44`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -17,10 +17,12 @@`
`17`	`17`	`/**`
`18`	`18`	`* Base class for output classes.`
`19`	`19`	`*`
`20`		`- * There are three levels of verbosity:`
	`20`	`+ * There are five levels of verbosity:`
`21`	`21`	`*`
`22`		`- * * normal: no option passed (normal output - information)`
`23`		`- * * verbose: -v (more output - debug)`
	`22`	`+ * * normal: no option passed (normal output)`
	`23`	`+ * * verbose: -v (more output)`
	`24`	`+ * * very verbose: -vv (highly extended output)`
	`25`	`+ * * debug: -vvv (all debug output)`
`24`	`26`	`* * quiet: -q (no output)`
`25`	`27`	`*`
`26`	`28`	`* @author Fabien Potencier <fabien@symfony.com>`
`@@ -35,9 +37,9 @@ abstract class Output implements OutputInterface`
`35`	`37`	`/**`
`36`	`38`	`* Constructor.`
`37`	`39`	`*`
`38`		`- * @param integer $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL, self::VERBOSITY_VERBOSE)`
`39`		`- * @param Boolean $decorated Whether to decorate messages or not`
`40`		`- * @param OutputFormatterInterface $formatter Output formatter instance`
	`40`	`+ * @param integer $verbosity The verbosity level (one of the VERBOSITY constants in OutputInterface)`
	`41`	`+ * @param Boolean $decorated Whether to decorate messages`
	`42`	`+ * @param OutputFormatterInterface\|null $formatter Output formatter instance (null to use default OutputFormatter)`
`41`	`43`	`*`
`42`	`44`	`* @api`
`43`	`45`	`*/`
`@@ -137,7 +139,7 @@ public function writeln($messages, $type = self::OUTPUT_NORMAL)`
`137`	`139`	`* Writes a message to the output.`
`138`	`140`	`*`
`139`	`141`	`* @param string\|array $messages The message as an array of lines or a single string`
`140`		`- * @param Boolean $newline Whether to add a newline or not`
	`142`	`+ * @param Boolean $newline Whether to add a newline`
`141`	`143`	`* @param integer $type The type of output`
`142`	`144`	`*`
`143`	`145`	`* @throws \InvalidArgumentException When unknown output type is given`
Original file line number	Diff line number	Diff line change
`@@ -36,8 +36,8 @@ interface OutputInterface`
`36`	`36`	`* Writes a message to the output.`
`37`	`37`	`*`
`38`	`38`	`* @param string\|array $messages The message as an array of lines or a single string`
`39`		`- * @param Boolean $newline Whether to add a newline or not`
`40`		`- * @param integer $type The type of output (0: normal, 1: raw, 2: plain)`
	`39`	`+ * @param Boolean $newline Whether to add a newline`
	`40`	`+ * @param integer $type The type of output (one of the OUTPUT constants)`
`41`	`41`	`*`
`42`	`42`	`* @throws \InvalidArgumentException When unknown output type is given`
`43`	`43`	`*`
`@@ -49,7 +49,9 @@ public function write($messages, $newline = false, $type = self::OUTPUT_NORMAL);`
`49`	`49`	`* Writes a message to the output and adds a newline at the end.`
`50`	`50`	`*`
`51`	`51`	`* @param string\|array $messages The message as an array of lines of a single string`
`52`		`- * @param integer $type The type of output (0: normal, 1: raw, 2: plain)`
	`52`	`+ * @param integer $type The type of output (one of the OUTPUT constants)`
	`53`	`+ *`
	`54`	`+ * @throws \InvalidArgumentException When unknown output type is given`
`53`	`55`	`*`
`54`	`56`	`* @api`
`55`	`57`	`*/`
`@@ -58,7 +60,7 @@ public function writeln($messages, $type = self::OUTPUT_NORMAL);`
`58`	`60`	`/**`
`59`	`61`	`* Sets the verbosity of the output.`
`60`	`62`	`*`
`61`		`- * @param integer $level The level of verbosity`
	`63`	`+ * @param integer $level The level of verbosity (one of the VERBOSITY constants)`
`62`	`64`	`*`
`63`	`65`	`* @api`
`64`	`66`	`*/`
`@@ -67,7 +69,7 @@ public function setVerbosity($level);`
`67`	`69`	`/**`
`68`	`70`	`* Gets the current verbosity of the output.`
`69`	`71`	`*`
`70`		`- * @return integer The current level of verbosity`
	`72`	`+ * @return integer The current level of verbosity (one of the VERBOSITY constants)`
`71`	`73`	`*`
`72`	`74`	`* @api`
`73`	`75`	`*/`
`@@ -76,7 +78,7 @@ public function getVerbosity();`
`76`	`78`	`/**`
`77`	`79`	`* Sets the decorated flag.`
`78`	`80`	`*`
`79`		`- * @param Boolean $decorated Whether to decorate the messages or not`
	`81`	`+ * @param Boolean $decorated Whether to decorate the messages`
`80`	`82`	`*`
`81`	`83`	`* @api`
`82`	`84`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -35,11 +35,10 @@ class StreamOutput extends Output`
`35`	`35`	`/**`
`36`	`36`	`* Constructor.`
`37`	`37`	`*`
`38`		`- * @param mixed $stream A stream resource`
`39`		`- * @param integer $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL,`
`40`		`- * self::VERBOSITY_VERBOSE)`
`41`		`- * @param Boolean $decorated Whether to decorate messages or not (null for auto-guessing)`
`42`		`- * @param OutputFormatterInterface $formatter Output formatter instance`
	`38`	`+ * @param mixed $stream A stream resource`
	`39`	`+ * @param integer $verbosity The verbosity level (one of the VERBOSITY constants in OutputInterface)`
	`40`	`+ * @param Boolean\|null $decorated Whether to decorate messages (null for auto-guessing)`
	`41`	`+ * @param OutputFormatterInterface\|null $formatter Output formatter instance (null to use default OutputFormatter)`
`43`	`42`	`*`
`44`	`43`	`* @throws \InvalidArgumentException When first argument is not a real stream`
`45`	`44`	`*`