Skip to content

Commit 84ff198

Browse files
GrahamCampbellGrahamCampbell
committed
PHPDoc fixes
1 parent 4b777c8 commit 84ff198

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+136
-137
lines changed

‎lib/Gitlab/Api/Environments.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ public function all($project_id, array $parameters = [])
1717

1818
/**
1919
* @param int $project_id
20-
* @param array $parameters (
20+
* @param array $parameters {
2121
*
2222
* @var string $name The name of the environment
2323
* @var string $external_url Place to link to for this environment
24-
* )
24+
* }
2525
* @return mixed
2626
*/
2727
public function create($project_id, array $parameters = array())

‎lib/Gitlab/Api/Groups.php

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
class Groups extends AbstractApi
77
{
88
/**
9-
* @param array $parameters (
9+
* @param array $parameters {
1010
*
1111
* @var int[] $skip_groups Skip the group IDs passes.
1212
* @var bool $all_available Show all the groups you have access to.
@@ -15,7 +15,7 @@ class Groups extends AbstractApi
1515
* @var string $sort Order groups in asc or desc order. Default is asc.
1616
* @var bool $statistics Include group statistics (admins only).
1717
* @var bool $owned Limit by groups owned by the current user.
18-
* )
18+
* }
1919
* @return mixed
2020
*/
2121
public function all(array $parameters = [])
@@ -105,10 +105,10 @@ public function allMembers($id, array $parameters = [])
105105

106106
/**
107107
* @param int $id
108-
* @param array $parameters (
108+
* @param array $parameters {
109109
*
110110
* @var string $query A query string to search for members.
111-
* )
111+
* }
112112
*
113113
* @return mixed
114114
*/
@@ -159,7 +159,7 @@ public function removeMember($group_id, $user_id)
159159

160160
/**
161161
* @param int $id
162-
* @param array $parameters (
162+
* @param array $parameters {
163163
*
164164
* @var bool $archived Limit by archived status.
165165
* @var string $visibility Limit by visibility public, internal, or private.
@@ -175,7 +175,7 @@ public function removeMember($group_id, $user_id)
175175
* @var bool $with_shared Include projects shared to this group. Default is true.
176176
* @var bool $include_subgroups Include projects in subgroups of this group. Default is false.
177177
* @var bool $with_custom_attributes Include custom attributes in response (admins only).
178-
* )
178+
* }
179179
*
180180
* @return mixed
181181
*/
@@ -238,7 +238,7 @@ public function projects($id, array $parameters = [])
238238

239239
/**
240240
* @param int $group_id
241-
* @param array $parameters (
241+
* @param array $parameters {
242242
*
243243
* @var int[] $skip_groups Skip the group IDs passes.
244244
* @var bool $all_available Show all the groups you have access to.
@@ -247,7 +247,7 @@ public function projects($id, array $parameters = [])
247247
* @var string $sort Order groups in asc or desc order. Default is asc.
248248
* @var bool $statistics Include group statistics (admins only).
249249
* @var bool $owned Limit by groups owned by the current user.
250-
* )
250+
* }
251251
* @return mixed
252252
*/
253253
public function subgroups($group_id, array $parameters = [])
@@ -327,7 +327,7 @@ public function variable($group_id, $key)
327327
* @param int $group_id
328328
* @param string $key
329329
* @param string $value
330-
* @param bool $protected
330+
* @param bool|null $protected
331331
* @return mixed
332332
*/
333333
public function addVariable($group_id, $key, $value, $protected = null)
@@ -348,7 +348,7 @@ public function addVariable($group_id, $key, $value, $protected = null)
348348
* @param int $group_id
349349
* @param string $key
350350
* @param string $value
351-
* @param bool $protected
351+
* @param bool|null $protected
352352
* @return mixed
353353
*/
354354
public function updateVariable($group_id, $key, $value, $protected = null)

‎lib/Gitlab/Api/GroupsBoards.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
class GroupsBoards extends AbstractApi
44
{
55
/**
6-
* @param int $group_id
6+
* @param int|null $group_id
77
* @param array $parameters
88
*
99
* @return mixed

‎lib/Gitlab/Api/GroupsMilestones.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ class GroupsMilestones extends AbstractApi
44
{
55
/**
66
* @param int $group_id
7-
* @param array $parameters (
7+
* @param array $parameters {
88
*
99
* @var int[] $iids Return only the milestones having the given iids.
1010
* @var string $state Return only active or closed milestones.
1111
* @var string $search Return only milestones with a title or description matching the provided string.
12-
* )
12+
* }
1313
*
1414
* @return mixed
1515
*/

‎lib/Gitlab/Api/IssueBoards.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
class IssueBoards extends AbstractApi
44
{
55
/**
6-
* @param int $project_id
6+
* @param int|null $project_id
77
* @param array $parameters
88
*
99
* @return mixed

‎lib/Gitlab/Api/Issues.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
class Issues extends AbstractApi
44
{
55
/**
6-
* @param int $project_id
7-
* @param array $parameters (
6+
* @param int|null $project_id
7+
* @param array $parameters {
88
*
99
* @var string $state Return all issues or just those that are opened or closed.
1010
* @var string $labels Comma-separated list of label names, issues must have all labels to be returned.
@@ -15,7 +15,7 @@ class Issues extends AbstractApi
1515
* @var string $order_by Return requests ordered by created_at or updated_at fields. Default is created_at.
1616
* @var string $sort Return requests sorted in asc or desc order. Default is desc.
1717
* @var string $search Search issues against their title and description.
18-
* )
18+
* }
1919
*
2020
* @return mixed
2121
*/

‎lib/Gitlab/Api/Jobs.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ class Jobs extends AbstractApi
1616

1717
/**
1818
* @param int|string $project_id
19-
* @param array $parameters (
19+
* @param array $parameters {
2020
*
2121
* @var string|string[] $scope The scope of jobs to show, one or array of: created, pending, running, failed,
2222
* success, canceled, skipped, manual; showing all jobs if none provided.
23-
* )
23+
* }
2424
*
2525
* @return mixed
2626
*/
@@ -34,11 +34,11 @@ public function all($project_id, array $parameters = [])
3434
/**
3535
* @param int|string $project_id
3636
* @param int $pipeline_id
37-
* @param array $parameters (
37+
* @param array $parameters {
3838
*
3939
* @var string|string[] $scope The scope of jobs to show, one or array of: created, pending, running, failed,
4040
* success, canceled, skipped, manual; showing all jobs if none provided.
41-
* )
41+
* }
4242
*
4343
* @return mixed
4444
*/

‎lib/Gitlab/Api/Milestones.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ class Milestones extends AbstractApi
44
{
55
/**
66
* @param int $project_id
7-
* @param array $parameters (
7+
* @param array $parameters {
88
*
99
* @var int[] $iids Return only the milestones having the given iids.
1010
* @var string $state Return only active or closed milestones.
1111
* @var string $search Return only milestones with a title or description matching the provided string.
12-
* )
12+
* }
1313
*
1414
* @return mixed
1515
*/

‎lib/Gitlab/Api/ProjectNamespaces.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
class ProjectNamespaces extends AbstractApi
44
{
55
/**
6-
* @param array $parameters (
6+
* @param array $parameters {
77
*
88
* @var string $search Returns a list of namespaces the user is authorized to see based on the search criteria.
9-
* )
9+
* }
1010
*
1111
* @return mixed
1212
*/

‎lib/Gitlab/Api/Projects.php

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ public function unarchive($project_id)
177177

178178
/**
179179
* @param int $project_id
180-
* @param array $parameters (
180+
* @param array $parameters {
181181
*
182182
* @var string $scope The scope of pipelines, one of: running, pending, finished, branches, tags.
183183
* @var string $status The status of pipelines, one of: running, pending, success, failed, canceled, skipped.
@@ -188,7 +188,7 @@ public function unarchive($project_id)
188188
* @var string $username The username of the user who triggered pipelines.
189189
* @var string $order_by Order pipelines by id, status, ref, or user_id (default: id).
190190
* @var string $order Sort pipelines in asc or desc order (default: desc).
191-
* )
191+
* }
192192
* @return mixed
193193
*/
194194
public function pipelines($project_id, array $parameters = [])
@@ -235,13 +235,12 @@ public function pipeline($project_id, $pipeline_id)
235235
/**
236236
* @param int $project_id
237237
* @param string $commit_ref
238-
* @param array $variables (
239-
* @var array (
240-
* @var string $key The name of the variable
241-
* @var mixed $value The value of the variable
242-
* @var string $variable_type env_var (default) or file
243-
* )
244-
* )
238+
* @param array|null $variables {
239+
*
240+
* @var string $key The name of the variable
241+
* @var mixed $value The value of the variable
242+
* @var string $variable_type env_var (default) or file
243+
* }
245244
* @return mixed
246245
*/
247246
public function createPipeline($project_id, $commit_ref, $variables = null)
@@ -250,7 +249,7 @@ public function createPipeline($project_id, $commit_ref, $variables = null)
250249
'ref' => $commit_ref,
251250
);
252251

253-
if ($variables !== null) {
252+
if (null !== $variables) {
254253
$parameters['variables'] = $variables;
255254
}
256255

@@ -302,10 +301,10 @@ public function allMembers($project_id, $parameters = [])
302301

303302
/**
304303
* @param int $project_id
305-
* @param array $parameters (
304+
* @param array $parameters {
306305
*
307306
* @var string $query The query you want to search members for.
308-
* )
307+
* }
309308
*
310309
* @return mixed
311310
*/
@@ -555,14 +554,14 @@ public function enableDeployKey($project_id, $key_id)
555554

556555
/**
557556
* @param int $project_id
558-
* @param array $parameters (
557+
* @param array $parameters {
559558
*
560559
* @var string $action Include only events of a particular action type.
561560
* @var string $target_type Include only events of a particular target type.
562561
* @var \DateTimeInterface $before Include only events created before a particular date.
563562
* @var \DateTimeInterface $after Include only events created after a particular date.
564563
* @var string $sort Sort events in asc or desc order by created_at. Default is desc.
565-
* )
564+
* }
566565
*
567566
* @return mixed
568567
*/
@@ -662,12 +661,12 @@ public function forks($project_id, array $parameters = [])
662661

663662
/**
664663
* @param int $project_id
665-
* @param array $parameters (
664+
* @param array $parameters {
666665
*
667666
* @var string $namespace The ID or path of the namespace that the project will be forked to
668667
* @var string $path The path of the forked project (optional)
669668
* @var string $name The name of the forked project (optional)
670-
* )
669+
* }
671670
* @return mixed
672671
*/
673672
public function fork($project_id, array $parameters = [])
@@ -746,8 +745,8 @@ public function variable($project_id, $key)
746745
* @param int $project_id
747746
* @param string $key
748747
* @param string $value
749-
* @param bool $protected
750-
* @param string $environment_scope
748+
* @param bool|null $protected
749+
* @param string|null $environment_scope
751750
* @return mixed
752751
*/
753752
public function addVariable($project_id, $key, $value, $protected = null, $environment_scope = null)
@@ -772,8 +771,8 @@ public function addVariable($project_id, $key, $value, $protected = null, $envir
772771
* @param int $project_id
773772
* @param string $key
774773
* @param string $value
775-
* @param bool $protected
776-
* @param string $environment_scope
774+
* @param bool|null $protected
775+
* @param string|null $environment_scope
777776
* @return mixed
778777
*/
779778
public function updateVariable($project_id, $key, $value, $protected = null, $environment_scope = null)

0 commit comments

Comments
 (0)