Skip to content

Commit baa1659

Browse files
DavertMikDavertMik
committed
auto updated documentation
1 parent f756baf commit baa1659

21 files changed

+259
-259
lines changed

‎docs/modules/Asserts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,12 +85,12 @@ Checks that actual is greater or equal than expected
8585

8686
#### assertGreaterThen
8787

88-
* deprecated
88+
* `deprecated`
8989

9090

9191
#### assertGreaterThenOrEqual
9292

93-
* deprecated
93+
* `deprecated`
9494

9595

9696
#### assertLessThan

‎docs/modules/Db.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -108,15 +108,15 @@ Example:
108108
{% highlight php %}
109109

110110
<?php
111-
$I->dontSeeInDatabase('users', array('name' => 'Davert', 'email' => 'davert@mail.com'));
111+
$I->dontSeeInDatabase('users', array('name' => 'Davert', 'email' => 'davert * `mail.com'));`
112112

113113

114114
{% endhighlight %}
115115
Will generate:
116116

117117
{% highlight sql %}
118118

119-
SELECT COUNT(*) FROM `users` WHERE `name` = 'Davert' AND `email` = 'davert@mail.com'
119+
SELECT COUNT(*) FROM `users` WHERE `name` = 'Davert' AND `email` = 'davert * `mail.com'`
120120

121121
{% endhighlight %}
122122
Fails if such user was found.
@@ -140,7 +140,7 @@ $mail = $I->grabFromDatabase('users', 'email', array('name' => 'Davert'));
140140

141141
{% endhighlight %}
142142

143-
* Available since 1.1
143+
* `Available since` 1.1
144144

145145
* `param` $table
146146
* `param` $column
@@ -155,7 +155,7 @@ Inserts SQL record into database. This record will be erased after the test.
155155
{% highlight php %}
156156

157157
<?php
158-
$I->haveInDatabase('users', array('name' => 'miles', 'email' => 'miles@davis.com'));
158+
$I->haveInDatabase('users', array('name' => 'miles', 'email' => 'miles * `davis.com'));`
159159
?>
160160

161161
{% endhighlight %}
@@ -176,15 +176,15 @@ Example:
176176
{% highlight php %}
177177

178178
<?php
179-
$I->seeInDatabase('users', array('name' => 'Davert', 'email' => 'davert@mail.com'));
179+
$I->seeInDatabase('users', array('name' => 'Davert', 'email' => 'davert * `mail.com'));`
180180

181181

182182
{% endhighlight %}
183183
Will generate:
184184

185185
{% highlight sql %}
186186

187-
SELECT COUNT(*) FROM `users` WHERE `name` = 'Davert' AND `email` = 'davert@mail.com'
187+
SELECT COUNT(*) FROM `users` WHERE `name` = 'Davert' AND `email` = 'davert * `mail.com'`
188188

189189
{% endhighlight %}
190190
Fails if no such user found.

‎docs/modules/Dbh.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,15 +67,15 @@ Example:
6767
{% highlight php %}
6868

6969
<?php
70-
$I->dontSeeInDatabase('users', array('name' => 'Davert', 'email' => 'davert@mail.com'));
70+
$I->dontSeeInDatabase('users', array('name' => 'Davert', 'email' => 'davert * `mail.com'));`
7171

7272

7373
{% endhighlight %}
7474
Will generate:
7575

7676
{% highlight sql %}
7777

78-
SELECT COUNT(*) FROM `users` WHERE `name` = 'Davert' AND `email` = 'davert@mail.com'
78+
SELECT COUNT(*) FROM `users` WHERE `name` = 'Davert' AND `email` = 'davert * `mail.com'`
7979

8080
{% endhighlight %}
8181
Fails if such user was found.
@@ -99,7 +99,7 @@ $mail = $I->grabFromDatabase('users', 'email', array('name' => 'Davert'));
9999

100100
{% endhighlight %}
101101

102-
* Available since 1.1
102+
* `Available since` 1.1
103103

104104
* `param` $table
105105
* `param` $column
@@ -117,15 +117,15 @@ Example:
117117
{% highlight php %}
118118

119119
<?php
120-
$I->seeInDatabase('users', array('name' => 'Davert', 'email' => 'davert@mail.com'));
120+
$I->seeInDatabase('users', array('name' => 'Davert', 'email' => 'davert * `mail.com'));`
121121

