Skip to content

Commit 281aa03

Browse files
GrahamCampbellGrahamCampbell
committed
Regenerated docs
1 parent 8f8e389 commit 281aa03

14 files changed

+1403
-109
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
composer.lock
33
phpunit.xml
44
sami
5+
sami.phar
56
vendor

‎docs/Bitbucket/Api/Repositories/Users.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -405,10 +405,10 @@ <h2>Methods</h2>
405405
</div>
406406
<div class="row">
407407
<div class="col-md-2 type">
408-
<a href="../../../Bitbucket/Api/Repositories/Users/DiffStats.html"><abbr title="Bitbucket\Api\Repositories\Users\DiffStats">DiffStats</abbr></a>
408+
<a href="../../../Bitbucket/Api/Repositories/Users/DiffStat.html"><abbr title="Bitbucket\Api\Repositories\Users\DiffStat">DiffStat</abbr></a>
409409
</div>
410410
<div class="col-md-8 type">
411-
<a href="#method_diffStats">diffStats</a>(string $repo)
411+
<a href="#method_diffStat">diffStat</a>(string $repo)
412412

413413
<p class="no-description">No description</p>
414414
</div>
@@ -1870,10 +1870,10 @@ <h4>Return Value</h4>
18701870

18711871
</div>
18721872
<div class="method-item">
1873-
<h3 id="method_diffStats">
1873+
<h3 id="method_diffStat">
18741874
<div class="location">at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/Repositories/Users.php#L219">line 219</a></div>
1875-
<code> <a href="../../../Bitbucket/Api/Repositories/Users/DiffStats.html"><abbr title="Bitbucket\Api\Repositories\Users\DiffStats">DiffStats</abbr></a>
1876-
<strong>diffStats</strong>(string $repo)
1875+
<code> <a href="../../../Bitbucket/Api/Repositories/Users/DiffStat.html"><abbr title="Bitbucket\Api\Repositories\Users\DiffStat">DiffStat</abbr></a>
1876+
<strong>diffStat</strong>(string $repo)
18771877
</code>
18781878
</h3>
18791879
<div class="details">
@@ -1896,7 +1896,7 @@ <h4>Return Value</h4>
18961896

18971897
<table class="table table-condensed">
18981898
<tr>
1899-
<td><a href="../../../Bitbucket/Api/Repositories/Users/DiffStats.html"><abbr title="Bitbucket\Api\Repositories\Users\DiffStats">DiffStats</abbr></a></td>
1899+
<td><a href="../../../Bitbucket/Api/Repositories/Users/DiffStat.html"><abbr title="Bitbucket\Api\Repositories\Users\DiffStat">DiffStat</abbr></a></td>
19001900
<td></td>
19011901
</tr>
19021902
</table>

‎docs/Bitbucket/Api/Repositories/Users/DiffStat.html

Lines changed: 1071 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/Bitbucket/Api/Repositories/Users/Patches.html

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,18 @@ <h1>
8989
<p>The patches api class.</p> </div>
9090

9191

92+
<h2>Constants</h2>
93+
94+
<table class="table table-condensed">
95+
<tr>
96+
<td>URI_SEPARATOR</td>
97+
<td class="last">
98+
<p><em>The URI path separator.</em></p>
99+
<p></p>
100+
</td>
101+
</tr>
102+
</table>
103+
92104

93105
<h2>Properties</h2>
94106

