Skip to content

Commit 26b738c

Browse files
committed
Add API @link
1 parent d6690ee commit 26b738c

File tree

4 files changed

+20
-0
lines changed

4 files changed

+20
-0
lines changed

lib/Github/Api/Issue/Comments.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ class Comments extends AbstractApi
1414
/**
1515
* Configure the body type.
1616
*
17+
* @link https://developer.github.com/v3/issues/comments/#custom-media-types
1718
* @param string|null $bodyType
1819
*/
1920
public function configure($bodyType = null)
@@ -30,6 +31,7 @@ public function configure($bodyType = null)
3031
/**
3132
* Get all comments for an issue.
3233
*
34+
* @link https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue
3335
* @param string $username
3436
* @param string $repository
3537
* @param int $issue
@@ -47,6 +49,7 @@ public function all($username, $repository, $issue, $page = 1)
4749
/**
4850
* Get a comment for an issue.
4951
*
52+
* @link https://developer.github.com/v3/issues/comments/#get-a-single-comment
5053
* @param string $username
5154
* @param string $repository
5255
* @param int $comment
@@ -61,6 +64,7 @@ public function show($username, $repository, $comment)
6164
/**
6265
* Create a comment for an issue.
6366
*
67+
* @link https://developer.github.com/v3/issues/comments/#create-a-comment
6468
* @param string $username
6569
* @param string $repository
6670
* @param int $issue
@@ -81,6 +85,7 @@ public function create($username, $repository, $issue, array $params)
8185
/**
8286
* Update a comment for an issue.
8387
*
88+
* @link https://developer.github.com/v3/issues/comments/#edit-a-comment
8489
* @param string $username
8590
* @param string $repository
8691
* @param int $comment
@@ -101,6 +106,7 @@ public function update($username, $repository, $comment, array $params)
101106
/**
102107
* Delete a comment for an issue.
103108
*
109+
* @link https://developer.github.com/v3/issues/comments/#delete-a-comment
104110
* @param string $username
105111
* @param string $repository
106112
* @param int $comment

lib/Github/Api/Issue/Events.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ class Events extends AbstractApi
1313
/**
1414
* Get all events for an issue.
1515
*
16+
* @link https://developer.github.com/v3/issues/events/#list-events-for-an-issue
1617
* @param string $username
1718
* @param string $repository
1819
* @param int|null $issue
@@ -35,6 +36,7 @@ public function all($username, $repository, $issue = null, $page = 1)
3536
/**
3637
* Display an event for an issue.
3738
*
39+
* @link https://developer.github.com/v3/issues/events/#get-a-single-event
3840
* @param $username
3941
* @param $repository
4042
* @param $event

lib/Github/Api/Issue/Labels.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ class Labels extends AbstractApi
1515
/**
1616
* Get all labels for a repository or the labels for a specific issue.
1717
*
18+
* @link https://developer.github.com/v3/issues/labels/#list-labels-on-an-issue
1819
* @param string $username
1920
* @param string $repository
2021
* @param int|null $issue
@@ -58,6 +59,7 @@ public function create($username, $repository, array $params)
5859
/**
5960
* Delete a label for a repository.
6061
*
62+
* @link https://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue
6163
* @param string $username
6264
* @param string $repository
6365
* @param string $label
@@ -93,6 +95,7 @@ public function update($username, $repository, $label, $newName, $color)
9395
/**
9496
* Add a label to an issue.
9597
*
98+
* @link https://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue
9699
* @param string $username
97100
* @param string $repository
98101
* @param int $issue
@@ -116,6 +119,7 @@ public function add($username, $repository, $issue, $labels)
116119
/**
117120
* Replace labels for an issue.
118121
*
122+
* @link https://developer.github.com/v3/issues/labels/#replace-all-labels-for-an-issue
119123
* @param string $username
120124
* @param string $repository
121125
* @param int $issue
@@ -131,6 +135,7 @@ public function replace($username, $repository, $issue, array $params)
131135
/**
132136
* Remove a label for an issue
133137
*
138+
* @link https://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue
134139
* @param string $username
135140
* @param string $repository
136141
* @param string $issue
@@ -146,6 +151,7 @@ public function remove($username, $repository, $issue, $label)
146151
/**
147152
* Remove all labels from an issue.
148153
*
154+
* @link https://developer.github.com/v3/issues/labels/#replace-all-labels-for-an-issue
149155
* @param string $username
150156
* @param string $repository
151157
* @param string $issue

lib/Github/Api/Issue/Milestones.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ class Milestones extends AbstractApi
1414
/**
1515
* Get all milestones for a repository.
1616
*
17+
* @link https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository
1718
* @param string $username
1819
* @param string $repository
1920
* @param array $params
@@ -43,6 +44,7 @@ public function all($username, $repository, array $params = array())
4344
/**
4445
* Get a milestone for a repository.
4546
*
47+
* @link https://developer.github.com/v3/issues/milestones/#get-a-single-milestone
4648
* @param string $username
4749
* @param string $repository
4850
* @param int $id
@@ -57,6 +59,7 @@ public function show($username, $repository, $id)
5759
/**
5860
* Create a milestone for a repository.
5961
*
62+
* @link https://developer.github.com/v3/issues/milestones/#create-a-milestone
6063
* @param string $username
6164
* @param string $repository
6265
* @param array $params
@@ -80,6 +83,7 @@ public function create($username, $repository, array $params)
8083
/**
8184
* Update a milestone for a repository.
8285
*
86+
* @link https://developer.github.com/v3/issues/milestones/#update-a-milestone
8387
* @param string $username
8488
* @param string $repository
8589
* @param int $id
@@ -99,6 +103,7 @@ public function update($username, $repository, $id, array $params)
99103
/**
100104
* Delete a milestone for a repository.
101105
*
106+
* @link https://developer.github.com/v3/issues/milestones/#delete-a-milestone
102107
* @param string $username
103108
* @param string $repository
104109
* @param int $id
@@ -113,6 +118,7 @@ public function remove($username, $repository, $id)
113118
/**
114119
* Get the labels of a milestone
115120
*
121+
* @link https://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone
116122
* @param string $username
117123
* @param string $repository
118124
* @param int $id

0 commit comments

Comments
 (0)