Clean up promoted constructor docs

Author: stevebauman

src/Documents/Document.php

@@ -7,19 +7,11 @@ class Document
     /**
      * Create a new document instance.
      *
+     * @param  string  $id  The OpenSearch document identifier.
      * @param  array<string, mixed>  $content
      */
     public function __construct(
-        /**
-         * The OpenSearch document identifier.
-         */
         protected string $id,
-
-        /**
-         * The document source payload.
-         *
-         * @var array<string, mixed>
-         */
         protected array $content,
     ) {}
 

src/Documents/DocumentManager.php

@@ -13,9 +13,6 @@ class DocumentManager
      * Create a new document manager instance.
      */
     public function __construct(
-        /**
-         * The OpenSearch client instance.
-         */
         protected Client $client,
     ) {}
 

src/Exceptions/BulkRequestException.php

@@ -12,11 +12,6 @@ class BulkRequestException extends ErrorException
      * @param  array<string, mixed>  $response
      */
     public function __construct(
-        /**
-         * The OpenSearch bulk response.
-         *
-         * @var array<string, mixed>
-         */
         protected array $response,
     ) {
         parent::__construct($this->makeErrorFromResponse());

src/Indices/Alias.php

@@ -7,24 +7,13 @@ class Alias
     /**
      * Create a new alias instance.
      *
+     * @param  string  $name  The alias name.
      * @param  array<string, mixed>|null  $filter
+     * @param  string|null  $routing  The optional alias routing value.
      */
     public function __construct(
-        /**
-         * The alias name.
-         */
         protected string $name,
-
-        /**
-         * The optional alias filter.
-         *
-         * @var array<string, mixed>|null
-         */
         protected ?array $filter = null,
-
-        /**
-         * The optional alias routing value.
-         */
         protected ?string $routing = null,
     ) {}
 

src/Indices/IndexBlueprint.php

@@ -6,21 +6,12 @@ class IndexBlueprint
 {
     /**
      * Create a new index blueprint instance.
+     *
+     * @param  string  $name  The index name.
      */
     public function __construct(
-        /**
-         * The index name.
-         */
         protected string $name,
-
-        /**
-         * The index mapping definition.
-         */
         protected ?Mapping $mapping = null,
-
-        /**
-         * The index settings definition.
-         */
         protected ?Settings $settings = null,
     ) {}
 

src/Search/Aggregation.php

@@ -10,11 +10,6 @@ class Aggregation implements RawResponseInterface
      * @param  array<string, mixed>  $aggregation
      */
     public function __construct(
-        /**
-         * The raw OpenSearch aggregation payload.
-         *
-         * @var array<string, mixed>
-         */
         protected array $aggregation,
     ) {}
 

src/Search/Bucket.php

@@ -10,11 +10,6 @@ class Bucket implements RawResponseInterface
      * @param  array<string, mixed>  $bucket
      */
     public function __construct(
-        /**
-         * The raw OpenSearch bucket payload.
-         *
-         * @var array<string, mixed>
-         */
         protected array $bucket,
     ) {}
 

src/Search/Highlight.php

@@ -10,11 +10,6 @@ class Highlight implements RawResponseInterface
      * @param  array<string, array<int, string>>  $highlight
      */
     public function __construct(
-        /**
-         * The raw OpenSearch highlight payload.
-         *
-         * @var array<string, array<int, string>>
-         */
         protected array $highlight,
     ) {}
 

src/Search/Hit.php

@@ -12,11 +12,6 @@ class Hit implements RawResponseInterface
      * @param  array<string, mixed>  $hit
      */
     public function __construct(
-        /**
-         * The raw OpenSearch hit payload.
-         *
-         * @var array<string, mixed>
-         */
         protected array $hit,
     ) {}
 

src/Search/SearchResponse.php

@@ -10,11 +10,6 @@ class SearchResponse implements RawResponseInterface
      * @param  array<string, mixed>  $response
      */
     public function __construct(
-        /**
-         * The raw OpenSearch search response.
-         *
-         * @var array<string, mixed>
-         */
         protected array $response,
     ) {}