Merge pull request #53 from Nyholm/doc_block

joelwurtz · joelwurtz · commit 79ff0b8d92a3 · 2016-01-28T12:46:12.000+01:00
Updated doc block to be coherent with the suggested PSR
diff --git a/src/CachePlugin.php b/src/CachePlugin.php
@@ -32,13 +32,13 @@ class CachePlugin implements Plugin
     private $config;
 
     /**
-     * Available options for $config are
-     *  - respect_cache_headers: Whether to look at the cache directives or ignore them.
-     *  - default_ttl: If we do not respect cache headers or can't calculate a good ttl, use this value.
-     *
      * @param CacheItemPoolInterface $pool
      * @param StreamFactory          $streamFactory
-     * @param array                  $config
+     * @param array                  $config        {
+     *
+     *     @var bool $respect_cache_headers Whether to look at the cache directives or ignore them.
+     *     @var int $default_ttl If we do not respect cache headers or can't calculate a good ttl, use this value.
+     * }
      */
     public function __construct(CacheItemPoolInterface $pool, StreamFactory $streamFactory, array $config = [])
     {
diff --git a/src/DecoderPlugin.php b/src/DecoderPlugin.php
@@ -30,10 +30,10 @@ class DecoderPlugin implements Plugin
     private $useContentEncoding;
 
     /**
-     * Available options for $config are:
-     *  - use_content_encoding: Whether this plugin should look at the Content-Encoding header first or only at the Transfer-Encoding (defaults to true).
+     * @param array $config {
      *
-     * @param array $config
+     *    @var bool $use_content_encoding Whether this plugin should look at the Content-Encoding header first or only at the Transfer-Encoding (defaults to true).
+     * }
      */
     public function __construct(array $config = [])
     {
diff --git a/src/PluginClient.php b/src/PluginClient.php
@@ -43,7 +43,10 @@ final class PluginClient implements HttpClient, HttpAsyncClient
     /**
      * @param HttpClient|HttpAsyncClient $client
      * @param Plugin[]                   $plugins
-     * @param array                      $options
+     * @param array                      $options {
+     *
+     *     @var int $max_restarts
+     * }
      *
      * @throws \RuntimeException if client is not an instance of HttpClient or HttpAsyncClient
      */
diff --git a/src/RedirectPlugin.php b/src/RedirectPlugin.php
@@ -99,11 +99,11 @@ class RedirectPlugin implements Plugin
     protected $circularDetection = [];
 
     /**
-     * Available options for $config are:
-     *  - preserve_header: bool|string[] True keeps all headers, false remove all of them, an array is interpreted as a list of header names to keep.
-     *  - use_default_for_multiple: Whether the location header must be directly used for a multiple redirection status code (300).
+     * @param array $config {
      *
-     * @param array $config
+     *     @var bool|string[] $preserve_header True keeps all headers, false remove all of them, an array is interpreted as a list of header names to keep.
+     *     @var bool $use_default_for_multiple Whether the location header must be directly used for a multiple redirection status code (300).
+     * }
      */
     public function __construct(array $config = [])
     {
diff --git a/src/RetryPlugin.php b/src/RetryPlugin.php
@@ -31,10 +31,10 @@ class RetryPlugin implements Plugin
     private $retryStorage = [];
 
     /**
-     * Available options for $config are:
-     *  - retries: Number of retries to attempt if an exception occurs before letting the exception bubble up.
+     * @param array $config {
      *
-     * @param array $config
+     *     @var int $retries Number of retries to attempt if an exception occurs before letting the exception bubble up.
+     * }
      */
     public function __construct(array $config = [])
     {

Original file line number	Diff line number	Diff line change
`@@ -30,10 +30,10 @@ class DecoderPlugin implements Plugin`
`30`	`30`	`private $useContentEncoding;`
`31`	`31`
`32`	`32`	`/**`
`33`		`- * Available options for $config are:`
`34`		`- * - use_content_encoding: Whether this plugin should look at the Content-Encoding header first or only at the Transfer-Encoding (defaults to true).`
	`33`	`+ * @param array $config {`
`35`	`34`	`*`
`36`		`- * @param array $config`
	`35`	`+ * @var bool $use_content_encoding Whether this plugin should look at the Content-Encoding header first or only at the Transfer-Encoding (defaults to true).`
	`36`	`+ * }`
`37`	`37`	`*/`
`38`	`38`	`public function __construct(array $config = [])`
`39`	`39`	`{`
Original file line number	Diff line number	Diff line change
`@@ -31,10 +31,10 @@ class RetryPlugin implements Plugin`
`31`	`31`	`private $retryStorage = [];`
`32`	`32`
`33`	`33`	`/**`
`34`		`- * Available options for $config are:`
`35`		`- * - retries: Number of retries to attempt if an exception occurs before letting the exception bubble up.`
	`34`	`+ * @param array $config {`
`36`	`35`	`*`
`37`		`- * @param array $config`
	`36`	`+ * @var int $retries Number of retries to attempt if an exception occurs before letting the exception bubble up.`
	`37`	`+ * }`
`38`	`38`	`*/`
`39`	`39`	`public function __construct(array $config = [])`
`40`	`40`	`{`