122122

123123
{% endhighlight %}
124124
Will generate:
125125

126126
{% highlight sql %}
127127

128-
SELECT COUNT(*) FROM `users` WHERE `name` = 'Davert' AND `email` = 'davert@mail.com'
128+
SELECT COUNT(*) FROM `users` WHERE `name` = 'Davert' AND `email` = 'davert * `mail.com'`
129129

130130
{% endhighlight %}
131131
Fails if no such user found.

‎docs/modules/Doctrine2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ $email = $I->grabFromRepository('User', 'email', array('name' => 'davert'));
9595

9696
{% endhighlight %}
9797

98-
* Available since 1.1
98+
* `Available since` 1.1
9999
* `param` $entity
100100
* `param` $field
101101
* `param array` $params

‎docs/modules/Facebook.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ Get facebook test user be created.
136136

137137
Get facebook test user be logged in on facebook.
138138

139-
ModuleConfigException
139+
* `throws` ModuleConfigException
140140

141141

142142
#### postToFacebookAsTestUser

‎docs/modules/Laravel4.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -137,8 +137,8 @@ To load arbitrary page for interaction, use `_loadPage` method.
137137
* `param array` $server
138138
* `param null` $content
139139
* `return` mixed|Crawler
140-
ExternalUrlException
141-
* see `_loadPage`
140+
* `throws` ExternalUrlException
141+
* `see` `_loadPage`
142142

143143

144144
#### _savePageSource
@@ -181,7 +181,7 @@ Opens web page by action name
181181
{% highlight php %}
182182

183183
<?php
184-
$I->amOnAction('PostsController@index');
184+
$I->amOnAction('PostsController * `index');`
185185
?>
186186

187187
{% endhighlight %}
@@ -232,7 +232,7 @@ Attaches a file relative to the Codeception data directory to the given file upl
232232

233233
<?php
234234
// file is stored in 'tests/_data/prices.xls'
235-
$I->attachFile('input[@type="file"]', 'prices.xls');
235+
$I->attachFile('input[ * `type="file"]',` 'prices.xls');
236236
?>
237237

238238
{% endhighlight %}
@@ -270,7 +270,7 @@ $I->checkOption('#agree');
270270

271271
Make sure the Laravel start file exists.
272272

273-
ModuleConfig
273+
* `throws` ModuleConfig
274274

275275

276276
#### click
@@ -295,7 +295,7 @@ $I->click('Submit');
295295
// CSS button
296296
$I->click('#form input[type=submit]');
297297
// XPath
298-
$I->click('//form/*[@type=submit]');
298+
$I->click('//form/*[ * `type=submit]');`
299299
// link in context
300300
$I->click('Logout', '#nav');
301301
// using strict locator
@@ -438,7 +438,7 @@ $I->dontSeeInField('Body','Type your comment here');
438438
$I->dontSeeInField('form textarea[name=body]','Type your comment here');
439439
$I->dontSeeInField('form input[type=hidden]','hidden_value');
440440
$I->dontSeeInField('#searchform input','Search');
441-
$I->dontSeeInField('//form/*[@name=search]','Search');
441+
$I->dontSeeInField('//form/*[ * `name=search]','Search');`
442442
$I->dontSeeInField(['name' => 'search'], 'Search');
443443
?>
444444

@@ -565,8 +565,8 @@ Fills a text field or textarea with the given string.
565565
{% highlight php %}
566566

567567
<?php
568-
$I->fillField("//input[@type='text']", "Hello World!");
569-
$I->fillField(['name' => 'email'], 'jon@mail.com');
568+
$I->fillField("//input[ * `type='text']",` "Hello World!");
569+
$I->fillField(['name' => 'email'], 'jon * `mail.com');`
570570
?>
571571

572572
{% endhighlight %}
@@ -809,7 +809,7 @@ Checks that the specified checkbox is checked.
809809
<?php
810810
$I->seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms
811811
$I->seeCheckboxIsChecked('#signup_form input[type=checkbox]'); // I suppose user agreed to terms, If there is only one checkbox in form.
812-
$I->seeCheckboxIsChecked('//form/input[@type=checkbox and @name=agree]');
812+
$I->seeCheckboxIsChecked('//form/input[ * `type=checkbox` and * `name=agree]');`
813813
?>
814814

