Skip to content

Commit ddd65d5

Browse files
committed
Updated other documentation pages
1 parent 820dc16 commit ddd65d5

File tree

3 files changed

+24
-18
lines changed

3 files changed

+24
-18
lines changed

docs/reference/InitTemplate.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,13 @@ 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.0/src/Codeception/InitTemplate.php#L65)
37+
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L66)
38+
39+
#### addModulesToComposer()
40+
41+
*protected* addModulesToComposer($modules)
42+
43+
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L251)
3844
3945
#### addStyles()
4046
@@ -64,7 +70,7 @@ $this->ask('do you want to proceed (y/n)', true);
6470
* `param null` $answer
6571
* `return` mixed|string
6672

67-
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L107)
73+
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L108)
6874

6975
#### breakParts()
7076

@@ -76,7 +82,7 @@ $this->ask('do you want to proceed (y/n)', true);
7682

7783
*protected* checkInstalled($dir = null)
7884

79-
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L208)
85+
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L209)
8086

8187
#### completeSuffix()
8288

@@ -95,7 +101,7 @@ Requires a suite config as array in 3rd parameter.
95101
* `param` $directory
96102
* `param` $suiteConfig
97103

98-
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L223)
104+
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L224)
99105

100106
#### createDirectoryFor()
101107

@@ -110,7 +116,7 @@ Requires a suite config as array in 3rd parameter.
110116
Create an empty directory and add a placeholder file into it
111117
* `param` $dir
112118

113-
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L195)
119+
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L196)
114120

115121
#### createFile()
116122

@@ -127,7 +133,7 @@ Create a helper class inside a directory
127133
* `param` $name
128134
* `param` $directory
129135

130-
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L174)
136+
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L175)
131137

132138
#### getNamespaceHeader()
133139

@@ -157,15 +163,15 @@ Create a helper class inside a directory
157163

158164
*protected* gitIgnore($path)
159165

160-
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L201)
166+
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L202)
161167

162168
#### initDir()
163169

164170
*public* initDir($workDir)
165171

166172
Change the directory where Codeception should be installed.
167173

168-
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L75)
174+
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L76)
169175

170176
#### removeSuffix()
171177

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

190196
* `param string` $message
191197

192-
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L136)
198+
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L137)
193199

194200
#### sayInfo()
195201

@@ -198,7 +204,7 @@ $this->say('Welcome to Setup');
198204
Print info message
199205
* `param` $message
200206

201-
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L163)
207+
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L164)
202208

203209
#### saySuccess()
204210

@@ -207,7 +213,7 @@ Print info message
207213
Print a successful message
208214
* `param` $message
209215

210-
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L145)
216+
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L146)
211217

212218
#### sayWarning()
213219

@@ -216,7 +222,7 @@ Print a successful message
216222
Print warning message
217223
* `param` $message
218224

219-
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L154)
225+
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L155)
220226

221227
#### setup()
222228

@@ -225,6 +231,6 @@ Print warning message
225231
Override this class to create customized setup.
226232
* `return` mixed
227233

228-
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L88)
234+
[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L89)
229235

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

docs/reference/Stub.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ and it's return value or callback function as parameter
159159

160160
<?php
161161
Stub::makeEmpty('User', ['save' => function () { return true; }]);
162-
Stub::makeEmpty('User', ['save' => true));
162+
Stub::makeEmpty('User', ['save' => true]);
163163

164164
{% endhighlight %}
165165

@@ -210,7 +210,7 @@ Accepts either name of class or object of that class
210210
{% highlight php %}
211211

212212
<?php
213-
Stub::construct(new User, ['autosave' => false), ['name' => 'davert']);
213+
Stub::construct(new User, ['autosave' => false], ['name' => 'davert']);
214214
?>
215215

216216
{% endhighlight %}
@@ -256,7 +256,7 @@ Even protected and private properties can be set.
256256

257257
<?php
258258
Stub::constructEmpty('User', ['autosave' => false]);
259-
Stub::constructEmpty('User', ['autosave' => false), ['name' => 'davert']);
259+
Stub::constructEmpty('User', ['autosave' => false], ['name' => 'davert']);
260260

261261
{% endhighlight %}
262262

@@ -369,7 +369,7 @@ Stubbing a method call to return a list of values in the specified order.
369369
{% highlight php %}
370370

371371
<?php
372-
$user = Stub::make('User', array('getName' => Stub::consecutive('david', 'emma', 'sam', 'amy')));
372+
$user = Stub::make('User', ['getName' => Stub::consecutive('david', 'emma', 'sam', 'amy')]);
373373
$user->getName(); //david
374374
$user->getName(); //emma
375375
$user->getName(); //sam

docs/reference/XmlBuilder.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Export:
7272
* `$xml->getDom` - get a DOMDocument object
7373
* `$xml->__toString` - get a string representation of XML.
7474

75-
[Source code](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/XmlBuilder.php)
75+
[Source code](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/Util/XmlBuilder.php)
7676

7777

7878
#### __construct()

0 commit comments

Comments
 (0)