Skip to content

Commit c5d6a0f

Browse files
NaktibaldaNaktibalda
committed
Updated changelog and some library docs
1 parent dc0e179 commit c5d6a0f

File tree

8 files changed

+945
-344
lines changed

8 files changed

+945
-344
lines changed

‎_includes/extensions.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## DotReporter
44

5-
[See Source](https://github.com/Codeception/Codeception/blob/4.2/ext/DotReporter.php)
5+
[See Source](https://github.com/Codeception/Codeception/blob/5.0/ext/DotReporter.php)
66

77
DotReporter provides less verbose output for test execution.
88
Like PHPUnit printer it prints dots "." for successful testes and "F" for failures.
@@ -38,7 +38,7 @@ Use this extension as an example for building custom reporters.
3838

3939
## Logger
4040

41-
[See Source](https://github.com/Codeception/Codeception/blob/4.2/ext/Logger.php)
41+
[See Source](https://github.com/Codeception/Codeception/blob/5.0/ext/Logger.php)
4242

4343
Log suites/tests/steps using Monolog library.
4444
Monolog should be installed additionally by Composer.
@@ -66,7 +66,7 @@ extensions:
6666

6767
## Recorder
6868

69-
[See Source](https://github.com/Codeception/Codeception/blob/4.2/ext/Recorder.php)
69+
[See Source](https://github.com/Codeception/Codeception/blob/5.0/ext/Recorder.php)
7070

7171
Saves a screenshot of each step in acceptance tests and shows them as a slideshow on one HTML page (here's an [example](https://codeception.com/images/recorder.gif))
7272
Activated only for suites with WebDriver module enabled.
@@ -125,7 +125,7 @@ public function testLogin(AcceptanceTester $I)
125125

126126
## RunBefore
127127

128-
[See Source](https://github.com/Codeception/Codeception/blob/4.2/ext/RunBefore.php)
128+
[See Source](https://github.com/Codeception/Codeception/blob/5.0/ext/RunBefore.php)
129129

130130
Extension for execution of some processes before running tests.
131131

@@ -156,7 +156,7 @@ HINT: you can use different configurations per environment.
156156

157157
## RunFailed
158158

159-
[See Source](https://github.com/Codeception/Codeception/blob/4.2/ext/RunFailed.php)
159+
[See Source](https://github.com/Codeception/Codeception/blob/5.0/ext/RunFailed.php)
160160

161161
Saves failed tests into tests/_output/failed in order to rerun failed tests.
162162

@@ -185,7 +185,7 @@ On each execution failed tests are logged and saved into `tests/_output/failed`
185185

186186
## RunProcess
187187

188-
[See Source](https://github.com/Codeception/Codeception/blob/4.2/ext/RunProcess.php)
188+
[See Source](https://github.com/Codeception/Codeception/blob/5.0/ext/RunProcess.php)
189189

190190
Extension to start and stop processes per suite.
191191
Can be used to start/stop selenium server, chromedriver, mailcatcher, etc.
@@ -232,7 +232,7 @@ HINT: you can use different configurations per environment.
232232

233233
## SimpleReporter
234234

235-
[See Source](https://github.com/Codeception/Codeception/blob/4.2/ext/SimpleReporter.php)
235+
[See Source](https://github.com/Codeception/Codeception/blob/5.0/ext/SimpleReporter.php)
236236

237237
This extension demonstrates how you can implement console output of your own.
238238
Recommended to be used for development purposes only.

‎changelog.markdown

Lines changed: 714 additions & 114 deletions
Large diffs are not rendered by default.

‎docs/reference/Autoload.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,12 @@ Autoload::addNamespace('app\Codeception', '/path/to/controllers');
4040
this causes it to be searched first rather than last.
4141
* `return` void
4242

43-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/Util/Autoload.php#L45)
43+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/Util/Autoload.php#L45)
4444

4545
#### load()
4646

4747
*public static* load($class)
4848

49-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/Util/Autoload.php#L72)
49+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/Util/Autoload.php#L72)
5050

51-
<p>&nbsp;</p><div class="alert alert-warning">Reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/Util/Autoload.php">Help us to improve documentation. Edit module reference</a></div>
51+
<p>&nbsp;</p><div class="alert alert-warning">Reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/Util/Autoload.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/reference/Fixtures.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,24 +27,24 @@ Fixtures::exists('user1');
2727

2828
*public static* add($name, $data)
2929

30-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/Util/Fixtures.php#L21)
30+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/Util/Fixtures.php#L21)
3131

3232
#### cleanup()
3333

3434
*public static* cleanup($name = null)
3535

36-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/Util/Fixtures.php#L35)
36+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/Util/Fixtures.php#L35)
3737

3838
#### exists()
3939

4040
*public static* exists($name)
4141

42-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/Util/Fixtures.php#L45)
42+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/Util/Fixtures.php#L45)
4343

4444
#### get()
4545

4646
*public static* get($name)
4747

48-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/Util/Fixtures.php#L26)
48+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/Util/Fixtures.php#L26)
4949

50-
<p>&nbsp;</p><div class="alert alert-warning">Reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/Util/Fixtures.php">Help us to improve documentation. Edit module reference</a></div>
50+
<p>&nbsp;</p><div class="alert alert-warning">Reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/Util/Fixtures.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/reference/InitTemplate.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -34,19 +34,19 @@ This class provides various helper methods for building customized setup
3434
3535
*public* __construct($input, $output)
3636
37-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L66)
37+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L66)
3838
3939
#### addModulesToComposer()
4040
4141
*protected* addModulesToComposer($modules)
4242
43-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L260)
43+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L260)
4444
4545
#### addStyles()
4646
4747
*public* addStyles($output)
4848
49-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L9)
49+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L9)
5050
5151
#### ask()
5252
@@ -70,25 +70,25 @@ $this->ask('do you want to proceed (y/n)', true);
7070
* `param mixed` $answer
7171
* `return` mixed|string
7272

73-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L108)
73+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L108)
7474

7575
#### breakParts()
7676

7777
*protected* breakParts($class)
7878

79-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L6)
79+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L6)
8080

8181
#### checkInstalled()
8282

8383
*protected* checkInstalled($dir = null)
8484

85-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L218)
85+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L218)
8686

8787
#### completeSuffix()
8888

8989
*protected* completeSuffix($filename, $suffix)
9090

91-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L25)
91+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L25)
9292

9393
#### createActor()
9494

@@ -101,13 +101,13 @@ Requires a suite config as array in 3rd parameter.
101101
* `param` $directory
102102
* `param` $suiteConfig
103103

104-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L233)
104+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L233)
105105