@@ -324,7 +336,7 @@ <h4>Return Value</h4>
324336
</div>
325337
<div class="method-item">
326338
<h3 id="method_getPerPage">
327-
<div class="location">in <a href="../../../../Bitbucket/Api/AbstractApi.html#method_getPerPage"><abbr title="Bitbucket\Api\AbstractApi">AbstractApi</abbr></a> at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/AbstractApi.php#L59">line 59</a></div>
339+
<div class="location">in <a href="../../../../Bitbucket/Api/AbstractApi.html#method_getPerPage"><abbr title="Bitbucket\Api\AbstractApi">AbstractApi</abbr></a> at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/AbstractApi.php#L66">line 66</a></div>
328340
<code> int|null
329341
<strong>getPerPage</strong>()
330342
</code>
@@ -354,7 +366,7 @@ <h4>Return Value</h4>
354366
</div>
355367
<div class="method-item">
356368
<h3 id="method_setPerPage">
357-
<div class="location">in <a href="../../../../Bitbucket/Api/AbstractApi.html#method_setPerPage"><abbr title="Bitbucket\Api\AbstractApi">AbstractApi</abbr></a> at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/AbstractApi.php#L71">line 71</a></div>
369+
<div class="location">in <a href="../../../../Bitbucket/Api/AbstractApi.html#method_setPerPage"><abbr title="Bitbucket\Api\AbstractApi">AbstractApi</abbr></a> at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/AbstractApi.php#L78">line 78</a></div>
358370
<code> void
359371
<strong>setPerPage</strong>(int $perPage = null)
360372
</code>
@@ -394,7 +406,7 @@ <h4>Return Value</h4>
394406
</div>
395407
<div class="method-item">
396408
<h3 id="method_getHttpClient">
397-
<div class="location">in <a href="../../../../Bitbucket/Api/AbstractApi.html#method_getHttpClient"><abbr title="Bitbucket\Api\AbstractApi">AbstractApi</abbr></a> at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/AbstractApi.php#L81">line 81</a></div>
409+
<div class="location">in <a href="../../../../Bitbucket/Api/AbstractApi.html#method_getHttpClient"><abbr title="Bitbucket\Api\AbstractApi">AbstractApi</abbr></a> at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/AbstractApi.php#L88">line 88</a></div>
398410
<code> protected <abbr title="Http\Client\Common\HttpMethodsClient">HttpMethodsClient</abbr>
399411
<strong>getHttpClient</strong>()
400412
</code>
@@ -424,7 +436,7 @@ <h4>Return Value</h4>
424436
</div>
425437
<div class="method-item">
426438
<h3 id="method_get">
427-
<div class="location">in <a href="../../../../Bitbucket/Api/AbstractApi.html#method_get"><abbr title="Bitbucket\Api\AbstractApi">AbstractApi</abbr></a> at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/AbstractApi.php#L97">line 97</a></div>
439+
<div class="location">in <a href="../../../../Bitbucket/Api/AbstractApi.html#method_get"><abbr title="Bitbucket\Api\AbstractApi">AbstractApi</abbr></a> at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/AbstractApi.php#L104">line 104</a></div>
428440
<code> protected array
429441
<strong>get</strong>(string $path, array $params = [], array $headers = [])
430442
</code>
@@ -483,7 +495,7 @@ <h4>Exceptions</h4>
483495
</div>
484496
<div class="method-item">
485497
<h3 id="method_pureGet">
486-
<div class="location">in <a href="../../../../Bitbucket/Api/AbstractApi.html#method_pureGet"><abbr title="Bitbucket\Api\AbstractApi">AbstractApi</abbr></a> at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/AbstractApi.php#L115">line 115</a></div>
498+
<div class="location">in <a href="../../../../Bitbucket/Api/AbstractApi.html#method_pureGet"><abbr title="Bitbucket\Api\AbstractApi">AbstractApi</abbr></a> at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/AbstractApi.php#L122">line 122</a></div>
487499
<code> protected <abbr title="Psr\Http\Message\ResponseInterface">ResponseInterface</abbr>
488500
<strong>pureGet</strong>(string $path, array $params = [], array $headers = [])
489501
</code>
@@ -542,7 +554,7 @@ <h4>Exceptions</h4>
542554
</div>
543555
<div class="method-item">
544556
<h3 id="method_post">
545-
<div class="location">in <a href="../../../../Bitbucket/Api/AbstractApi.html#method_post"><abbr title="Bitbucket\Api\AbstractApi">AbstractApi</abbr></a> at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/AbstractApi.php#L139">line 139</a></div>
557+
<div class="location">in <a href="../../../../Bitbucket/Api/AbstractApi.html#method_post"><abbr title="Bitbucket\Api\AbstractApi">AbstractApi</abbr></a> at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/AbstractApi.php#L146">line 146</a></div>
546558
<code> protected array
547559
<strong>post</strong>(string $path, array $params = [], array $headers = [])
548560
</code>
@@ -601,7 +613,7 @@ <h4>Exceptions</h4>
601613
</div>
602614
<div class="method-item">
603615
<h3 id="method_postRaw">
604-
<div class="location">in <a href="../../../../Bitbucket/Api/AbstractApi.html#method_postRaw"><abbr title="Bitbucket\Api\AbstractApi">AbstractApi</abbr></a> at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/AbstractApi.php#L161">line 161</a></div>
616+
<div class="location">in <a href="../../../../Bitbucket/Api/AbstractApi.html#method_postRaw"><abbr title="Bitbucket\Api\AbstractApi">AbstractApi</abbr></a> at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/AbstractApi.php#L168">line 168</a></div>
605617
<code> protected array
606618
<strong>postRaw</strong>(string $path, string|<abbr title="Psr\Http\Message\StreamInterface">StreamInterface</abbr>|null $body = null, array $headers = [])
607619
</code>
@@ -660,7 +672,7 @@ <h4>Exceptions</h4>
660672
</div>
661673
<div class="method-item">
662674
<h3 id="method_put">
663-
<div class="location">in <a href="../../../../Bitbucket/Api/AbstractApi.html#method_put"><abbr title="Bitbucket\Api\AbstractApi">AbstractApi</abbr></a> at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/AbstractApi.php#L179">line 179</a></div>
675+
<div class="location">in <a href="../../../../Bitbucket/Api/AbstractApi.html#method_put"><abbr title="Bitbucket\Api\AbstractApi">AbstractApi</abbr></a> at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/AbstractApi.php#L186">line 186</a></div>
664676
<code> protected array
665677
<strong>put</strong>(string $path, array $params = [], array $headers = [])
666678
</code>
@@ -719,7 +731,7 @@ <h4>Exceptions</h4>
719731
</div>
720732
<div class="method-item">
721733
<h3 id="method_putRaw">
722-
<div class="location">in <a href="../../../../Bitbucket/Api/AbstractApi.html#method_putRaw"><abbr title="Bitbucket\Api\AbstractApi">AbstractApi</abbr></a> at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/AbstractApi.php#L201">line 201</a></div>
734+
<div class="location">in <a href="../../../../Bitbucket/Api/AbstractApi.html#method_putRaw"><abbr title="Bitbucket\Api\AbstractApi">AbstractApi</abbr></a> at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/AbstractApi.php#L208">line 208</a></div>
723735
<code> protected array
724736
<strong>putRaw</strong>(string $path, string|<abbr title="Psr\Http\Message\StreamInterface">StreamInterface</abbr>|null $body = null, array $headers = [])
725737
</code>
@@ -778,7 +790,7 @@ <h4>Exceptions</h4>
778790
</div>
779791
<div class="method-item">
780792
<h3 id="method_delete">
781-
<div class="location">in <a href="../../../../Bitbucket/Api/AbstractApi.html#method_delete"><abbr title="Bitbucket\Api\AbstractApi">AbstractApi</abbr></a> at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/AbstractApi.php#L219">line 219</a></div>
793+
<div class="location">in <a href="../../../../Bitbucket/Api/AbstractApi.html#method_delete"><abbr title="Bitbucket\Api\AbstractApi">AbstractApi</abbr></a> at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/AbstractApi.php#L226">line 226</a></div>
782794
<code> protected array
783795
<strong>delete</strong>(string $path, array $params = [], array $headers = [])
784796
</code>
@@ -837,7 +849,7 @@ <h4>Exceptions</h4>
837849
</div>
838850
<div class="method-item">
839851
<h3 id="method_deleteRaw">
840-
<div class="location">in <a href="../../../../Bitbucket/Api/AbstractApi.html#method_deleteRaw"><abbr title="Bitbucket\Api\AbstractApi">AbstractApi</abbr></a> at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/AbstractApi.php#L241">line 241</a></div>
852+
<div class="location">in <a href="../../../../Bitbucket/Api/AbstractApi.html#method_deleteRaw"><abbr title="Bitbucket\Api\AbstractApi">AbstractApi</abbr></a> at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/AbstractApi.php#L248">line 248</a></div>
841853
<code> protected array
842854
<strong>deleteRaw</strong>(string $path, string|<abbr title="Psr\Http\Message\StreamInterface">StreamInterface</abbr>|null $body = null, array $headers = [])
843855
</code>
@@ -896,7 +908,7 @@ <h4>Exceptions</h4>
896908
</div>
897909
<div class="method-item">
898910
<h3 id="method_buildPath">
899-
<div class="location">in <a href="../../../../Bitbucket/Api/AbstractApi.html#method_buildPath"><abbr title="Bitbucket\Api\AbstractApi">AbstractApi</abbr></a> at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/AbstractApi.php#L257">line 257</a></div>
911+
<div class="location">in <a href="../../../../Bitbucket/Api/AbstractApi.html#method_buildPath"><abbr title="Bitbucket\Api\AbstractApi">AbstractApi</abbr></a> at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/AbstractApi.php#L264">line 264</a></div>
900912
<code> static protected string
901913
<strong>buildPath</strong>(string ...$parts)
902914
</code>

