Stricter docs for WP_Http::processHeaders()

[marekdedic]

I believe the function could better document the parameter and return types. From a look at the source, maybe something like this:

@param string|string[] $headers
@param string          $url

@return array {
    @type array $response {
        @type int    $code
        @type string $message
    }
    @type string|string[]  $newheaders
    @type WP_Http_Cookie[] $cookies
}

+ comments obviously.

[valchovski]

Heya!

Attached a file containing expanded documentation for processHeaders().

Looking forward to any feedback!

[davidbaumwald]

@SergeyBiryukov Are you still reviewing this one for 5.4?

[davidbaumwald]

The most recent patch fails against trunk. This ticket still needs a refreshed patch, and with 5.4 Beta 1 landing tomorrow, this is being moved to Future Release. If any maintainer or committer feels this can be included in 5.4 or wishes to assume ownership during a specific cycle, feel free to update the milestone accordingly.

[deepaklalwani]

Refreshes patch

[deepaklalwani]

Fix parameter alignment and add parameter default value details

[thimalw]

Fix a typo that was already fixed in trunk

[SergeyBiryukov]

In 48630:

Docs: Improve documentation for WP_Http::processHeaders().

Document the @return value using hash notation.

Props marekdedic, valchovski, davidbaumwald, deepaklalwani, thimalw, SergeyBiryukov.
Fixes #48350.