Merge pull request #65 from php-http/array-shape-doc

use array shape for phpdoc
php-http · Sep 1, 2024 · 02a0e13 · 02a0e13
2 parents 4087940 + ad3d012
commit 02a0e13
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/src/MultipartStreamBuilder.php b/src/MultipartStreamBuilder.php
@@ -91,13 +91,13 @@ public function addData($resource, array $headers = [])
     /**
      * Add a resource to the Multipart Stream.
      *
-     * @param string                          $name     the formpost name
-     * @param string|resource|StreamInterface $resource
-     * @param array                           $options  {
+     * @param string                                                      $name     the formpost name
+     * @param string|resource|StreamInterface                             $resource
+     * @param array{'headers': array<string, string>, 'filename': string} $options
      *
-     * @var array  $headers additional headers ['header-name' => 'header-value']
-     * @var string $filename
-     *             }
+     * Options:
+     * - headers: additional headers as hashmap ['header-name' => 'header-value']
+     * - filename: used to determine the mime type
      *
      * @return MultipartStreamBuilder
      */