@@ -268,9 +268,9 @@ discard block |
||
| 268 | 268 | * |
| 269 | 269 | * All the protected methods that do not start with _ (underscore) |
| 270 | 270 | * will exposed as protected api which will require authentication |
| 271 | - * @param string $class name of the service class |
|
| 272 | - * @param string $basePath optional url prefix for mapping, uses |
|
| 271 | + * @param string $base_path optional url prefix for mapping, uses |
|
| 273 | 272 | * lowercase version of the class name when not specified |
| 273 | + * @param string $class_name |
|
| 274 | 274 | * @throws Exception when supplied with invalid class name |
| 275 | 275 | */ |
| 276 | 276 | public function addAPIClass($class_name, $base_path = null) |
@@ -322,8 +322,8 @@ discard block |
||
| 322 | 322 | |
| 323 | 323 | /** |
| 324 | 324 | * Convenience method to respond with an error message |
| 325 | - * @param int $statusCode http error code |
|
| 326 | - * @param string $errorMessage optional custom error message |
|
| 325 | + * @param int $status_code http error code |
|
| 326 | + * @param string $error_message optional custom error message |
|
| 327 | 327 | */ |
| 328 | 328 | public function handleError($status_code, $error_message = null) |
| 329 | 329 | { |
@@ -916,6 +916,10 @@ discard block |
||
| 916 | 916 | { |
| 917 | 917 | |
| 918 | 918 | |
| 919 | + /** |
|
| 920 | + * @param integer $http_status_code |
|
| 921 | + * @param string $error_message |
|
| 922 | + */ |
|
| 919 | 923 | public function __construct($http_status_code, $error_message = null) |
| 920 | 924 | { |
| 921 | 925 | parent::__construct($error_message, $http_status_code); |
@@ -1033,12 +1037,14 @@ discard block |
||
| 1033 | 1037 | /** |
| 1034 | 1038 | * Set the selected MIME type |
| 1035 | 1039 | * @param string $mime MIME type |
| 1040 | + * @return void |
|
| 1036 | 1041 | */ |
| 1037 | 1042 | public function setMIME($mime); |
| 1038 | 1043 | |
| 1039 | 1044 | |
| 1040 | 1045 | /** |
| 1041 | 1046 | * Get selected MIME type |
| 1047 | + * @return string |
|
| 1042 | 1048 | */ |
| 1043 | 1049 | public function getMIME(); |
| 1044 | 1050 | |
@@ -1046,6 +1052,7 @@ discard block |
||
| 1046 | 1052 | /** |
| 1047 | 1053 | * Set the selected file extension |
| 1048 | 1054 | * @param string $extension file extension |
| 1055 | + * @return void |
|
| 1049 | 1056 | */ |
| 1050 | 1057 | public function setExtension($extension); |
| 1051 | 1058 | |
@@ -1349,6 +1356,9 @@ discard block |
||
| 1349 | 1356 | } |
| 1350 | 1357 | |
| 1351 | 1358 | |
| 1359 | + /** |
|
| 1360 | + * @param string[] $lines |
|
| 1361 | + */ |
|
| 1352 | 1362 | private function parseLines($lines) |
| 1353 | 1363 | { |
| 1354 | 1364 | foreach ($lines as $line) { |
@@ -1398,6 +1408,10 @@ discard block |
||
| 1398 | 1408 | } |
| 1399 | 1409 | |
| 1400 | 1410 | |
| 1411 | + /** |
|
| 1412 | + * @param string $param |
|
| 1413 | + * @param string $value |
|
| 1414 | + */ |
|
| 1401 | 1415 | private function setParam($param, $value) |
| 1402 | 1416 | { |
| 1403 | 1417 | if ($param == 'param' || $param == 'return') { |
@@ -1454,6 +1468,9 @@ discard block |
||
| 1454 | 1468 | // |
| 1455 | 1469 | // ------------------------------------------------------------------ |
| 1456 | 1470 | |
| 1471 | +/** |
|
| 1472 | + * @param string $php_doc_comment |
|
| 1473 | + */ |
|
| 1457 | 1474 | function parse_doc($php_doc_comment) |
| 1458 | 1475 | { |
| 1459 | 1476 | $p = new DocParser(); |
@@ -176,7 +176,7 @@ discard block |
||
| 176 | 176 | * |
| 177 | 177 | * This may be either a single, or multiple strings in an array. |
| 178 | 178 | * |
| 179 | - * @param string|array $value |
|
| 179 | + * @param string|null $value |
|
| 180 | 180 | * |
| 181 | 181 | * @return void |
| 182 | 182 | */ |
@@ -342,7 +342,7 @@ discard block |
||
| 342 | 342 | * This method returns an array, with the representation as it should be |
| 343 | 343 | * encoded in JSON. This is used to create jCard or jCal documents. |
| 344 | 344 | * |
| 345 | - * @return array |
|
| 345 | + * @return string |
|
| 346 | 346 | */ |
| 347 | 347 | function jsonSerialize() { |
| 348 | 348 | |
@@ -331,6 +331,7 @@ discard block |
||
| 331 | 331 | /** |
| 332 | 332 | * Reads a property or component from a line. |
| 333 | 333 | * |
| 334 | + * @param string $line |
|
| 334 | 335 | * @return void |
| 335 | 336 | */ |
| 336 | 337 | protected function readProperty($line) { |
@@ -623,7 +624,7 @@ discard block |
||
| 623 | 624 | * |
| 624 | 625 | * @param string $input |
| 625 | 626 | * |
| 626 | - * @return void |
|
| 627 | + * @return string |
|
| 627 | 628 | */ |
| 628 | 629 | private function unescapeParam($input) { |
| 629 | 630 | |
@@ -43,7 +43,7 @@ |
||
| 43 | 43 | * |
| 44 | 44 | * @param RequestInterface $request |
| 45 | 45 | * @param ResponseInterface $response |
| 46 | - * @return bool |
|
| 46 | + * @return null|false |
|
| 47 | 47 | */ |
| 48 | 48 | function httpGet(RequestInterface $request, ResponseInterface $response) { |
| 49 | 49 | |
@@ -44,7 +44,7 @@ |
||
| 44 | 44 | * |
| 45 | 45 | * This method must always return an array. |
| 46 | 46 | * |
| 47 | - * @return array |
|
| 47 | + * @return string[] |
|
| 48 | 48 | */ |
| 49 | 49 | function getJsonValue() { |
| 50 | 50 | |