Skip to content

Commit 5367561

Browse files
committed
added more comments
1 parent daac8c0 commit 5367561

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

app/helpers/Swagger/ResponseData.php

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,26 @@
77
use App\Helpers\MetaFormats\FormatDefinitions\SuccessResponseFormat;
88
use App\Helpers\MetaFormats\Validators\VObject;
99

10+
/**
11+
* Class containing relevant information used to make swagger responses.
12+
*/
1013
class ResponseData
1114
{
15+
/**
16+
* @var AnnotationParameterData[]
17+
*/
1218
public array $responseParams;
1319
public string $description;
1420
public int $statusCode;
1521
public bool $useSuccessWrapper;
1622

23+
/**
24+
* @param array $responseParams AnnotationParameterData describing the response object.
25+
* @param string $description The description of the response.
26+
* @param int $statusCode The response status code.
27+
* @param bool $useSuccessWrapper Whether the response should be contained in
28+
* the "BasePresenter::sendSuccessResponse" wrapper.
29+
*/
1730
public function __construct(
1831
array $responseParams,
1932
string $description,

0 commit comments

Comments
 (0)