auto updated documentation

DavertMik · DavertMik · commit c520578e2982 · 2016-02-10T13:34:30.000+02:00
diff --git a/_includes/extensions.md b/_includes/extensions.md
@@ -48,7 +48,6 @@ extensions:
 
 * `delete_successful` (default: true) - delete records for successfully passed tests (log only failed and errored)
 * `module` (default: WebDriver) - which module for screenshots to use. Module should implement `Codeception\Lib\Interfaces\ScreenshotSaver` interaface. Currently only WebDriver or any its children can be used.
-* `animate_slides` (default: true) - set false to disable sliding transition between screenshots
 
 ``` yaml
 extensions:
diff --git a/docs/modules/WebDriver.md b/docs/modules/WebDriver.md
@@ -59,6 +59,7 @@ In case you want to test a local site or site behind a firewall you should use a
 1. Create an account at [SauceLabs.com](http://SauceLabs.com) to get your username and access key
 2. In the module configuration use the format `username`:`access_key`@ondemand.saucelabs.com' for `host`
 3. Configure `platform` under `capabilities` to define the [Operating System](https://docs.saucelabs.com/reference/platforms-configurator/#/)
+4. run a tunnel app if your site can't be accessed from Internet
 
 {% highlight yaml %}
 
@@ -73,13 +74,13 @@ In case you want to test a local site or site behind a firewall you should use a
                  platform: 'Windows 10'
 
 {% endhighlight %}
-4. run a tunnel app if your site can't be accessed from Internet
 
 #### BrowserStack
 
 1. Create an account at [BrowserStack](https://www.browserstack.com/) to get your username and access key
 2. In the module configuration use the format `username`:`access_key`@ondemand.saucelabs.com' for `host`
 3. Configure `platform` under `capabilities` to define the [Operating System](https://docs.saucelabs.com/reference/platforms-configurator/#/)
+4. If your site is available only locally or via VPN you should use a tunnel app. In this case add `browserstack.local` capability and set it to true.
 
 {% highlight yaml %}
 
@@ -96,7 +97,6 @@ In case you want to test a local site or site behind a firewall you should use a
                  browserstack.local: true # for local testing
 
 {% endhighlight %}
-4. run a tunnel app if your site can't be accessed from Internet. In this case ensure that `browserstack.local` capability is set to true.
 
 ### Configuration
 
@@ -117,6 +117,8 @@ In case you want to test a local site or site behind a firewall you should use a
 
 Example (`acceptance.suite.yml`)
 
+{% highlight yaml %}
+
     modules:
        enabled:
           - WebDriver:
@@ -127,6 +129,8 @@ Example (`acceptance.suite.yml`)
                  unexpectedAlertBehaviour: 'accept'
                  firefox_profile: '~/firefox-profiles/codeception-profile.zip.b64'
 
+{% endhighlight %}
+
 #### Status
 
 Stability: **stable**
diff --git a/docs/reference/Commands.md b/docs/reference/Commands.md
@@ -123,6 +123,7 @@ Starting from Codeception 2.0 actor classes are auto-generated. Use this command
 Creates empty Helper class.
 
 * `codecept g:helper MyHelper`
+* `codecept g:helper "My\Helper"`
 
 
 
diff --git a/docs/reference/JsonType.md b/docs/reference/JsonType.md
@@ -55,10 +55,10 @@ Example:
 {% highlight php %}
 
 <?php
-JsonType::addCustomFilter('email', function($value) {
-    return strpos(' * `',`  $value) !== false;
+JsonType::addCustomFilter('slug', function($value) {
+    return strpos(' ', $value) !== false;
 });
-// => use it as 'string:email'
+// => use it as 'string:slug'
 
 
 // add custom function to matcher with `len($val)` syntax
diff --git a/docs/reference/Stub.md b/docs/reference/Stub.md
@@ -30,7 +30,7 @@ $user->getName();
 
  * `return`  StubMarshaler
 
-[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L663)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L666)
 
 #### *public static* consecutive() 
 
@@ -50,7 +50,7 @@ $user->getName(); //amy
 
  * `return`  ConsecutiveMap
 
-[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L726)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L729)
 
 #### *public static* construct($class, $constructorParams = null, $params = null, $testCase = null) 
 
@@ -96,7 +96,7 @@ Stub::construct('User', array(), array('save' => true }));
 
  * `return`  object
 
-[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L279)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L282)
 
 #### *public static* constructEmpty($class, $constructorParams = null, $params = null, $testCase = null) 
 
@@ -142,7 +142,7 @@ Stub::constructEmpty('User', array(), array('save' => true }));
 
  * `return`  object
 
-[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L330)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L333)
 
 #### *public static* constructEmptyExcept($class, $method, $constructorParams = null, $params = null, $testCase = null) 
 
@@ -189,7 +189,7 @@ Stub::constructEmptyExcept('User', 'save', array(), array('save' => true }));
 
  * `return`  object
 
-[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L386)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L389)
 
 #### *public static* copy($obj, $params = null) 
 
@@ -200,7 +200,7 @@ Clones an object and redefines it's properties (even protected and private)
 
  * `return`  mixed
 
-[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L234)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L237)
 
 #### *public static* exactly($count, $params = null) 
 
@@ -227,7 +227,7 @@ $user->getName();
 
  * `return`  StubMarshaler
 
-[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L693)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L696)
 
 #### *public static* factory($class, $num = null, $params = null) 
 
@@ -239,7 +239,7 @@ Creates $num instances of class through `Stub::make`.
 
  * `return`  array
 
-[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L90)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L93)
 
 #### *public static* make($class, $params = null, $testCase = null) 
 
@@ -329,7 +329,7 @@ Stub::makeEmpty('User', array('save' => true }));
 
  * `return`  object
 
-[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L208)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L211)
 
 #### *public static* makeEmptyExcept($class, $method, $params = null, $testCase = null) 
 
@@ -375,7 +375,7 @@ Stub::makeEmptyExcept('User', 'save', array('isValid' => true }));
 
  * `return`  object
 
-[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L137)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L140)
 
 #### *public static* never($params = null) 
 
@@ -397,7 +397,7 @@ $user->someMethod();
 
  * `return`  StubMarshaler
 
-[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L610)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L613)
 
 #### *public static* once($params = null) 
 
@@ -421,7 +421,7 @@ $this->assertEquals('Davert', $userName);
 
  * `return`  StubMarshaler
 
-[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L637)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L640)
 
 #### *public static* update($mock, array $params) 
 
@@ -433,6 +433,6 @@ Replaces properties of current stub
  * `return`  mixed
  * `throws`  \LogicException
 
-[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L479)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L482)
 
 <p>&nbsp;</p><div class="alert alert-warning">Reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php">Help us to improve documentation. Edit module reference</a></div>
diff --git a/docs/reference/XmlBuilder.md b/docs/reference/XmlBuilder.md
@@ -27,7 +27,7 @@ $xml->users
            ->attr('empty','false')
            ->items
                ->item
-                   ->val('useful item')
+                   ->val('useful item');
                ->parents('user')
        ->active
            ->val(1);

Original file line number	Diff line number	Diff line change
`@@ -123,6 +123,7 @@ Starting from Codeception 2.0 actor classes are auto-generated. Use this command`
`123`	`123`	`Creates empty Helper class.`
`124`	`124`
`125`	`125`	* `codecept g:helper MyHelper`
	`126`	+* `codecept g:helper "My\Helper"`
`126`	`127`
`127`	`128`
`128`	`129`