‎docs/Bitbucket/Api/Users/Properties.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -287,9 +287,9 @@ <h2>Methods</h2>
287287
string
288288
</div>
289289
<div class="col-md-8 type">
290-
<a href="#method_buildRepositoriesPath">buildRepositoriesPath</a>(string ...$parts)
290+
<a href="#method_buildPropertiesPath">buildPropertiesPath</a>(string ...$parts)
291291

292-
<p>Build the repositories path from the given parts.</p> </div>
292+
<p>Build the properties path from the given parts.</p> </div>
293293
<div class="col-md-2"></div>
294294
</div>
295295
</div>
@@ -1136,18 +1136,18 @@ <h4>Exceptions</h4>
11361136

11371137
</div>
11381138
<div class="method-item">
1139-
<h3 id="method_buildRepositoriesPath">
1139+
<h3 id="method_buildPropertiesPath">
11401140
<div class="location">at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/Api/Users/Properties.php#L80">line 80</a></div>
11411141
<code> protected string
1142-
<strong>buildRepositoriesPath</strong>(string ...$parts)
1142+
<strong>buildPropertiesPath</strong>(string ...$parts)
11431143
</code>
11441144
</h3>
11451145
<div class="details">
11461146

11471147

11481148

11491149
<div class="method-description">
1150-
<p>Build the repositories path from the given parts.</p> </div>
1150+
<p>Build the properties path from the given parts.</p> </div>
11511151
<div class="tags">
11521152
<h4>Parameters</h4>
11531153

