Skip to content

Commit df4dc61

Browse files
DavertMikDavertMik
committed
auto updated documentation
1 parent 8ea1752 commit df4dc61

34 files changed

Lines changed: 1403 additions & 1416 deletions

‎changelog.markdown‎

Lines changed: 5 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -5,82 +5,53 @@ title: Codeception Changelog
55

66
# Changelog
77

8+
#### 2.0.2 06/27/2014
9+
10+
* [Yii1] disabled logging for better functional test performance
11+
812
#### 2.0.1 06/21/2014
913

1014
* [Phalcon1] Fixed connector
1115
* [WebDriver] added seeInPageSource and dontSeeInPageSource methods
1216
* [WebDriver] see method now checks only for visible BODY element by @artyfarty
1317
* [REST] added Bearer authentication by @dizews
1418
* removed auto added submit buttons in forms previously used as hook for DomCrawler
15-
16-
17-
#### 2.0.1 06/20/2014
18-
1919
* BUGFIX: PHP 5.4.x compatibility fixed. Sample error output: 'Method WelcomeCept.php does not exist' #1084 #1069 #1109
20-
21-
22-
#### 2.0.1 06/19/2014
23-
2420
* Second parameter of Cest method is treated as scenario variable on parse. Fix #1058
25-
26-
27-
#### 2.0.1 06/18/2014
28-
2921
* prints raw stack trace including codeception classes in -vvv mode
3022
* screenshots on fail are saved to properly named files #1075
3123
* [Symfony2] added debug config option to switch debug mode by @pmcjury
3224

33-
34-
3525
#### 2.0.0 06/05/2014
3626

3727
* renamed `_logs` dir to `_output` by default
3828
* renamed `_helpers` dir to `_support` by default
3929
* Guy renamed to Tester
4030
* Bootstrap command got 3 installation modes: default, compat, setup
41-
42-
#### 2.0.0 05/27/2014
43-
4431
* added --coverage-text option
4532

4633

4734
#### 2.0.0-RC2 05/12/2014
4835

4936
* removed fabpot/goutte, added Guzzle4 connector
50-
51-
52-
#### 2.0.0-RC 04/29/2014
53-
5437
* group configuration can accept groups by patterns
5538

5639

5740
#### 2.0.0-RC 04/02/2014
5841

5942
* [WebDriver] makeScreenshot does not use filename of a test
60-
61-
62-
#### 2.0.0-RC 03/21/2014
63-
64-
* added grabAttributeFrom
43+
* added `grabAttributeFrom`
6544
* seeElement to accept attributes in second parameter: seeElement('input',['name'=>'login'])
6645

6746

6847
#### 2.0.0-beta 03/19/2014
6948

7049
* executeInGuzzle is back in PhpBrowser
7150
* environment can be accessed via ->env in test
72-
73-
74-
#### 2.0.0-beta 03/18/2014
75-
7651
* before/after methods of Cest can take object
7752
* moved logger to extension
7853
* bootstrap files are loaded before suite only
7954
* extension can reconfigure global config
80-
81-
82-
#### 2.0.0-beta 03/17/2014
83-
8455
* removed RefactorAddNamespace and Analyze commands
8556
* added options to set output files for xml, html reports, and coverage
8657
* added extension to rerun failed tests

‎docs/02-GettingStarted.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ config:
7474

7575
{% endhighlight %}
7676

77-
After we configured utl we can run this test with `run` command:
77+
After we configured URL we can run this test with `run` command:
7878

7979
{% highlight yaml %}
8080
bash

‎docs/03-ModulesAndHelpers.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ title: Modules and Helpers - Codeception - Documentation
88
Codeception uses modularity to create a comfortable testing environment for every test suite you write.
99
Modules allow you to choose the actions and assertions that can be performed in tests.
1010

11-
All actions and assertions that can be performed by the Guy object in a class are defined in modules. It might look like Codeception limits you in testing, but it's not true. You can extend the testing suite with your own actions and assertions, writing them into a custom module.
11+
All actions and assertions that can be performed by the Tester object in a class are defined in modules. It might look like Codeception limits you in testing, but it's not true. You can extend the testing suite with your own actions and assertions, writing them into a custom module.
1212

1313
Let's look at this test.
1414

@@ -37,7 +37,7 @@ modules:
3737

3838
{% endhighlight %}
3939

40-
The FunctionalTester class has it's methods defined in modules. Actually, it doesn't contain any of them rather acts as a proxy. It knows which module executes this action and passes parameters into it. To make your IDE see all of the FunctionalTester methods, you use the `build` command. It generates the definition of the FunctionalTester class by copying the signatures from the corresponding modules.
40+
The FunctionalTester class has its methods defined in modules. Actually, it doesn't contain any of them rather acts as a proxy. It knows which module executes this action and passes parameters into it. To make your IDE see all of the FunctionalTester methods, you use the `build` command. It generates the definition of the FunctionalTester class by copying the signatures from the corresponding modules.
4141

4242
## Standard Modules
4343

‎docs/modules/AMQP.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,8 @@ Takes last message from queue.
106106

