Changeset 35937

Timestamp:

12/14/2015 11:40:55 PM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Add missing parameter and return descriptions to the DocBlock for WP_Http_Curl::stream_body().

See #32246.

File:

• trunk/src/wp-includes/class-wp-http-curl.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-http-curl.php

@@ -317 +317 @@
 
     /**
-     * Grab 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
+     * 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`.
      *
      * @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 ) {