Skip to content

Commit b652682

Browse files
committed
fixed missing documentation
1 parent 74a38bf commit b652682

File tree

3 files changed

+28
-7
lines changed

3 files changed

+28
-7
lines changed

lib/Redmine/Api/AbstractApi.php

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,31 +38,49 @@ public function lastCallFailed()
3838
}
3939

4040
/**
41-
* {@inheritDoc}
41+
* Perform the client get() method.
42+
*
43+
* @param string $path
44+
*
45+
* @return array
4246
*/
4347
protected function get($path)
4448
{
4549
return $this->client->get($path);
4650
}
4751

4852
/**
49-
* {@inheritDoc}
53+
* Perform the client post() method.
54+
*
55+
* @param string $path
56+
* @param string $data
57+
*
58+
* @return string|false
5059
*/
5160
protected function post($path, $data)
5261
{
5362
return $this->client->post($path, $data);
5463
}
5564

5665
/**
57-
* {@inheritDoc}
66+
* Perform the client put() method.
67+
*
68+
* @param string $path
69+
* @param string $data
70+
*
71+
* @return string|false
5872
*/
5973
protected function put($path, $data)
6074
{
6175
return $this->client->put($path, $data);
6276
}
6377

6478
/**
65-
* {@inheritDoc}
79+
* Perform the client delete() method.
80+
*
81+
* @param string $path
82+
*
83+
* @return array
6684
*/
6785
protected function delete($path)
6886
{

lib/Redmine/Api/Issue.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ public function removeWatcher($id, $watcher_user_id)
196196
/**
197197
* @param int $id
198198
* @param string $status
199-
* @return void
199+
* @return SimpleXMLElement
200200
*/
201201
public function setIssueStatus($id, $status)
202202
{
@@ -210,7 +210,7 @@ public function setIssueStatus($id, $status)
210210
/**
211211
* @param int $id
212212
* @param string $note
213-
* @return void
213+
* @return SimpleXMLElement
214214
*/
215215
public function addNoteToIssue($id, $note)
216216
{

lib/Redmine/Client.php

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,9 @@ public function setImpersonateUser($username = null)
308308
}
309309

310310
/**
311-
* @return mixed
311+
* Get the impersonate user.
312+
*
313+
* @return string|null
312314
*/
313315
public function getImpersonateUser()
314316
{
@@ -392,6 +394,7 @@ protected function runRequest($path, $method = 'GET', $data = '')
392394
default: // GET
393395
break;
394396
}
397+
/* @var $response boolean|string */
395398
$response = curl_exec($curl);
396399
$this->responseCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
397400
$contentType = curl_getinfo($curl, CURLINFO_CONTENT_TYPE);

0 commit comments

Comments
 (0)