Skip to content

Commit d248dfe

Browse files
Cleanup @return annotations
1 parent a0aad54 commit d248dfe

File tree

3 files changed

+16
-28
lines changed

3 files changed

+16
-28
lines changed

AbstractBrowser.php

Lines changed: 12 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -105,8 +105,6 @@ public function getMaxRedirects()
105105
/**
106106
* Sets the insulated flag.
107107
*
108-
* @param bool $insulated Whether to insulate the requests or not
109-
*
110108
* @throws \RuntimeException When Symfony Process Component is not installed
111109
*/
112110
public function insulate(bool $insulated = true)
@@ -120,8 +118,6 @@ public function insulate(bool $insulated = true)
120118

121119
/**
122120
* Sets server parameters.
123-
*
124-
* @param array $server An array of server parameters
125121
*/
126122
public function setServerParameters(array $server)
127123
{
@@ -143,7 +139,7 @@ public function setServerParameter(string $key, string $value)
143139
*
144140
* @param mixed $default A default value when key is undefined
145141
*
146-
* @return mixed A value of the parameter
142+
* @return mixed
147143
*/
148144
public function getServerParameter(string $key, $default = '')
149145
{
@@ -182,7 +178,7 @@ public function jsonRequest(string $method, string $uri, array $parameters = [],
182178
/**
183179
* Returns the History instance.
184180
*
185-
* @return History A History instance
181+
* @return History
186182
*/
187183
public function getHistory()
188184
{
@@ -192,7 +188,7 @@ public function getHistory()
192188
/**
193189
* Returns the CookieJar instance.
194190
*
195-
* @return CookieJar A CookieJar instance
191+
* @return CookieJar
196192
*/
197193
public function getCookieJar()
198194
{
@@ -202,7 +198,7 @@ public function getCookieJar()
202198
/**
203199
* Returns the current Crawler instance.
204200
*
205-
* @return Crawler A Crawler instance
201+
* @return Crawler
206202
*/
207203
public function getCrawler()
208204
{
@@ -216,7 +212,7 @@ public function getCrawler()
216212
/**
217213
* Returns the current BrowserKit Response instance.
218214
*
219-
* @return Response A BrowserKit Response instance
215+
* @return Response
220216
*/
221217
public function getInternalResponse()
222218
{
@@ -233,7 +229,7 @@ public function getInternalResponse()
233229
* The origin response is the response instance that is returned
234230
* by the code that handles requests.
235231
*
236-
* @return object A response instance
232+
* @return object
237233
*
238234
* @see doRequest()
239235
*/
@@ -249,7 +245,7 @@ public function getResponse()
249245
/**
250246
* Returns the current BrowserKit Request instance.
251247
*
252-
* @return Request A BrowserKit Request instance
248+
* @return Request
253249
*/
254250
public function getInternalRequest()
255251
{
@@ -266,7 +262,7 @@ public function getInternalRequest()
266262
* The origin request is the request instance that is sent
267263
* to the code that handles requests.
268264
*
269-
* @return object A Request instance
265+
* @return object
270266
*
271267
* @see doRequest()
272268
*/
@@ -435,9 +431,7 @@ public function request(string $method, string $uri, array $parameters = [], arr
435431
/**
436432
* Makes a request in another process.
437433
*
438-
* @param object $request An origin request instance
439-
*
440-
* @return object An origin response instance
434+
* @return object
441435
*
442436
* @throws \RuntimeException When processing returns exit code
443437
*/
@@ -472,9 +466,7 @@ protected function doRequestInProcess(object $request)
472466
/**
473467
* Makes a request.
474468
*
475-
* @param object $request An origin request instance
476-
*
477-
* @return object An origin response instance
469+
* @return object
478470
*/
479471
abstract protected function doRequest(object $request);
480472

@@ -493,7 +485,7 @@ protected function getScript(object $request)
493485
/**
494486
* Filters the BrowserKit request to the origin one.
495487
*
496-
* @return object An origin request instance
488+
* @return object
497489
*/
498490
protected function filterRequest(Request $request)
499491
{
@@ -503,9 +495,7 @@ protected function filterRequest(Request $request)
503495
/**
504496
* Filters the origin response to the BrowserKit one.
505497
*
506-
* @param object $response The origin response to filter
507-
*
508-
* @return Response An BrowserKit Response instance
498+
* @return Response
509499
*/
510500
protected function filterResponse(object $response)
511501
{
@@ -649,8 +639,6 @@ public function restart()
649639
/**
650640
* Takes a URI and converts it to absolute if it is not already absolute.
651641
*
652-
* @param string $uri A URI
653-
*
654642
* @return string An absolute URI
655643
*/
656644
protected function getAbsoluteUri(string $uri)

CookieJar.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public function set(Cookie $cookie)
3333
* (this behavior ensures a BC behavior with previous versions of
3434
* Symfony).
3535
*
36-
* @return Cookie|null A Cookie instance or null if the cookie does not exist
36+
* @return Cookie|null
3737
*/
3838
public function get(string $name, string $path = '/', string $domain = null)
3939
{

History.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public function isEmpty()
5353
/**
5454
* Goes back in the history.
5555
*
56-
* @return Request A Request instance
56+
* @return Request
5757
*
5858
* @throws \LogicException if the stack is already on the first page
5959
*/
@@ -69,7 +69,7 @@ public function back()
6969
/**
7070
* Goes forward in the history.
7171
*
72-
* @return Request A Request instance
72+
* @return Request
7373
*
7474
* @throws \LogicException if the stack is already on the last page
7575
*/
@@ -85,7 +85,7 @@ public function forward()
8585
/**
8686
* Returns the current element in the history.
8787
*
88-
* @return Request A Request instance
88+
* @return Request
8989
*
9090
* @throws \LogicException if the stack is empty
9191
*/

0 commit comments

Comments
 (0)