Improve multiple PHPDocs return tags

src/AbstractMessage.php

@@ -39,7 +39,7 @@ abstract class AbstractMessage extends Message
      * (AbstractMessage::VERSION_10, AbstractMessage::VERSION_11, AbstractMessage::VERSION_2)
      *
      * @param  string $version (Must be 1.0, 1.1 or 2)
-     * @return AbstractMessage
+     * @return $this
      * @throws Exception\InvalidArgumentException
      */
     public function setVersion($version)
@@ -69,7 +69,7 @@ public function getVersion()
      *
      * @see    getHeaders()
      * @param  Headers $headers
-     * @return AbstractMessage
+     * @return $this
      */
     public function setHeaders(Headers $headers)
     {

src/Client.php

@@ -152,7 +152,7 @@ public function __construct($uri = null, $options = null)
      * Set configuration parameters for this HTTP client
      *
      * @param  array|Traversable $options
-     * @return Client
+     * @return $this
      * @throws Client\Exception\InvalidArgumentException
      */
     public function setOptions($options = [])
@@ -184,7 +184,7 @@ public function setOptions($options = [])
      * separated from ->request() to preserve logic and readability
      *
      * @param  Client\Adapter\AdapterInterface|string $adapter
-     * @return Client
+     * @return $this
      * @throws Client\Exception\InvalidArgumentException
      */
     public function setAdapter($adapter)
@@ -212,7 +212,7 @@ public function setAdapter($adapter)
     /**
      * Load the connection adapter
      *
-     * @return Client\Adapter\AdapterInterface $adapter
+     * @return Client\Adapter\AdapterInterface
      */
     public function getAdapter()
     {
@@ -227,7 +227,7 @@ public function getAdapter()
      * Set request
      *
      * @param Request $request
-     * @return Client
+     * @return $this
      */
     public function setRequest(Request $request)
     {
@@ -253,7 +253,7 @@ public function getRequest()
      * Set response
      *
      * @param Response $response
-     * @return Client
+     * @return $this
      */
     public function setResponse(Response $response)
     {
@@ -308,7 +308,7 @@ public function getRedirectionsCount()
      * Set Uri (to the request)
      *
      * @param string|Http $uri
-     * @return Client
+     * @return $this
      */
     public function setUri($uri)
     {
@@ -356,7 +356,7 @@ public function getUri()
      * Set the HTTP method (to the request)
      *
      * @param string $method
-     * @return Client
+     * @return $this
      */
     public function setMethod($method)
     {
@@ -395,7 +395,7 @@ public function getMethod()
      * Set the query string argument separator
      *
      * @param string $argSeparator
-     * @return Client
+     * @return $this
      */
     public function setArgSeparator($argSeparator)
     {
@@ -423,7 +423,7 @@ public function getArgSeparator()
      *
      * @param string $encType
      * @param string $boundary
-     * @return Client
+     * @return $this
      */
     public function setEncType($encType, $boundary = null)
     {
@@ -454,7 +454,7 @@ public function getEncType()
      * Set raw body (for advanced use cases)
      *
      * @param string $body
-     * @return Client
+     * @return $this
      */
     public function setRawBody($body)
     {
@@ -466,7 +466,7 @@ public function setRawBody($body)
      * Set the POST parameters
      *
      * @param array $post
-     * @return Client
+     * @return $this
      */
     public function setParameterPost(array $post)
     {
@@ -478,7 +478,7 @@ public function setParameterPost(array $post)
      * Set the GET parameters
      *
      * @param array $query
-     * @return Client
+     * @return $this
      */
     public function setParameterGet(array $query)
     {
@@ -491,7 +491,7 @@ public function setParameterGet(array $query)
      *
      * @param  bool   $clearCookies  Also clear all valid cookies? (defaults to false)
      * @param  bool   $clearAuth     Also clear http authentication? (defaults to true)
-     * @return Client
+     * @return $this
      */
     public function resetParameters($clearCookies = false /*, $clearAuth = true */)
     {
@@ -559,7 +559,7 @@ protected function getCookieId($cookie)
      * @param string  $maxAge
      * @param string  $version
      * @throws Exception\InvalidArgumentException
-     * @return Client
+     * @return $this
      */
     public function addCookie(
         $cookie,
@@ -606,7 +606,7 @@ public function addCookie(
      *
      * @param  array|SetCookie[] $cookies Cookies as name=>value pairs or instances of SetCookie.
      * @throws Exception\InvalidArgumentException
-     * @return Client
+     * @return $this
      */
     public function setCookies($cookies)
     {
@@ -638,7 +638,7 @@ public function clearCookies()
      *
      * @param  Headers|array $headers
      * @throws Exception\InvalidArgumentException
-     * @return Client
+     * @return $this
      */
     public function setHeaders($headers)
     {
@@ -693,7 +693,7 @@ public function getHeader($name)
      * Set streaming for received data
      *
      * @param string|bool $streamfile Stream file, true for temp file, false/null for no streaming
-     * @return \Zend\Http\Client
+     * @return $this
      */
     public function setStream($streamfile = true)
     {
@@ -717,8 +717,8 @@ public function getStream()
     /**
      * Create temporary stream
      *
-     * @throws Exception\RuntimeException
      * @return resource
+     * @throws Exception\RuntimeException
      */
     protected function openTempStream()
     {
@@ -753,7 +753,7 @@ protected function openTempStream()
      * @param string $password
      * @param string $type
      * @throws Exception\InvalidArgumentException
-     * @return Client
+     * @return $this
      */
     public function setAuth($user, $password, $type = self::AUTH_BASIC)
     {
@@ -865,7 +865,7 @@ public function dispatch(Stdlib\RequestInterface $request, Stdlib\ResponseInterf
     /**
      * Send HTTP request
      *
-     * @param  Request $request
+     * @param  Request|null $request
      * @return Response
      * @throws Exception\RuntimeException
      * @throws Client\Exception\RuntimeException
@@ -1043,7 +1043,7 @@ public function send(Request $request = null)
     /**
      * Fully reset the HTTP client (auth, cookies, request, response, etc.)
      *
-     * @return Client
+     * @return $this
      */
     public function reset()
     {
@@ -1071,7 +1071,7 @@ public function reset()
      * @param  string $data Data to send (if null, $filename is read and sent)
      * @param  string $ctype Content type to use (if $data is set and $ctype is
      *                null, will be application/octet-stream)
-     * @return Client
+     * @return $this
      * @throws Exception\RuntimeException
      */
     public function setFileUpload($filename, $formname, $data = null, $ctype = null)
@@ -1154,8 +1154,8 @@ protected function prepareCookies($domain, $path, $secure)
      *
      * @param resource|string $body
      * @param Http $uri
-     * @throws Exception\RuntimeException
      * @return array
+     * @throws Exception\RuntimeException
      */
     protected function prepareHeaders($body, $uri)
     {
@@ -1499,7 +1499,5 @@ public static function encodeAuthHeader($user, $password, $type = self::AUTH_BAS
                     $type
                 ));
         }
-
-        return;
     }
 }

src/Client/Adapter/Curl.php

@@ -101,7 +101,7 @@ public function __construct()
      * Set the configuration array for the adapter
      *
      * @param  array|Traversable $options
-     * @return Curl
+     * @return $this
      * @throws AdapterException\InvalidArgumentException
      */
     public function setOptions($options = [])
@@ -168,7 +168,7 @@ public function getConfig()
      *
      * @param  string|int $option
      * @param  mixed $value
-     * @return Curl
+     * @return $this
      */
     public function setCurlOption($option, $value)
     {
@@ -553,7 +553,7 @@ public function getHandle()
      * Set output stream for the response
      *
      * @param resource $stream
-     * @return Curl
+     * @return $this
      */
     public function setOutputStream($stream)
     {

src/Client/Adapter/Socket.php

@@ -143,7 +143,7 @@ public function getConfig()
      *
      * @param  mixed $context Stream context or array of context options
      * @throws Exception\InvalidArgumentException
-     * @return Socket
+     * @return $this
      */
     public function setStreamContext($context)
     {

src/Cookies.php

@@ -338,7 +338,7 @@ protected function _matchPath($domains, $path)
      *
      * @param Response $response HTTP Response object
      * @param Uri\Uri|string $refUri The requested URI
-     * @return Cookies
+     * @return static
      * @todo Add the $uri functionality.
      */
     public static function fromResponse(Response $response, $refUri)
@@ -361,7 +361,7 @@ public function isEmpty()
     /**
      * Empties the cookieJar of any cookie
      *
-     * @return Cookies
+     * @return $this
      */
     public function reset()
     {

src/Header/AbstractAccept.php

@@ -77,7 +77,7 @@ public function parseHeaderLine($headerLine)
      * Factory method: parse Accept header string
      *
      * @param  string $headerLine
-     * @return Accept
+     * @return static
      */
     public static function fromString($headerLine)
     {
@@ -242,7 +242,7 @@ function ($v) {
      * @param  int|float $priority
      * @param  array (optional) $params
      * @throws Exception\InvalidArgumentException
-     * @return Accept
+     * @return $this
      */
     protected function addType($type, $priority = 1, array $params = [])
     {

src/Header/AbstractDate.php

@@ -65,7 +65,7 @@ abstract class AbstractDate implements HeaderInterface
      * Create date-based header from string
      *
      * @param string $headerLine
-     * @return AbstractDate
+     * @return static
      * @throws Exception\InvalidArgumentException
      */
     public static function fromString($headerLine)
@@ -90,9 +90,7 @@ public static function fromString($headerLine)
      * Create date-based header from strtotime()-compatible string
      *
      * @param int|string $time
-     *
-     * @return self
-     *
+     * @return static
      * @throws Exception\InvalidArgumentException
      */
     public static function fromTimeString($time)
@@ -104,9 +102,7 @@ public static function fromTimeString($time)
      * Create date-based header from Unix timestamp
      *
      * @param int $time
-     *
-     * @return self
-     *
+     * @return static
      * @throws Exception\InvalidArgumentException
      */
     public static function fromTimestamp($time)
@@ -156,7 +152,7 @@ public static function getDateFormat()
      * Set the date for this header, this can be a string or an instance of \DateTime
      *
      * @param string|DateTime $date
-     * @return AbstractDate
+     * @return $this
      * @throws Exception\InvalidArgumentException
      */
     public function setDate($date)

src/Header/AbstractLocation.php

@@ -35,7 +35,7 @@ abstract class AbstractLocation implements HeaderInterface
      * Create location-based header from string
      *
      * @param string $headerLine
-     * @return AbstractLocation
+     * @return static
      * @throws Exception\InvalidArgumentException
      */
     public static function fromString($headerLine)
@@ -62,7 +62,7 @@ public static function fromString($headerLine)
      * Set the URI/URL for this header, this can be a string or an instance of Zend\Uri\Http
      *
      * @param string|UriInterface $uri
-     * @return AbstractLocation
+     * @return $this
      * @throws Exception\InvalidArgumentException
      */
     public function setUri($uri)

src/Header/Accept.php

@@ -47,7 +47,7 @@ public function toString()
      * @param  string $type
      * @param  int|float $priority
      * @param  array $params
-     * @return Accept
+     * @return $this
      */
     public function addMediaType($type, $priority = 1, array $params = [])
     {

src/Header/Accept/FieldValuePart/AbstractFieldValuePart.php

@@ -38,7 +38,7 @@ public function __construct($internalValues)
      * Set a Field Value Part this Field Value Part matched against.
      *
      * @param AbstractFieldValuePart $matchedAgainst
-     * @return AbstractFieldValuePart provides fluent interface
+     * @return $this
      */
     public function setMatchedAgainst(AbstractFieldValuePart $matchedAgainst)
     {

src/Header/AcceptCharset.php

@@ -43,7 +43,7 @@ public function toString()
      *
      * @param  string $type
      * @param  int|float $priority
-     * @return Accept
+     * @return $this
      */
     public function addCharset($type, $priority = 1)
     {