107107
$message = $I->grabMessageFromQueue('queue.emails');
108108

109-
* `param` $queue
110-
* `return` AMQPMessage
109+
* `param` $queue
110+
@return AMQPMessage
111111

112112

113113

@@ -125,8 +125,8 @@ $I->pushToExchange('exchange.emails', new AMQPMessage('Thanks!'));
125125

126126
{% endhighlight %}
127127

128-
* `param` $exchange
129-
* `param` $message string|AMQPMessage
128+
* `param` $exchange
129+
* `param` $message string|AMQPMessage
130130

131131

132132
#### pushToQueue
@@ -142,8 +142,8 @@ $I->pushToQueue('queue.jobs', new AMQPMessage('create'));
142142

143143
{% endhighlight %}
144144

145-
* `param` $queue
146-
* `param` $message string|AMQPMessage
145+
* `param` $queue
146+
* `param` $message string|AMQPMessage
147147

148148

149149

@@ -163,7 +163,7 @@ $I->seeMessageInQueueContainsText('queue.emails','davert');
163163

164164
{% endhighlight %}
165165

166-
* `param` $queue
167-
* `param` $text
166+
* `param` $queue
167+
* `param` $text
168168

169169

‎docs/modules/Asserts.md‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -38,97 +38,97 @@ Special module for using asserts in your tests.
3838

3939
Checks that haystack contains needle
4040

41-
* `param` $needle
42-
* `param` $haystack
43-
* `param` string $message
41+
* `param` $needle
42+
* `param` $haystack
43+
* `param string` $message
4444

4545

4646
#### assertEmpty
4747

4848
Checks that variable is empty.
4949

50-
* `param` $actual
51-
* `param` string $message
50+
* `param` $actual
51+
* `param string` $message
5252

5353

5454
#### assertEquals
5555

5656
Checks that two variables are equal.
5757

58-
* `param` $expected
59-
* `param` $actual
60-
* `param` string $message
58+
* `param` $expected
59+
* `param` $actual
60+
* `param string` $message
6161

62-
* `return` mixed
62+
@return mixed
6363

6464

6565
#### assertFalse
6666

6767
Checks that condition is negative.
6868

69-
* `param` $condition
70-
* `param` string $message
69+
* `param` $condition
70+
* `param string` $message
7171

7272

7373
#### assertGreaterThen
7474

7575
Checks that expected is greater then actual
7676

77-
* `param` $expected
78-
* `param` $actual
79-
* `param` string $message
77+
* `param` $expected
78+
* `param` $actual
79+
* `param string` $message
8080

8181

8282
#### assertGreaterThenOrEqual
8383

8484
Checks that expected is greater or equal then actual
8585

86-
* `param` $expected
87-
* `param` $actual
88-
* `param` string $message
86+
* `param` $expected
87+
* `param` $actual
88+
* `param string` $message
8989

9090

9191

9292
#### assertNotContains
9393

9494
Checks that haystack doesn't contain needle.
9595

96-
* `param` $needle
97-
* `param` $haystack
98-
* `param` string $message
96+
* `param` $needle
97+
* `param` $haystack
98+
* `param string` $message
9999

100100

101101
#### assertNotEmpty
102102

103103
Checks that variable is not empty.
104104

105-
* `param` $actual
106-
* `param` string $message
105+
* `param` $actual
106+
* `param string` $message
107107

108108

109109
#### assertNotEquals
110110

111111
Checks that two variables are not equal
112112

113-
* `param` $expected
114-
* `param` $actual
115-
* `param` string $message
113+
* `param` $expected
114+
* `param` $actual
115+
* `param string` $message
116116

117117

118118
#### assertNotNull
119119

120120
Checks that variable is not NULL
121121

122-
* `param` $actual
123-
* `param` string $message
122+
* `param` $actual
123+
* `param string` $message
124124

125125

126126
#### assertNull
127127

128128
Checks that variable is NULL
129129

130-
* `param` $actual
131-
* `param` string $message
130+
* `param` $actual
131+
* `param string` $message
132132

133133

134134

@@ -137,8 +137,8 @@ Checks that variable is NULL
137137

138138
Checks that condition is positive.
139139

140-
* `param` $condition
141-
* `param` string $message
140+
* `param` $condition
141+
* `param string` $message
142142

143143

144144

@@ -147,7 +147,7 @@ Checks that condition is positive.
147147

148148
Fails the test with message.
149149

150-
* `param` $message
150+
* `param` $message
151151

152152

153153

‎docs/modules/Cli.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Wrapper for basic shell commands and shell output
6262

6363
Checks that output from latest command doesn't contain text
6464

65-
* `param` $text
65+
* `param` $text
6666

6767

6868

@@ -75,15 +75,15 @@ Checks that output from latest command doesn't contain text
7575

7676
Executes a shell command
7777

78-
* `param` $command
78+
* `param` $command
7979

8080

8181

8282
#### seeInShellOutput
8383

8484
Checks that output from last executed command contains text
8585

86-
* `param` $text
86+
* `param` $text
8787

8888

8989
#### seeShellOutputMatches

0 commit comments

Comments
 (0)