Merge pull request #7657 from kenjis/fix-doc-comments

docs: fix doc comments

Author: kenjis

system/CLI/CLI.php

@@ -520,7 +520,7 @@ public static function wait(int $seconds, bool $countdown = false)
     /**
      * if operating system === windows
      *
-     * @deprecated v4.3 Use `is_windows()` instead
+     * @deprecated 4.3.0 Use `is_windows()` instead
      */
     public static function isWindows(): bool
     {

system/Database/OCI8/Connection.php

@@ -98,7 +98,7 @@ class Connection extends BaseConnection
     public $lastInsertedTableName;
 
     /**
-     * confirm DNS format.
+     * confirm DSN format.
      */
     private function isValidDSN(): bool
     {

system/Filters/FilterInterface.php

@@ -31,7 +31,7 @@ interface FilterInterface
      *
      * @param array|null $arguments
      *
-     * @return mixed
+     * @return RequestInterface|ResponseInterface|string|void
      */
     public function before(RequestInterface $request, $arguments = null);
 
@@ -43,7 +43,7 @@ public function before(RequestInterface $request, $arguments = null);
      *
      * @param array|null $arguments
      *
-     * @return mixed
+     * @return ResponseInterface|void
      */
     public function after(RequestInterface $request, ResponseInterface $response, $arguments = null);
 }

system/HTTP/CLIRequest.php

@@ -221,7 +221,7 @@ public function isCLI(): bool
      *
      * @param array|string|null $index  Index for item to fetch from $_GET.
      * @param int|null          $filter A filter name to apply.
-     * @param mixed|null        $flags
+     * @param array|int|null    $flags
      *
      * @return array|null
      */
@@ -235,7 +235,7 @@ public function getGet($index = null, $filter = null, $flags = null)
      *
      * @param array|string|null $index  Index for item to fetch from $_POST.
      * @param int|null          $filter A filter name to apply
-     * @param mixed             $flags
+     * @param array|int|null    $flags
      *
      * @return array|null
      */
@@ -249,7 +249,7 @@ public function getPost($index = null, $filter = null, $flags = null)
      *
      * @param array|string|null $index  Index for item to fetch from $_POST or $_GET
      * @param int|null          $filter A filter name to apply
-     * @param mixed             $flags
+     * @param array|int|null    $flags
      *
      * @return array|null
      */
@@ -263,7 +263,7 @@ public function getPostGet($index = null, $filter = null, $flags = null)
      *
      * @param array|string|null $index  Index for item to be fetched from $_GET or $_POST
      * @param int|null          $filter A filter name to apply
-     * @param mixed             $flags
+     * @param array|int|null    $flags
      *
      * @return array|null
      */

system/HTTP/CURLRequest.php

@@ -263,7 +263,7 @@ public function setForm(array $params, bool $multipart = false)
     /**
      * Set JSON data to be sent.
      *
-     * @param mixed $data
+     * @param array|bool|float|int|object|string|null $data
      *
      * @return $this
      */

system/HTTP/Files/FileCollection.php

@@ -159,7 +159,7 @@ protected function populateFiles()
      * Given a file array, will create UploadedFile instances. Will
      * loop over an array and create objects for each.
      *
-     * @return array|UploadedFile
+     * @return UploadedFile|UploadedFile[]
      */
     protected function createFileObject(array $array)
     {
@@ -240,7 +240,7 @@ protected function fixFilesArray(array $data): array
      * @param array $index The index sequence we are navigating down
      * @param array $value The portion of the array to process
      *
-     * @return mixed
+     * @return UploadedFile|null
      */
     protected function getValueDotNotationSyntax(array $index, array $value)
     {

system/HTTP/MessageInterface.php

@@ -30,7 +30,7 @@ public function getProtocolVersion(): string;
     /**
      * Sets the body of the current message.
      *
-     * @param mixed $data
+     * @param string $data
      *
      * @return $this
      */
@@ -48,7 +48,7 @@ public function getBody();
     /**
      * Appends data to the body of the current message.
      *
-     * @param mixed $data
+     * @param string $data
      *
      * @return $this
      */

system/HTTP/MessageTrait.php

@@ -59,7 +59,7 @@ public function setBody($data): self
     /**
      * Appends data to the body of the current message.
      *
-     * @param mixed $data
+     * @param string $data
      *
      * @return $this
      */

system/HTTP/ResponseTrait.php

@@ -307,7 +307,7 @@ public function getXML()
      * @param array|object|string $body
      * @param string              $format Valid: json, xml
      *
-     * @return mixed
+     * @return false|string
      *
      * @throws InvalidArgumentException If the body property is not string or array.
      */

system/HTTP/URI.php

@@ -557,7 +557,7 @@ public function getSegment(int $number, string $default = ''): string
      * Set the value of a specific segment of the URI path.
      * Allows to set only existing segments or add new one.
      *
-     * @param mixed $value (string or int)
+     * @param int|string $value (string or int)
      *
      * @return $this
      */
@@ -844,7 +844,7 @@ public function setQueryArray(array $query)
     /**
      * Adds a single new element to the query vars.
      *
-     * @param mixed $value
+     * @param int|string $value
      *
      * @return $this
      */