Improve docblocks

Author: sagikazarmark

src/Encoding/ChunkStream.php

@@ -29,6 +29,9 @@ public function getWriteFilter()
         return 'dechunk';
     }
 
+    /**
+     * {@inheritdoc}
+     */
     protected function fill()
     {
         parent::fill();

src/Encoding/CompressStream.php

@@ -11,6 +11,10 @@
  */
 class CompressStream extends FilteredStream
 {
+    /**
+     * @param StreamInterface $stream
+     * @param int             $level
+     */
     public function __construct(StreamInterface $stream, $level = -1)
     {
         if (!extension_loaded('zlib')) {
@@ -20,11 +24,17 @@ public function __construct(StreamInterface $stream, $level = -1)
         parent::__construct($stream, ['window' => 15, 'level' => $level], ['window' => 15]);
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getReadFilter()
     {
         return 'zlib.deflate';
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getWriteFilter()
     {
         return 'zlib.inflate';

src/Encoding/DecompressStream.php

@@ -11,6 +11,10 @@
  */
 class DecompressStream extends FilteredStream
 {
+    /**
+     * @param StreamInterface $stream
+     * @param int             $level
+     */
     public function __construct(StreamInterface $stream, $level = -1)
     {
         if (!extension_loaded('zlib')) {
@@ -20,11 +24,17 @@ public function __construct(StreamInterface $stream, $level = -1)
         parent::__construct($stream, ['window' => 15], ['window' => 15, 'level' => $level]);
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getReadFilter()
     {
         return 'zlib.inflate';
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getWriteFilter()
     {
         return 'zlib.deflate';

src/Encoding/DeflateStream.php

@@ -11,16 +11,26 @@
  */
 class DeflateStream extends FilteredStream
 {
+    /**
+     * @param StreamInterface $stream
+     * @param int             $level
+     */
     public function __construct(StreamInterface $stream, $level = -1)
     {
         parent::__construct($stream, ['window' => -15, 'level' => $level], ['window' => -15]);
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getReadFilter()
     {
         return 'zlib.deflate';
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getWriteFilter()
     {
         return 'zlib.inflate';

src/Encoding/Filter/Chunk.php

@@ -2,8 +2,16 @@
 
 namespace Http\Message\Encoding\Filter;
 
+/**
+ * Userland implementation of the chunk stream filter.
+ *
+ * @author Joel Wurtz <joel.wurtz@gmail.com>
+ */
 class Chunk extends \php_user_filter
 {
+    /**
+     * {@inheritdoc}
+     */
     public function filter($in, $out, &$consumed, $closing)
     {
         while ($bucket = stream_bucket_make_writeable($in)) {

src/Encoding/FilteredStream.php

@@ -46,8 +46,8 @@ abstract class FilteredStream implements StreamInterface
 
     /**
      * @param StreamInterface $stream
-     * @param null            $readFilterOptions
-     * @param null            $writeFilterOptions
+     * @param mixed|null      $readFilterOptions
+     * @param mixed|null      $writeFilterOptions
      */
     public function __construct(StreamInterface $stream, $readFilterOptions = null, $writeFilterOptions = null)
     {
@@ -128,16 +128,16 @@ public function getContents()
     }
 
     /**
-     * Return the read filter name.
+     * Returns the read filter name.
      *
      * @return string
      */
     abstract public function getReadFilter();
 
     /**
-     * Return the write filter name.
+     * Returns the write filter name.
      *
-     * @return mixed
+     * @return string
      */
     abstract public function getWriteFilter();
 }

src/Encoding/GzipDecodeStream.php

@@ -11,6 +11,10 @@
  */
 class GzipDecodeStream extends FilteredStream
 {
+    /**
+     * @param StreamInterface $stream
+     * @param int             $level
+     */
     public function __construct(StreamInterface $stream, $level = -1)
     {
         if (!extension_loaded('zlib')) {
@@ -20,11 +24,17 @@ public function __construct(StreamInterface $stream, $level = -1)
         parent::__construct($stream, ['window' => 31], ['window' => 31, 'level' => $level]);
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getReadFilter()
     {
         return 'zlib.inflate';
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getWriteFilter()
     {
         return 'zlib.deflate';

src/Encoding/GzipEncodeStream.php

@@ -11,6 +11,10 @@
  */
 class GzipEncodeStream extends FilteredStream
 {
+    /**
+     * @param StreamInterface $stream
+     * @param int             $level
+     */
     public function __construct(StreamInterface $stream, $level = -1)
     {
         if (!extension_loaded('zlib')) {

src/Encoding/InflateStream.php

@@ -11,6 +11,10 @@
  */
 class InflateStream extends FilteredStream
 {
+    /**
+     * @param StreamInterface $stream
+     * @param int             $level
+     */
     public function __construct(StreamInterface $stream, $level = -1)
     {
         if (!extension_loaded('zlib')) {
@@ -20,11 +24,17 @@ public function __construct(StreamInterface $stream, $level = -1)
         parent::__construct($stream, ['window' => -15], ['window' => -15, 'level' => $level]);
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getReadFilter()
     {
         return 'zlib.inflate';
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getWriteFilter()
     {
         return 'zlib.deflate';