Skip to content

Commit

Permalink
Docblock tweaks
Browse files Browse the repository at this point in the history
Just a few minor tweaks
  • Loading branch information
davidyell committed Nov 20, 2017
1 parent 810d607 commit 199cfa2
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions src/Http/Client.php
Expand Up @@ -28,7 +28,7 @@
* *
* ### Scoped clients * ### Scoped clients
* *
* If you're doing multiple requests to the same hostname its often convenient * If you're doing multiple requests to the same hostname it's often convenient
* to use the constructor arguments to create a scoped client. This allows you * to use the constructor arguments to create a scoped client. This allows you
* to keep your code DRY and not repeat hostnames, authentication, and other options. * to keep your code DRY and not repeat hostnames, authentication, and other options.
* *
Expand Down Expand Up @@ -87,7 +87,7 @@
* ### Using proxies * ### Using proxies
* *
* By using the `proxy` key you can set authentication credentials for * By using the `proxy` key you can set authentication credentials for
* a proxy if you need to use one.. The type sub option can be used to * a proxy if you need to use one. The type sub option can be used to
* specify which authentication strategy you want to use. * specify which authentication strategy you want to use.
* CakePHP comes with built-in support for basic authentication. * CakePHP comes with built-in support for basic authentication.
* *
Expand Down Expand Up @@ -149,7 +149,7 @@ class Client
* Defaults to true. * Defaults to true.
* - ssl_verify_peer_name - Whether or not peer names should be validated. * - ssl_verify_peer_name - Whether or not peer names should be validated.
* Defaults to true. * Defaults to true.
* - ssl_verify_depth - The maximum certificate chain depth to travers. * - ssl_verify_depth - The maximum certificate chain depth to traverse.
* Defaults to 5. * Defaults to 5.
* - ssl_verify_host - Verify that the certificate and hostname match. * - ssl_verify_host - Verify that the certificate and hostname match.
* Defaults to true. * Defaults to true.
Expand Down Expand Up @@ -207,7 +207,7 @@ public function addCookie(CookieInterface $cookie)
* *
* The $data argument supports a special `_content` key * The $data argument supports a special `_content` key
* for providing a request body in a GET request. This is * for providing a request body in a GET request. This is
* generally not used but services like ElasticSearch use * generally not used, but services like ElasticSearch use
* this feature. * this feature.
* *
* @param string $url The url or path you want to request. * @param string $url The url or path you want to request.
Expand Down Expand Up @@ -351,7 +351,7 @@ public function head($url, array $data = [], array $options = [])
* @param string $method HTTP method. * @param string $method HTTP method.
* @param string $url URL to request. * @param string $url URL to request.
* @param mixed $data The request body. * @param mixed $data The request body.
* @param array $options The options to use. Contains auth, proxy etc. * @param array $options The options to use. Contains auth, proxy, etc.
* @return \Cake\Http\Client\Response * @return \Cake\Http\Client\Response
*/ */
protected function _doRequest($method, $url, $data, $options) protected function _doRequest($method, $url, $data, $options)
Expand Down Expand Up @@ -442,7 +442,7 @@ protected function _sendRequest(Request $request, $options)
* @param string $url Either a full URL or just the path. * @param string $url Either a full URL or just the path.
* @param string|array $query The query data for the URL. * @param string|array $query The query data for the URL.
* @param array $options The config options stored with Client::config() * @param array $options The config options stored with Client::config()
* @return string A complete url with scheme, port, host, path. * @return string A complete url with scheme, port, host, and path.
*/ */
public function buildUrl($url, $query = [], $options = []) public function buildUrl($url, $query = [], $options = [])
{ {
Expand Down Expand Up @@ -488,7 +488,7 @@ public function buildUrl($url, $query = [], $options = [])
* @param string $method HTTP method name. * @param string $method HTTP method name.
* @param string $url The url including query string. * @param string $url The url including query string.
* @param mixed $data The request body. * @param mixed $data The request body.
* @param array $options The options to use. Contains auth, proxy etc. * @param array $options The options to use. Contains auth, proxy, etc.
* @return \Cake\Http\Client\Request * @return \Cake\Http\Client\Request
*/ */
protected function _createRequest($method, $url, $data, $options) protected function _createRequest($method, $url, $data, $options)
Expand Down

0 comments on commit 199cfa2

Please sign in to comment.