Skip to content

Commit 76eb2ef

Browse files
committed
Improve documentation for Client URIs
1 parent ec8d64e commit 76eb2ef

1 file changed

Lines changed: 15 additions & 7 deletions

File tree

src/Client.php

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,15 @@
1212
/**
1313
* Docker Remote API client
1414
*
15-
* Primarily tested against current v1.15 API, but should also work against
16-
* other versions.
15+
* The Remote API can be used to control your local Docker daemon.
16+
*
17+
* This Client implementation provides a very thin wrapper around this
18+
* Remote API and exposes its exact data models.
19+
* The Client uses HTTP requests via a local UNIX socket path or remotely via a
20+
* TLS-backed TCP/IP connection.
21+
*
22+
* Primarily tested against v1.15 API, but should also work against
23+
* other versions (in particular newer ones).
1724
*
1825
* @link https://docs.docker.com/reference/api/docker_remote_api_v1.15/
1926
*/
@@ -28,8 +35,9 @@ class Client
2835
*
2936
* SHOULD NOT be called manually, see Factory::createClient() instead
3037
*
31-
* @param Browser $browser
32-
* @param ResponseParser|null $parser
38+
* @param Browser $browser Browser instance to use, requires correct Sender and base URI
39+
* @param ResponseParser|null $parser (optional) ResponseParser instance to use
40+
* @param StreamingParser|null $streamingParser (optional) StreamingParser instance to use
3341
* @see Factory::createClient()
3442
*/
3543
public function __construct(Browser $browser, ResponseParser $parser = null, StreamingParser $streamingParser = null)
@@ -900,11 +908,11 @@ private function authHeaders($registryAuth)
900908
}
901909

902910
/**
903-
* Internal helper function used pass boolean true values to endpoints and omit boolean false values
911+
* Internal helper function used to pass boolean true values to endpoints and omit boolean false values
904912
*
905913
* @param boolean $value
906-
* @return int|numer returns a `1` for boolean true values and a `null` for boolean false values
907-
* @see Browser::url()
914+
* @return int|null returns the integer `1` for boolean true values and a `null` for boolean false values
915+
* @see Browser::resolve()
908916
*/
909917
private function boolArg($value)
910918
{

0 commit comments

Comments
 (0)