106106
#### createDirectoryFor()
107107

108108
*protected* createDirectoryFor($basePath, $className = null)
109109

110-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L10)
110+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L10)
111111

112112
#### createEmptyDirectory()
113113

@@ -116,13 +116,13 @@ Requires a suite config as array in 3rd parameter.
116116
Create an empty directory and add a placeholder file into it
117117
* `param` $dir
118118

119-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L205)
119+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L205)
120120

121121
#### createFile()
122122

123123
*protected* createFile($filename, $contents, $force = null, $flags = null)
124124

125-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L46)
125+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L46)
126126

127127
#### createHelper()
128128

@@ -133,51 +133,51 @@ Create a helper class inside a directory
133133
* `param` $name
134134
* `param` $directory
135135

136-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L184)
136+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L184)
137137

138138
#### getNamespaceHeader()
139139

140140
*protected* getNamespaceHeader($class)
141141

142-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L25)
142+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L25)
143143

144144
#### getNamespaceString()
145145

146146
*protected* getNamespaceString($class)
147147

148-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L19)
148+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L19)
149149

150150
#### getNamespaces()
151151

152152
*protected* getNamespaces($class)
153153

154-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L34)
154+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L34)
155155

156156
#### getShortClassName()
157157

158158
*protected* getShortClassName($class)
159159

160-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L13)
160+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L13)
161161

162162
#### gitIgnore()
163163

164164
*protected* gitIgnore($path)
165165

166-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L211)
166+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L211)
167167

168168
#### initDir()
169169

170170
*public* initDir($workDir)
171171

172172
Change the directory where Codeception should be installed.
173173

174-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L76)
174+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L76)
175175

176176
#### removeSuffix()
177177

178178
*protected* removeSuffix($classname, $suffix)
179179

180-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L40)
180+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L40)
181181

182182
#### say()
183183

@@ -195,7 +195,7 @@ $this->say('Welcome to Setup');
195195

196196
* `param string` $message
197197

198-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L137)
198+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L137)
199199

200200
#### sayError()
201201

@@ -204,7 +204,7 @@ $this->say('Welcome to Setup');
204204
Print error message
205205
* `param string` $message
206206

207-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L155)
207+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L155)
208208

209209
#### sayInfo()
210210

@@ -213,7 +213,7 @@ Print error message
213213
Print info message
214214
* `param string` $message
215215

216-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L173)
216+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L173)
217217

218218
#### saySuccess()
219219

@@ -222,7 +222,7 @@ Print info message
222222
Print a successful message
223223
* `param string` $message
224224

225-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L146)
225+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L146)
226226

227227
#### sayWarning()
228228

@@ -231,7 +231,7 @@ Print a successful message
231231
Print warning message
232232
* `param` $message
233233

234-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L164)
234+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L164)
235235

236236
#### setup()
237237

@@ -240,12 +240,12 @@ Print warning message
240240
Override this class to create customized setup.
241241
* `return` mixed
242242

243-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L89)
243+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L89)
244244

245245
#### updateComposerClassMap()
246246

247247
*private* updateComposerClassMap($vendorDir = null)
248248

249-
[See source](https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php#L336)
249+
[See source](https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php#L336)
250250

251-
<p>&nbsp;</p><div class="alert alert-warning">Reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/blob/4.2/src/Codeception/InitTemplate.php">Help us to improve documentation. Edit module reference</a></div>
251+
<p>&nbsp;</p><div class="alert alert-warning">Reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/blob/5.0/src/Codeception/InitTemplate.php">Help us to improve documentation. Edit module reference</a></div>

0 commit comments

Comments
 (0)