From 652ad4712d2d0d4c96743a29694ac946241d089c Mon Sep 17 00:00:00 2001 From: ozh Date: Fri, 17 Jan 2014 20:53:58 +0100 Subject: [PATCH] Fix phpdoc comments --- includes/functions-http.php | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/includes/functions-http.php b/includes/functions-http.php index 8856bea..43a88b8 100644 --- a/includes/functions-http.php +++ b/includes/functions-http.php @@ -2,12 +2,8 @@ /** * Functions that relate to HTTP requests * - */ - -/** * On functions using the 3rd party library Requests: - * - * The goal here is to provide convenient wrapper functions to the Requests library. There are + * Thir goal here is to provide convenient wrapper functions to the Requests library. There are * 2 types of functions for each METHOD, where METHOD is 'get' or 'post' (implement more as needed) * - yourls_http_METHOD() : * Return a complete Response object (with ->body, ->headers, ->status_code, etc...) or @@ -170,8 +166,12 @@ function yourls_send_through_proxy( $url ) { * Perform a HTTP request, return response object * * @since 1.7 - * @param string $var Stuff - * @return string Result + * @param string $type HTTP request type (GET, POST) + * @param string $url URL to request + * @param array $headers Extra headers to send with the request + * @param array $data Data to send either as a query string for GET requests, or in the body for POST requests + * @param array $options Options for the request (see /includes/Requests/Requests.php:request()) + * @return object Requests_Response object */ function yourls_http_request( $type, $url, $headers, $data, $options ) { yourls_http_load_library(); -- 2.45.0