Skip to content

Commit 18c8dec

Browse files
DavertMikDavertMik
committed
auto updated documentation
1 parent debfc0e commit 18c8dec

File tree

6 files changed

+82
-82
lines changed

6 files changed

+82
-82
lines changed

‎docs/reference/Autoload.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Autoloader, which is fully compatible with PSR-4,
1212
and can be used to autoload your `Helper`, `Page`, and `Step` classes.
1313

1414

15-
addNamespace
16-
*static*
15+
### addNamespace
1716

17+
*static*
1818

1919
Adds a base directory for a namespace prefix.
2020

@@ -42,23 +42,23 @@ Autoload::addNamespace('app\Codeception', '/path/to/controllers');
4242

4343
[See source](https://github.com/Codeception/Codeception/blob/2.2/src/Codeception/Util/Autoload.php#L45)
4444

45-
load
46-
*static*
45+
### load
4746

47+
*static*
4848

4949
[See source](https://github.com/Codeception/Codeception/blob/2.2/src/Codeception/Util/Autoload.php#L88)
5050

51-
register
52-
*static*
51+
### register
5352

53+
*static*
5454

5555
* `deprecated` Use self::addNamespace() instead.
5656

5757
[See source](https://github.com/Codeception/Codeception/blob/2.2/src/Codeception/Util/Autoload.php#L75)
5858

59-
registerSuffix
60-
*static*
59+
### registerSuffix
6160

61+
*static*
6262

6363
* `deprecated` Use self::addNamespace() instead.
6464

‎docs/reference/Fixtures.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,21 +22,21 @@ Fixtures::get('user1');
2222

2323

2424

25-
add
26-
*static*
25+
### add
2726

27+
*static*
2828

2929
[See source](https://github.com/Codeception/Codeception/blob/2.2/src/Codeception/Util/Fixtures.php#L20)
3030

31-
cleanup
32-
*static*
31+
### cleanup
3332

33+
*static*
3434

3535
[See source](https://github.com/Codeception/Codeception/blob/2.2/src/Codeception/Util/Fixtures.php#L34)
3636

37-
get
38-
*static*
37+
### get
3938

39+
*static*
4040

4141
[See source](https://github.com/Codeception/Codeception/blob/2.2/src/Codeception/Util/Fixtures.php#L25)
4242

‎docs/reference/JsonType.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Class JsonType
3535
@package Codeception\Util
3636

3737

38-
__construct
38+
### __construct
3939

4040
Creates instance of JsonType
4141
Pass an array or `\Codeception\Util\JsonArray` with data.
@@ -45,9 +45,9 @@ If non-associative array is passed - the very first element of it will be used f
4545

4646
[See source](https://github.com/Codeception/Codeception/blob/2.2/src/Codeception/Util/JsonType.php#L42)
4747

48-
addCustomFilter
49-
*static*
48+
### addCustomFilter
5049

50+
*static*
5151

5252
Adds custom filter to JsonType list.
5353
You should specify a name and parameters of a filter.
@@ -78,15 +78,15 @@ JsonType::addCustomFilter('/len\((.*?)\)/', function($value, $len) {
7878

7979
[See source](https://github.com/Codeception/Codeception/blob/2.2/src/Codeception/Util/JsonType.php#L76)
8080

81-
cleanCustomFilters
82-
*static*
81+
### cleanCustomFilters
8382

83+
*static*
8484

8585
Removes all custom filters
8686

8787
[See source](https://github.com/Codeception/Codeception/blob/2.2/src/Codeception/Util/JsonType.php#L84)
8888

89-
matches
89+
### matches
9090

9191
Checks data against passed JsonType.
9292
If matching fails function returns a string with a message describing failure.

‎docs/reference/Locator.md‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ Please check them before writing complex functional or acceptance tests.
1313

1414

1515

16-
combine
17-
*static*
16+
### combine
1817

18+
*static*
1919

2020
Applies OR operator to any number of CSS or XPath selectors.
2121
You can mix up CSS and XPath selectors here.
@@ -53,9 +53,9 @@ As a result the Locator will produce a mixed XPath value that will be used in fi
5353

5454
[See source](https://github.com/Codeception/Codeception/blob/2.2/src/Codeception/Util/Locator.php#L46)
5555

56-
contains
57-
*static*
56+
### contains
5857

58+
*static*
5959

6060
Locates an element containing a text inside.
6161
Either CSS or XPath locator can be passed, however they will be converted to XPath.
@@ -73,9 +73,9 @@ Locator::contains('div[ * `contenteditable=true]',` 'hello world');
7373

7474
[See source](https://github.com/Codeception/Codeception/blob/2.2/src/Codeception/Util/Locator.php#L199)
7575

76-
elementAt
77-
*static*
76+
### elementAt
7877

78+
*static*
7979

8080
Locates element at position.
8181
Either CSS or XPath locator can be passed as locator,
@@ -96,9 +96,9 @@ Locator::elementAt('table#grind>tr', -2); // previous than last row
9696

9797
[See source](https://github.com/Codeception/Codeception/blob/2.2/src/Codeception/Util/Locator.php#L221)
9898

99-
find
100-
*static*
99+
### find
101100

101+
*static*
102102

103103
Finds element by it's attribute(s)
104104

@@ -111,9 +111,9 @@ Finds element by it's attribute(s)
111111

112112
[See source](https://github.com/Codeception/Codeception/blob/2.2/src/Codeception/Util/Locator.php#L137)
113113

114-
firstElement
115-
*static*
114+
### firstElement
116115

116+
*static*
117117

118118
Locates first element of group elements.
119119
Either CSS or XPath locator can be passed as locator,
@@ -130,9 +130,9 @@ Locator::firstElement('//table/tr');
130130

131131
[See source](https://github.com/Codeception/Codeception/blob/2.2/src/Codeception/Util/Locator.php#L247)
132132

133-
href
134-
*static*
133+
### href
135134

135+
*static*
136136

137137
Matches the *a* element with given URL
138138

@@ -152,9 +152,9 @@ $I->see('Log In', Locator::href('/login.php'));
152152

153153
[See source](https://github.com/Codeception/Codeception/blob/2.2/src/Codeception/Util/Locator.php#L73)
154154

155-
humanReadableString
156-
*static*
155+
### humanReadableString
157156

157+
*static*
158158

159159
Transforms strict locator, \Facebook\WebDriver\WebDriverBy into a string represenation
160160

@@ -163,27 +163,27 @@ Transforms strict locator, \Facebook\WebDriver\WebDriverBy into a string represe
163163

164164
[See source](https://github.com/Codeception/Codeception/blob/2.2/src/Codeception/Util/Locator.php#L275)
165165

166-
isCSS
167-
*static*
166+
### isCSS
168167

168+
*static*
169169

170170
* `param` $selector
171171
* `return` bool
172172

173173
[See source](https://github.com/Codeception/Codeception/blob/2.2/src/Codeception/Util/Locator.php#L154)
174174

175-
isID
176-
*static*
175+
### isID
177176

177+
*static*
178178

179179
Checks that string and CSS selector for element by ID
180180

181181

182182
[See source](https://github.com/Codeception/Codeception/blob/2.2/src/Codeception/Util/Locator.php#L181)
183183

184-
isXPath
185-
*static*
184+
### isXPath
186185

186+
*static*
187187

188188
Checks that locator is an XPath
189189

@@ -192,9 +192,9 @@ Checks that locator is an XPath
192192

193193
[See source](https://github.com/Codeception/Codeception/blob/2.2/src/Codeception/Util/Locator.php#L170)
194194

195-
lastElement
196-
*static*
195+
### lastElement
197196

197+
*static*
198198

199199
Locates last element of group elements.
200200
Either CSS or XPath locator can be passed as locator,
@@ -211,9 +211,9 @@ Locator::lastElement('//table/tr');
211211

212212
[See source](https://github.com/Codeception/Codeception/blob/2.2/src/Codeception/Util/Locator.php#L264)
213213

214-
option
215-
*static*
214+
### option
216215

216+
*static*
217217

218218
Matches option by text
219219

@@ -223,9 +223,9 @@ Matches option by text
223223

224224
[See source](https://github.com/Codeception/Codeception/blob/2.2/src/Codeception/Util/Locator.php#L109)
225225

226-
tabIndex
227-
*static*
226+
### tabIndex
228227

228+
*static*
229229

230230
Matches the element with given tab index
231231

0 commit comments

Comments
 (0)