[Console] use inheritdoc for Output classes

Tobion · Tobion · commit 940b7888ac16 · 2013-05-14T18:52:49.000+02:00
diff --git a/src/Symfony/Component/Console/Output/ConsoleOutput.php b/src/Symfony/Component/Console/Output/ConsoleOutput.php
@@ -54,32 +54,44 @@ public function __construct($verbosity = self::VERBOSITY_NORMAL, $decorated = nu
         $this->stderr = new StreamOutput(fopen('php://stderr', 'w'), $verbosity, $decorated, $formatter);
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function setDecorated($decorated)
     {
         parent::setDecorated($decorated);
         $this->stderr->setDecorated($decorated);
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function setFormatter(OutputFormatterInterface $formatter)
     {
         parent::setFormatter($formatter);
         $this->stderr->setFormatter($formatter);
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function setVerbosity($level)
     {
         parent::setVerbosity($level);
         $this->stderr->setVerbosity($level);
     }
 
     /**
-     * @return OutputInterface
+     * {@inheritdoc}
      */
     public function getErrorOutput()
     {
         return $this->stderr;
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function setErrorOutput(OutputInterface $error)
     {
         $this->stderr = $error;
diff --git a/src/Symfony/Component/Console/Output/Output.php b/src/Symfony/Component/Console/Output/Output.php
@@ -51,100 +51,63 @@ public function __construct($verbosity = self::VERBOSITY_NORMAL, $decorated = fa
     }
 
     /**
-     * Sets output formatter.
-     *
-     * @param OutputFormatterInterface $formatter
-     *
-     * @api
+     * {@inheritdoc}
      */
     public function setFormatter(OutputFormatterInterface $formatter)
     {
         $this->formatter = $formatter;
     }
 
     /**
-     * Returns current output formatter instance.
-     *
-     * @return  OutputFormatterInterface
-     *
-     * @api
+     * {@inheritdoc}
      */
     public function getFormatter()
     {
         return $this->formatter;
     }
 
     /**
-     * Sets the decorated flag.
-     *
-     * @param Boolean $decorated Whether to decorate the messages or not
-     *
-     * @api
+     * {@inheritdoc}
      */
     public function setDecorated($decorated)
     {
         $this->formatter->setDecorated($decorated);
     }
 
     /**
-     * Gets the decorated flag.
-     *
-     * @return Boolean true if the output will decorate messages, false otherwise
-     *
-     * @api
+     * {@inheritdoc}
      */
     public function isDecorated()
     {
         return $this->formatter->isDecorated();
     }
 
     /**
-     * Sets the verbosity of the output.
-     *
-     * @param integer $level The level of verbosity
-     *
-     * @api
+     * {@inheritdoc}
      */
     public function setVerbosity($level)
     {
         $this->verbosity = (int) $level;
     }
 
     /**
-     * Gets the current verbosity of the output.
-     *
-     * @return integer The current level of verbosity
-     *
-     * @api
+     * {@inheritdoc}
      */
     public function getVerbosity()
     {
         return $this->verbosity;
     }
 
     /**
-     * Writes a message to the output and adds a newline at the end.
-     *
-     * @param string|array $messages The message as an array of lines or a single string
-     * @param integer      $type     The type of output
-     *
-     * @api
+     * {@inheritdoc}
      */
     public function writeln($messages, $type = self::OUTPUT_NORMAL)
     {
         $this->write($messages, true, $type);
     }
 
     /**
-     * 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
-     * @param integer      $type     The type of output
-     *
-     * @throws \InvalidArgumentException When unknown output type is given
-     *
-     * @api
+     * {@inheritdoc}
      */
     public function write($messages, $newline = false, $type = self::OUTPUT_NORMAL)
     {
diff --git a/src/Symfony/Component/Console/Output/StreamOutput.php b/src/Symfony/Component/Console/Output/StreamOutput.php
@@ -70,12 +70,7 @@ public function getStream()
     }
 
     /**
-     * Writes a message to the output.
-     *
-     * @param string  $message A message to write to the output
-     * @param Boolean $newline Whether to add a newline or not
-     *
-     * @throws \RuntimeException When unable to write output (should never happen)
+     * {@inheritdoc}
      */
     protected function doWrite($message, $newline)
     {

Original file line number	Diff line number	Diff line change
`@@ -54,32 +54,44 @@ public function __construct($verbosity = self::VERBOSITY_NORMAL, $decorated = nu`
`54`	`54`	`$this->stderr = new StreamOutput(fopen('php://stderr', 'w'), $verbosity, $decorated, $formatter);`
`55`	`55`	`}`
`56`	`56`
	`57`	`+ /**`
	`58`	`+ * {@inheritdoc}`
	`59`	`+ */`
`57`	`60`	`public function setDecorated($decorated)`
`58`	`61`	`{`
`59`	`62`	`parent::setDecorated($decorated);`
`60`	`63`	`$this->stderr->setDecorated($decorated);`
`61`	`64`	`}`
`62`	`65`
	`66`	`+ /**`
	`67`	`+ * {@inheritdoc}`
	`68`	`+ */`
`63`	`69`	`public function setFormatter(OutputFormatterInterface $formatter)`
`64`	`70`	`{`
`65`	`71`	`parent::setFormatter($formatter);`
`66`	`72`	`$this->stderr->setFormatter($formatter);`
`67`	`73`	`}`
`68`	`74`
	`75`	`+ /**`
	`76`	`+ * {@inheritdoc}`
	`77`	`+ */`
`69`	`78`	`public function setVerbosity($level)`
`70`	`79`	`{`
`71`	`80`	`parent::setVerbosity($level);`
`72`	`81`	`$this->stderr->setVerbosity($level);`
`73`	`82`	`}`
`74`	`83`
`75`	`84`	`/**`
`76`		`- * @return OutputInterface`
	`85`	`+ * {@inheritdoc}`
`77`	`86`	`*/`
`78`	`87`	`public function getErrorOutput()`
`79`	`88`	`{`
`80`	`89`	`return $this->stderr;`
`81`	`90`	`}`
`82`	`91`
	`92`	`+ /**`
	`93`	`+ * {@inheritdoc}`
	`94`	`+ */`
`83`	`95`	`public function setErrorOutput(OutputInterface $error)`
`84`	`96`	`{`
`85`	`97`	`$this->stderr = $error;`
Original file line number	Diff line number	Diff line change
`@@ -70,12 +70,7 @@ public function getStream()`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`/**`
`73`		`- * Writes a message to the output.`
`74`		`- *`
`75`		`- * @param string $message A message to write to the output`
`76`		`- * @param Boolean $newline Whether to add a newline or not`
`77`		`- *`
`78`		`- * @throws \RuntimeException When unable to write output (should never happen)`
	`73`	`+ * {@inheritdoc}`
`79`	`74`	`*/`
`80`	`75`	`protected function doWrite($message, $newline)`
`81`	`76`	`{`