Update php-doc annotations

lib/Elastica/Aggregation/BucketSelector.php

@@ -25,11 +25,9 @@ public function __construct(string $name, ?array $bucketsPath = null, ?string $s
     /**
      * Set the buckets_path for this aggregation.
      *
-     * @param array $bucketsPath
-     *
      * @return $this
      */
-    public function setBucketsPath($bucketsPath)
+    public function setBucketsPath(array $bucketsPath): self
     {
         return $this->setParam('buckets_path', $bucketsPath);
     }
@@ -39,7 +37,7 @@ public function setBucketsPath($bucketsPath)
      *
      * @return $this
      */
-    public function setGapPolicy(string $gapPolicy = 'skip')
+    public function setGapPolicy(string $gapPolicy = 'skip'): self
     {
         return $this->setParam('gap_policy', $gapPolicy);
     }

lib/Elastica/Aggregation/Derivative.php

@@ -25,7 +25,7 @@ public function __construct(string $name, ?string $bucketsPath = null)
      *
      * @return $this
      */
-    public function setBucketsPath(string $bucketsPath)
+    public function setBucketsPath(string $bucketsPath): self
     {
         return $this->setParam('buckets_path', $bucketsPath);
     }
@@ -35,7 +35,7 @@ public function setBucketsPath(string $bucketsPath)
      *
      * @return $this
      */
-    public function setGapPolicy(string $gapPolicy = 'skip')
+    public function setGapPolicy(string $gapPolicy = 'skip'): self
     {
         return $this->setParam('gap_policy', $gapPolicy);
     }
@@ -45,7 +45,7 @@ public function setGapPolicy(string $gapPolicy = 'skip')
      *
      * @return $this
      */
-    public function setFormat(string $format)
+    public function setFormat(string $format): self
     {
         return $this->setParam('format', $format);
     }

lib/Elastica/Aggregation/Filter.php

@@ -12,9 +12,6 @@
  */
 class Filter extends AbstractAggregation
 {
-    /**
-     * @param AbstractQuery $filter
-     */
     public function __construct(string $name, ?AbstractQuery $filter = null)
     {
         parent::__construct($name);
@@ -29,7 +26,7 @@ public function __construct(string $name, ?AbstractQuery $filter = null)
      *
      * @return $this
      */
-    public function setFilter(AbstractQuery $filter)
+    public function setFilter(AbstractQuery $filter): self
     {
         return $this->setParam('filter', $filter);
     }

lib/Elastica/Aggregation/Filters.php

@@ -25,8 +25,6 @@ class Filters extends AbstractAggregation
      *
      * If a name is given, it will be added as a key, otherwise considered as an anonymous filter
      *
-     * @param string $name
-     *
      * @return $this
      */
     public function addFilter(AbstractQuery $filter, ?string $name = null): self

lib/Elastica/Aggregation/Range.php

@@ -22,7 +22,7 @@ class Range extends AbstractSimpleAggregation
      *
      * @return $this
      */
-    public function addRange($fromValue = null, $toValue = null, ?string $key = null)
+    public function addRange($fromValue = null, $toValue = null, ?string $key = null): self
     {
         if (null === $fromValue && null === $toValue) {
             throw new InvalidException('Either fromValue or toValue must be set. Both cannot be null.');
@@ -50,7 +50,7 @@ public function addRange($fromValue = null, $toValue = null, ?string $key = null
      *
      * @return $this
      */
-    public function setKeyedResponse(bool $keyed = true)
+    public function setKeyedResponse(bool $keyed = true): self
     {
         return $this->setParam('keyed', $keyed);
     }

lib/Elastica/Aggregation/ReverseNested.php

@@ -27,7 +27,7 @@ public function __construct(string $name, ?string $path = null)
      *
      * @return $this
      */
-    public function setPath(string $path)
+    public function setPath(string $path): self
     {
         return $this->setParam('path', $path);
     }

lib/Elastica/Aggregation/SerialDiff.php

@@ -55,8 +55,6 @@ public function setGapPolicy(string $gapPolicy): self
     /**
      * Set the format for this aggregation.
      *
-     * @param string $format
-     *
      * @return $this
      */
     public function setFormat(?string $format = null): self

lib/Elastica/Bulk.php

@@ -118,8 +118,6 @@ public function getActions(): array
     }
 
     /**
-     * @param string $opType
-     *
      * @return $this
      */
     public function addDocument(Document $document, ?string $opType = null): self
@@ -131,7 +129,6 @@ public function addDocument(Document $document, ?string $opType = null): self
 
     /**
      * @param Document[] $documents
-     * @param string     $opType
      *
      * @return $this
      */
@@ -145,8 +142,6 @@ public function addDocuments(array $documents, ?string $opType = null): self
     }
 
     /**
-     * @param string $opType
-     *
      * @return $this
      */
     public function addScript(AbstractScript $script, ?string $opType = null): self
@@ -158,7 +153,6 @@ public function addScript(AbstractScript $script, ?string $opType = null): self
 
     /**
      * @param Document[] $scripts
-     * @param string     $opType
      *
      * @return $this
      */
@@ -173,7 +167,6 @@ public function addScripts(array $scripts, $opType = null): self
 
     /**
      * @param \Elastica\Script\AbstractScript|\Elastica\Document|array $data
-     * @param string                                                   $opType
      *
      * @return $this
      */

lib/Elastica/Client.php

@@ -58,9 +58,8 @@ class Client
     /**
      * Creates a new Elastica client.
      *
-     * @param array|string    $config   OPTIONAL Additional config or DSN of options
-     * @param callback|null   $callback OPTIONAL Callback function which can be used to be notified about errors (for example connection down)
-     * @param LoggerInterface $logger
+     * @param array|string  $config   OPTIONAL Additional config or DSN of options
+     * @param callback|null $callback OPTIONAL Callback function which can be used to be notified about errors (for example connection down)
      *
      * @throws \Elastica\Exception\InvalidException
      */

lib/Elastica/Exception/Connection/GuzzleException.php

@@ -20,9 +20,6 @@ class GuzzleException extends ConnectionException
      */
     protected $_guzzleException;
 
-    /**
-     * @param Request $request
-     */
     public function __construct(TransferException $guzzleException, ?Request $request = null, ?Response $response = null)
     {
         $this->_guzzleException = $guzzleException;

lib/Elastica/Multi/Search.php

@@ -49,8 +49,6 @@ class Search
 
     /**
      * Constructs search object.
-     *
-     * @param MultiBuilderInterface $builder
      */
     public function __construct(Client $client, ?MultiBuilderInterface $builder = null)
     {
@@ -74,8 +72,6 @@ public function clearSearches(): self
     }
 
     /**
-     * @param string $key
-     *
      * @return $this
      */
     public function addSearch(BaseSearch $search, ?string $key = null): self

lib/Elastica/Util.php

@@ -198,11 +198,9 @@ public static function convertDate($date)
      *
      * Converts it to the lucene format, including the appropriate TimeZone
      *
-     * @param bool $includeTimezone
-     *
      * @return string
      */
-    public static function convertDateTimeObject(\DateTime $dateTime, $includeTimezone = true)
+    public static function convertDateTimeObject(\DateTime $dateTime, bool $includeTimezone = true)
     {
         $formatString = 'Y-m-d\TH:i:s'.(true === $includeTimezone ? 'P' : '\Z');
         $string = $dateTime->format($formatString);