Skip to content

Commit a1f2a04

Browse files
github-actions[bot]github-actions[bot]
github-actions[bot]
authored and
github-actions[bot]
committed
updated
1 parent dac5ea8 commit a1f2a04

21 files changed

+119
-129
lines changed

‎docs/modules/AMQP.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ $I->bindQueueToExchange(
9191
* `param bool` $nowait
9292
* `param array` $arguments
9393
* `param int` $ticket
94-
* `return` mixed|null
94+
* `return mixed|null`
9595

9696

9797
#### declareExchange
@@ -119,7 +119,7 @@ $I->declareExchange(
119119
* `param bool` $nowait
120120
* `param array` $arguments
121121
* `param int` $ticket
122-
* `return` mixed|null
122+
* `return mixed|null`
123123

124124

125125
#### declareQueue
@@ -145,7 +145,7 @@ $I->declareQueue(
145145
* `param bool` $nowait
146146
* `param array` $arguments
147147
* `param int` $ticket
148-
* `return` mixed|null
148+
* `return mixed|null`
149149

150150

151151
#### dontSeeQueueIsEmpty
@@ -177,7 +177,7 @@ $message = $I->grabMessageFromQueue('queue.emails');
177177
{% endhighlight %}
178178

179179
* `param string` $queue
180-
* `return` \PhpAmqpLib\Message\AMQPMessage
180+
* `return \PhpAmqpLib\Message\AMQPMessage`
181181

182182

183183
#### purgeAllQueues

‎docs/modules/DataFactory.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ Returns an instance of created user.
206206
* `param string` $name
207207
* `param array` $extraAttrs
208208

209-
* `return` object
209+
* `return object`
210210

211211

212212
#### haveMultiple
@@ -224,7 +224,7 @@ $I->haveMultiple('User', 10, ['is_active' => true]); // create 10 active users
224224
* `param int` $times
225225
* `param array` $extraAttrs
226226

227-
* `return` \object[]
227+
* `return \object[]`
228228

229229

230230
#### make
@@ -245,7 +245,7 @@ Returns an instance of created user without creating a record in database.
245245
* `param string` $name
246246
* `param array` $extraAttrs
247247

248-
* `return` object
248+
* `return object`
249249

250250

251251
#### onReconfigure

‎docs/modules/Db.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@ $mails = $I->grabColumnFromDatabase('users', 'email', array('name' => 'RebOOter'
345345
* `param string` $column
346346
* `param array` $criteria
347347

348-
* `return` array
348+
* `return array`
349349

350350

351351
#### grabFromDatabase
@@ -375,7 +375,7 @@ Supported operators: `<`, `>`, `>=`, `<=`, `!=`, `like`.
375375
* `param string` $column
376376
* `param array` $criteria
377377

378-
* `return` mixed Returns a single column value or false
378+
* `return mixed` Returns a single column value or false
379379

380380

381381
#### grabNumRecords
@@ -385,7 +385,7 @@ Returns the number of rows in a database
385385
* `param string` $table Table name
386386
* `param array` $criteria Search criteria [Optional]
387387

388-
* `return` int
388+
* `return int`
389389

390390

391391
#### haveInDatabase

‎docs/modules/Doctrine2.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ $users = $I->grabEntitiesFromRepository(User::class, ['name' => 'davert']);
188188
* `Available since` 1.1
189189
* `param` $entity
190190
* `param array` $params. For `IS NULL`, use `['field' => null]`
191-
* `return` array
191+
* `return array`
192192

193193

194194
#### grabEntityFromRepository
@@ -210,7 +210,7 @@ $user = $I->grabEntityFromRepository(User::class, ['id' => '1234']);
210210
* `Available since` 1.1
211211
* `param` $entity
212212
* `param array` $params. For `IS NULL`, use `['field' => null]`
213-
* `return` object
213+
* `return object`
214214

215215

216216
#### grabFromRepository

‎docs/modules/FTP.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ $pwd = $I->grabDirectory();
228228

229229
{% endhighlight %}
230230

231-
* `return` string
231+
* `return string`
232232

233233

234234
#### grabFileCount
@@ -246,7 +246,7 @@ $count = $I->grabFileCount('TEST', false); // Include . .. .thumbs.db
246246

247247
* `param string` $path
248248
* `param bool` $ignore - suppress '.', '..' and '.thumbs.db'
249-
* `return` int
249+
* `return int`
250250

251251

252252
#### grabFileList
@@ -264,7 +264,7 @@ $count = $I->grabFileList('TEST', false); // Include . .. .thumbs.db
264264

265265
* `param string` $path
266266
* `param bool` $ignore - suppress '.', '..' and '.thumbs.db'
267-
* `return` array
267+
* `return array`
268268

269269

270270
#### grabFileModified
@@ -280,7 +280,7 @@ $time = $I->grabFileModified('test.txt');
280280
{% endhighlight %}
281281

282282
* `param` $filename
283-
* `return` bool
283+
* `return bool`
284284

285285

286286
#### grabFileSize
@@ -296,7 +296,7 @@ $size = $I->grabFileSize('test.txt');
296296
{% endhighlight %}
297297

298298
* `param` $filename
299-
* `return` bool
299+
* `return bool`
300300

301301

302302
#### loginAs

‎docs/modules/Laminas.md‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ WebDriver module returns `Facebook\WebDriver\Remote\RemoteWebElement` instances
102102
PhpBrowser and Framework modules return `Symfony\Component\DomCrawler\Crawler` instances
103103

104104
* `param` $locator
105-
* `return` array of interactive elements
105+
* `return array` of interactive elements
106106

107107

108108
#### _getResponseContent
@@ -123,7 +123,7 @@ public function seeResponseContains($text)
123123

124124
{% endhighlight %}
125125

126-
* `return` string
126+
* `return string`
127127
@throws ModuleException
128128

129129

@@ -174,7 +174,7 @@ To load arbitrary page for interaction, use `_loadPage` method.
174174
* `param string` $method
175175
* `param string` $uri
176176
* `param string` $content
177-
* `return` string
177+
* `return string`
178178
@throws ExternalUrlException
179179
@see `_loadPage`
180180

@@ -202,7 +202,7 @@ Adds service to a Laminas container
202202
* `param string` $name
203203
* `param object` $service
204204

205-
* `return` void
205+
* `return void`
206206

207207

208208
#### amHttpAuthenticated
@@ -245,7 +245,7 @@ $I->amOnRoute('posts.show', array('id' => 34));
245245
* `param string` $routeName
246246
* `param array` $params
247247

248-
* `return` void
248+
* `return void`
249249

250250

251251
#### attachFile
@@ -711,15 +711,15 @@ $aLinks = $I->grabMultiple('a', 'href');
711711

712712
* `param` $cssOrXpath
713713
* `param` $attribute
714-
* `return` string[]
714+
* `return string[]`
715715

716716

717717
#### grabPageSource
718718

719719
Grabs current page source code.
720720

721721
@throws ModuleException if no page was opened.
722-
* `return` string Current page source code.
722+
* `return string` Current page source code.
723723

724724

725725
#### grabServiceFromContainer
@@ -763,7 +763,7 @@ $value = $I->grabTextFrom('~<input value=(.*?)]~sgi'); // match with a regex
763763

764764
* `param` $field
765765

766-
* `return` array|mixed|null|string
766+
* `return array|mixed|null|string`
767767

768768

769769
#### haveHttpHeader
@@ -928,7 +928,7 @@ $I->seeCurrentRouteIs('posts.show', ['id' => 8]));
928928
* `param string` $routeName
929929
* `param array` $params
930930

931-
* `return` void
931+
* `return void`
932932

933933

934934
#### seeCurrentUrlEquals
@@ -985,7 +985,6 @@ $I->seeElement(['css' => 'form input'], ['name' => 'login']);
985985

986986
* `param` $selector
987987
* `param array` $attributes
988-
@return
989988

990989

991990
#### seeInCurrentUrl

‎docs/modules/Laravel.md‎

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ WebDriver module returns `Facebook\WebDriver\Remote\RemoteWebElement` instances
157157
PhpBrowser and Framework modules return `Symfony\Component\DomCrawler\Crawler` instances
158158

159159
* `param` $locator
160-
* `return` array of interactive elements
160+
* `return array` of interactive elements
161161

162162

163163
#### _getResponseContent
@@ -178,7 +178,7 @@ public function seeResponseContains($text)
178178

179179
{% endhighlight %}
180180

181-
* `return` string
181+
* `return string`
182182
@throws ModuleException
183183

184184

@@ -229,7 +229,7 @@ To load arbitrary page for interaction, use `_loadPage` method.
229229
* `param string` $method
230230
* `param string` $uri
231231
* `param string` $content
232-
* `return` string
232+
* `return string`
233233
@throws ExternalUrlException
234234
@see `_loadPage`
235235

@@ -413,7 +413,7 @@ $I->callArtisan('command:name', ['parameter' => 'value']);
413413
{% endhighlight %}
414414
Use 3rd parameter to pass in custom `OutputInterface`
415415

416-
* `return` string|void
416+
* `return string|void`
417417

418418

419419
#### checkOption
@@ -1063,7 +1063,7 @@ $aLinks = $I->grabMultiple('a', 'href');
10631063

10641064
* `param` $cssOrXpath
10651065
* `param` $attribute
1066-
* `return` string[]
1066+
* `return string[]`
10671067

10681068

10691069
#### grabNumRecords
@@ -1087,7 +1087,7 @@ $I->grabNumRecords('App\Models\User', ['name' => 'Davert']);
10871087
Grabs current page source code.
10881088

10891089
@throws ModuleException if no page was opened.
1090-
* `return` string Current page source code.
1090+
* `return string` Current page source code.
10911091

10921092

10931093
#### grabRecord
@@ -1106,7 +1106,7 @@ $record = $I->grabRecord('App\Models\User', ['name' => 'Davert']); // returns El
11061106

11071107
* `param string` $table
11081108
* `param array` $attributes
1109-
* `return` array|EloquentModel
1109+
* `return array|EloquentModel`
11101110
* `[Part]` orm
11111111

11121112

@@ -1156,7 +1156,7 @@ $value = $I->grabTextFrom('~<input value=(.*?)]~sgi'); // match with a regex
11561156

11571157
* `param` $field
11581158

1159-
* `return` array|mixed|null|string
1159+
* `return array|mixed|null|string`
11601160

11611161

11621162
#### have
@@ -1302,7 +1302,7 @@ $I->haveMultiple('App\Models\User', 10, [], 'admin');
13021302

13031303
@see https://laravel.com/docs/7.x/database-testing#using-factories
13041304

1305-
* `return` EloquentModel|EloquentCollection
1305+
* `return EloquentModel|EloquentCollection`
13061306
* `[Part]` orm
13071307

13081308

@@ -1322,7 +1322,7 @@ $user = $I->haveRecord('App\Models\User', ['name' => 'Davert']); // returns Eloq
13221322

13231323
* `param string` $table
13241324
* `param array` $attributes
1325-
* `return` EloquentModel|int
1325+
* `return EloquentModel|int`
13261326
@throws RuntimeException
13271327
* `[Part]` orm
13281328

@@ -1383,7 +1383,7 @@ $I->make('App\Models\User', [], 'admin');
13831383

13841384
@see https://laravel.com/docs/7.x/database-testing#using-factories
13851385

1386-
* `return` EloquentCollection|EloquentModel
1386+
* `return EloquentCollection|EloquentModel`
13871387
* `[Part]` orm
13881388

13891389

@@ -1419,7 +1419,7 @@ $I->makeMultiple('App\Models\User', 10, [], 'admin');
14191419

14201420
@see https://laravel.com/docs/7.x/database-testing#using-factories
14211421

1422-
* `return` EloquentCollection|EloquentModel
1422+
* `return EloquentCollection|EloquentModel`
14231423
* `[Part]` orm
14241424

14251425

@@ -1603,7 +1603,6 @@ $I->seeElement(['css' => 'form input'], ['name' => 'login']);
16031603

16041604
* `param` $selector
16051605
* `param array` $attributes
1606-
@return
16071606

16081607

16091608
#### seeEventTriggered

0 commit comments

Comments
 (0)