815815
{% endhighlight %}
@@ -841,7 +841,7 @@ Checks that current url matches action
841841
{% highlight php %}
842842

843843
<?php
844-
$I->seeCurrentActionIs('PostsController@index');
844+
$I->seeCurrentActionIs('PostsController * `index');`
845845
?>
846846

847847
{% endhighlight %}
@@ -919,7 +919,7 @@ $I->seeElement(['css' => 'form input'], ['name' => 'login']);
919919

920920
* `param` $selector
921921
* `param array` $attributes
922-
* return
922+
* `return`
923923

924924

925925
#### seeFormErrorMessage
@@ -1008,7 +1008,7 @@ $I->seeInField('Body','Type your comment here');
10081008
$I->seeInField('form textarea[name=body]','Type your comment here');
10091009
$I->seeInField('form input[type=hidden]','hidden_value');
10101010
$I->seeInField('#searchform input','Search');
1011-
$I->seeInField('//form/*[@name=search]','Search');
1011+
$I->seeInField('//form/*[ * `name=search]','Search');`
10121012
$I->seeInField(['name' => 'search'], 'Search');
10131013
?>
10141014

@@ -1078,9 +1078,9 @@ $form = [
10781078
'checkbox1' => true,
10791079
// ...
10801080
];
1081-
$I->submitForm('//form[@id=my-form]', $form, 'submitButton');
1081+
$I->submitForm('//form[ * `id=my-form]',` $form, 'submitButton');
10821082
// $I->amOnPage('/path/to/form-page') may be needed
1083-
$I->seeInFormFields('//form[@id=my-form]', $form);
1083+
$I->seeInFormFields('//form[ * `id=my-form]',` $form);
10841084
?>
10851085

10861086
{% endhighlight %}
@@ -1226,7 +1226,7 @@ $I->seeSessionErrorMessage(array('username'=>'Invalid Username'));
12261226

12271227
{% endhighlight %}
12281228
* `param array` $bindings
1229-
* deprecated
1229+
* `deprecated`
12301230

12311231

12321232
#### seeSessionHasErrors
@@ -1242,7 +1242,7 @@ $I->seeSessionHasErrors();
12421242
{% endhighlight %}
12431243

12441244
* `return` bool
1245-
* deprecated
1245+
* `deprecated`
12461246

12471247

12481248
#### seeSessionHasValues
@@ -1271,7 +1271,7 @@ Selects an option in a select tag or in radio button group.
12711271
<?php
12721272
$I->selectOption('form select[name=account]', 'Premium');
12731273
$I->selectOption('form input[name=payment]', 'Monthly');
1274-
$I->selectOption('//form/select[@name=account]', 'Monthly');
1274+
$I->selectOption('//form/select[ * `name=account]',` 'Monthly');
12751275
?>
12761276

12771277
{% endhighlight %}
@@ -1475,9 +1475,9 @@ $form = [
14751475
'checkbox1' => true,
14761476
// ...
14771477
];
1478-
$I->submitForm('//form[@id=my-form]', $form, 'submitButton');
1478+
$I->submitForm('//form[ * `id=my-form]',` $form, 'submitButton');
14791479
// $I->amOnPage('/path/to/form-page') may be needed
1480-
$I->seeInFormFields('//form[@id=my-form]', $form);
1480+
$I->seeInFormFields('//form[ * `id=my-form]',` $form);
14811481
?>
14821482

14831483
{% endhighlight %}

0 commit comments

Comments
 (0)