cleanup phpdocs

symfony · Lctrs · Jan 21, 2025 · Jan 22, 2025 · Jan 22, 2025 · Jan 22, 2025
commit 288a2a26022d59bd14ba86d887b8f79ec8575a1c
diff --git a/src/Symfony/Component/HttpClient/CachingHttpClient.php b/src/Symfony/Component/HttpClient/CachingHttpClient.php
@@ -449,7 +449,7 @@ private function buildVariantKey(array $normalizedHeaders, array $varyFields): s
      * Parse the Cache-Control header and return an array of directive names as keys
      * and their values as values, or true if the directive has no value.
      *
-     * @param string[] $header the Cache-Control header as an array of strings
+     * @param array<string, string|string[]> $header the Cache-Control header as an array of strings
      *
      * @return array<string, string|true> the parsed Cache-Control directives
      */
@@ -474,15 +474,9 @@ private function parseCacheControlHeader(array $header): array
      * Evaluates the freshness of a cached response based on its headers and expiration time.
      *
      * This method determines the state of the cached response by analyzing the Cache-Control
-     * directives and the expiration timestamp. It returns one of the following states:
-     * - 'fresh': if the cached response is still valid or has no expiration.
-     * - 'must-revalidate': if the response must be revalidated before use.
-     * - 'stale-but-usable': if the response is stale but can be used in case of errors.
-     * - 'stale': if the cached response is no longer valid or usable.
+     * directives and the expiration timestamp.
      *
-     * @param array $data the cached response data, including headers and expiration time
-     *
-     * @return string the freshness status of the cached response
+     * @param array{headers: array<string, string[]>, expires_at: int|null} $data the cached response data, including headers and expiration time
      */
     private function evaluateCachedFreshness(array $data): string
     {
@@ -598,12 +592,9 @@ private function calculateExpiresAt(?int $maxAge): ?int
      * This function will return true if the server response can be cached,
      * false otherwise.
      *
-     * @param int                            $statusCode      the HTTP status code of the response
-     * @param array<string, string|string[]> $requestHeaders  the HTTP request headers
-     * @param array<string, string|string[]> $responseHeaders the HTTP response headers
-     * @param array<string, string|true>     $cacheControl    an array of parsed Cache-Control directives
-     *
-     * @return bool true if the response is cacheable, false otherwise
+     * @param array<string, string|string[]> $requestHeaders
+     * @param array<string, string|string[]> $responseHeaders
+     * @param array<string, string|true>     $cacheControl
      */
     private function isServerResponseCacheable(int $statusCode, array $requestHeaders, array $responseHeaders, array $cacheControl): bool
     {
@@ -659,13 +650,7 @@ private function hasExplicitExpiration(array $headers, array $cacheControl): boo
      * response headers and content. The constructed MockResponse is then
      * returned.
      *
-     * @param string $key        the cache key for the response
-     * @param array  $cachedData the cached data for the response
-     * @param string $method     the original request method
-     * @param string $url        the original request URL
-     * @param array  $options    the original request options
-     *
-     * @return MockResponse the constructed MockResponse object
+     * @param array{chunks_count: int, status_code: int, initial_age: int, headers: array<string, string|string[]>, stored_at: int} $cachedData
      */
     private function createResponseFromCache(string $key, array $cachedData, string $method, string $url, array $options): MockResponse
     {