‎docs/Bitbucket/HttpClient/Plugin/Authentication.html

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,20 @@ <h1>
8989
<div class="description">
9090
<p>A plugin to add authentication to the request.</p> </div>
9191

92+
<h2>Traits</h2>
93+
94+
95+
<div class="container-fluid underlined">
96+
<div class="row">
97+
<div class="col-md-6">
98+
<abbr title="Http\Client\Common\Plugin\VersionBridgePlugin">VersionBridgePlugin</abbr>
99+
100+
</div>
101+
<div class="col-md-6">
102+
103+
</div>
104+
</div>
105+
</div>
92106

93107

94108

@@ -110,7 +124,7 @@ <h2>Methods</h2>
110124
<abbr title="Http\Promise\Promise">Promise</abbr>
111125
</div>
112126
<div class="col-md-8 type">
113-
<a href="#method_handleRequest">handleRequest</a>(<abbr title="Psr\Http\Message\RequestInterface">RequestInterface</abbr> $request, callable $next, callable $first)
127+
<a href="#method_doHandleRequest">doHandleRequest</a>(<abbr title="Psr\Http\Message\RequestInterface">RequestInterface</abbr> $request, callable $next, callable $first)
114128

115129
<p>Handle the request and return the response coming from the next callable.</p> </div>
116130
<div class="col-md-2"></div>
@@ -133,7 +147,7 @@ <h2>Details</h2>
133147
<div id="method-details">
134148
<div class="method-item">
135149
<h3 id="method___construct">
136-
<div class="location">at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/HttpClient/Plugin/Authentication.php#L45">line 45</a></div>
150+
<div class="location">at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/HttpClient/Plugin/Authentication.php#L47">line 47</a></div>
137151
<code> void
138152
<strong>__construct</strong>(string $method, string $token, string $password = null)
139153
</code>
@@ -182,10 +196,10 @@ <h4>Return Value</h4>
182196

183197
</div>
184198
<div class="method-item">
185-
<h3 id="method_handleRequest">
186-
<div class="location">at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/HttpClient/Plugin/Authentication.php#L59">line 59</a></div>
199+
<h3 id="method_doHandleRequest">
200+
<div class="location">at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/HttpClient/Plugin/Authentication.php#L61">line 61</a></div>
187201
<code> <abbr title="Http\Promise\Promise">Promise</abbr>
188-
<strong>handleRequest</strong>(<abbr title="Psr\Http\Message\RequestInterface">RequestInterface</abbr> $request, callable $next, callable $first)
202+
<strong>doHandleRequest</strong>(<abbr title="Psr\Http\Message\RequestInterface">RequestInterface</abbr> $request, callable $next, callable $first)
189203
</code>
190204
</h3>
191205
<div class="details">
@@ -233,7 +247,7 @@ <h4>Return Value</h4>
233247
</div>
234248
<div class="method-item">
235249
<h3 id="method_buildAuthorizationHeader">
236-
<div class="location">at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/HttpClient/Plugin/Authentication.php#L77">line 77</a></div>
250+
<div class="location">at <a href="https://github.com/BitbucketAPI/Client/blob/master/src/HttpClient/Plugin/Authentication.php#L79">line 79</a></div>
237251
<code> static protected string
238252
<strong>buildAuthorizationHeader</strong>(string $method, string $token, string $password = null)
239253
</code>

0 commit comments

Comments
 (0)