diff --git a/src/Symfony/Component/Console/Output/ConsoleOutput.php b/src/Symfony/Component/Console/Output/ConsoleOutput.php index 46926c35c4..adea35f77e 100644 --- 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 index 5006b80070..c63bd157be 100644 --- a/src/Symfony/Component/Console/Output/ConsoleOutputInterface.php +++ b/src/Symfony/Component/Console/Output/ConsoleOutputInterface.php @@ -22,9 +22,16 @@ use Symfony\Component\Console\Output\OutputInterface; 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 index dd7dbe0f5b..89b68a2792 100644 --- a/src/Symfony/Component/Console/Output/Output.php +++ b/src/Symfony/Component/Console/Output/Output.php @@ -17,10 +17,12 @@ use Symfony\Component\Console\Formatter\OutputFormatter; /** * 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 @@ -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 @@ abstract class Output implements 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 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 index eab9d54e14..83d5013fdd 100644 --- 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 @@ interface OutputInterface * 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 @@ interface OutputInterface /** * 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 @@ interface OutputInterface /** * 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 @@ interface OutputInterface /** * 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 index 831b2ae881..674bdad571 100644 --- 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 *