Skip to content

Commit 58788f8

Browse files
authored
docs: fix phpdoc codeblocks in credentials classes (#661)
1 parent 870c17e commit 58788f8

2 files changed

Lines changed: 35 additions & 31 deletions

File tree

src/Credentials/GCECredentials.php

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -40,23 +40,25 @@
4040
* It can be used to authorize requests using the AuthTokenMiddleware, but will
4141
* only succeed if being run on GCE:
4242
*
43-
* use Google\Auth\Credentials\GCECredentials;
44-
* use Google\Auth\Middleware\AuthTokenMiddleware;
45-
* use GuzzleHttp\Client;
46-
* use GuzzleHttp\HandlerStack;
43+
* ```
44+
* use Google\Auth\Credentials\GCECredentials;
45+
* use Google\Auth\Middleware\AuthTokenMiddleware;
46+
* use GuzzleHttp\Client;
47+
* use GuzzleHttp\HandlerStack;
4748
*
48-
* $gce = new GCECredentials();
49-
* $middleware = new AuthTokenMiddleware($gce);
50-
* $stack = HandlerStack::create();
51-
* $stack->push($middleware);
49+
* $gce = new GCECredentials();
50+
* $middleware = new AuthTokenMiddleware($gce);
51+
* $stack = HandlerStack::create();
52+
* $stack->push($middleware);
5253
*
53-
* $client = new Client([
54-
* 'handler' => $stack,
55-
* 'base_uri' => 'https://www.googleapis.com/taskqueue/v1beta2/projects/',
56-
* 'auth' => 'google_auth'
57-
* ]);
54+
* $client = new Client([
55+
* 'handler' => $stack,
56+
* 'base_uri' => 'https://www.googleapis.com/taskqueue/v1beta2/projects/',
57+
* 'auth' => 'google_auth'
58+
* ]);
5859
*
59-
* $res = $client->get('myproject/taskqueues/myqueue');
60+
* $res = $client->get('myproject/taskqueues/myqueue');
61+
* ```
6062
*/
6163
class GCECredentials extends CredentialsLoader implements
6264
SignBlobInterface,

src/Credentials/ServiceAccountCredentials.php

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -39,26 +39,28 @@
3939
*
4040
* Use it with AuthTokenMiddleware to authorize http requests:
4141
*
42-
* use Google\Auth\Credentials\ServiceAccountCredentials;
43-
* use Google\Auth\Middleware\AuthTokenMiddleware;
44-
* use GuzzleHttp\Client;
45-
* use GuzzleHttp\HandlerStack;
42+
* ```
43+
* use Google\Auth\Credentials\ServiceAccountCredentials;
44+
* use Google\Auth\Middleware\AuthTokenMiddleware;
45+
* use GuzzleHttp\Client;
46+
* use GuzzleHttp\HandlerStack;
4647
*
47-
* $sa = new ServiceAccountCredentials(
48-
* 'https://www.googleapis.com/auth/taskqueue',
49-
* '/path/to/your/json/key_file.json'
50-
* );
51-
* $middleware = new AuthTokenMiddleware($sa);
52-
* $stack = HandlerStack::create();
53-
* $stack->push($middleware);
48+
* $sa = new ServiceAccountCredentials(
49+
* 'https://www.googleapis.com/auth/taskqueue',
50+
* '/path/to/your/json/key_file.json'
51+
* );
52+
* $middleware = new AuthTokenMiddleware($sa);
53+
* $stack = HandlerStack::create();
54+
* $stack->push($middleware);
5455
*
55-
* $client = new Client([
56-
* 'handler' => $stack,
57-
* 'base_uri' => 'https://www.googleapis.com/taskqueue/v1beta2/projects/',
58-
* 'auth' => 'google_auth' // authorize all requests
59-
* ]);
56+
* $client = new Client([
57+
* 'handler' => $stack,
58+
* 'base_uri' => 'https://www.googleapis.com/taskqueue/v1beta2/projects/',
59+
* 'auth' => 'google_auth' // authorize all requests
60+
* ]);
6061
*
61-
* $res = $client->get('myproject/taskqueues/myqueue');
62+
* $res = $client->get('myproject/taskqueues/myqueue');
63+
* ```
6264
*/
6365
class ServiceAccountCredentials extends CredentialsLoader implements
6466
GetQuotaProjectInterface,

0 commit comments

Comments
 (0)