From e20a31a888cead3428f3acda096d9180c2dca137 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Mon, 14 Dec 2015 23:40:55 +0000 Subject: [PATCH] Docs: Add missing parameter and return descriptions to the DocBlock for `WP_Http_Curl::stream_body()`. See #32246. git-svn-id: https://develop.svn.wordpress.org/trunk@35937 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/class-wp-http-curl.php | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/src/wp-includes/class-wp-http-curl.php b/src/wp-includes/class-wp-http-curl.php index 3339a5e3f7..8271d9de62 100644 --- a/src/wp-includes/class-wp-http-curl.php +++ b/src/wp-includes/class-wp-http-curl.php @@ -316,14 +316,18 @@ class WP_Http_Curl { } /** - * Grab the body of the cURL request + * Grabs the body of the cURL request. * - * The contents of the document are passed in chunks, so we append to the $body property for temporary storage. - * Returning a length shorter than the length of $data passed in will cause cURL to abort the request with CURLE_WRITE_ERROR + * The contents of the document are passed in chunks, so we append to the `$body` + * property for temporary storage. Returning a length shorter than the length of + * `$data` passed in will cause cURL to abort the request with `CURLE_WRITE_ERROR`. * * @since 3.6.0 * @access private - * @return int + * + * @param resource $handle cURL handle. + * @param string $headers cURL request headers. + * @return int Total bytes of data written. */ private function stream_body( $handle, $data ) { $data_length = strlen( $data );