auto updated documentation

DavertMik · DavertMik · commit 1db3273e02bb · 2016-02-10T04:13:43.000+02:00
diff --git a/_includes/extensions.md b/_includes/extensions.md
@@ -48,6 +48,7 @@ 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/04-FunctionalTests.md b/docs/04-FunctionalTests.md
@@ -233,6 +233,7 @@ Take a look at the complete reference for module you are using. Most of its meth
 Also you can access framework globals inside a test or access Dependency Injection containers inside `Helper\Functional` class.
 
 {% highlight php %}
+
 <?php
 namespace Helper;
 
@@ -245,6 +246,7 @@ class Functional extends \Codeception\Module
     }
 }
 ?>
+
 {% endhighlight %}
 
 Check also all available *Public Properties* of used modules to get full access to its data. 
diff --git a/docs/modules/WebDriver.md b/docs/modules/WebDriver.md
@@ -12,30 +12,91 @@ title: WebDriver - Codeception - Documentation
 
 New generation Selenium WebDriver module.
 
-### Selenium Installation
+### Local Testing
+
+#### Selenium
 
 1. Download [Selenium Server](http://docs.seleniumhq.org/download/)
 2. Launch the daemon: `java -jar selenium-server-standalone-2.xx.xxx.jar`
+3. Configure this module (in acceptance.suite.yml) by setting url and browser:
 
+{% highlight yaml %}
 
-### PhantomJS Installation
+    modules:
+       enabled:
+          - WebDriver:
+             url: 'http://localhost/'
+             browser: firefox
+
+{% endhighlight %}
+
+#### PhantomJS
 
 PhantomJS is a headless alternative to Selenium Server that implements [the WebDriver protocol](https://code.google.com/p/selenium/wiki/JsonWireProtocol).
 It allows you to run Selenium tests on a server without a GUI installed.
 
 1. Download [PhantomJS](http://phantomjs.org/download.html)
 2. Run PhantomJS in WebDriver mode: `phantomjs --webdriver=4444`
+3. Configure this module (in acceptance.suite.yml) by setting url and `phantomjs` as browser:
+
+{% highlight yaml %}
+
+    modules:
+       enabled:
+          - WebDriver:
+             url: 'http://localhost/'
+             browser: phantomjs
+
+{% endhighlight %}
+
+### Cloud Testing
+
+Cloud Testing services can run your WebDriver tests in the cloud.
+In case you want to test a local site or site behind a firewall you should use a tunnel application provided by a service.
+
+#### SauceLabs
+
+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/#/)
+
+{% highlight yaml %}
 
-You will need to set a browser name to `phantom` in configuration.
+    modules:
+       enabled:
+          - WebDriver:
+             url: http://mysite.com
+             host: '<username>:<access key>@ondemand.saucelabs.com'
+             port: 80
+             browser: chrome
+             capabilities:
+                 platform: 'Windows 10'
 
+{% endhighlight %}
+4. run a tunnel app if your site can't be accessed from Internet
 
-### Status
+#### BrowserStack
 
-* Maintainer: **davert**
-* Stability: **stable**
-* Contact: davert.codecept@mailican.com
-* Based on [facebook php-webdriver](https://github.com/facebook/php-webdriver)
+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/#/)
 
+{% highlight yaml %}
+
+    modules:
+       enabled:
+          - WebDriver:
+             url: http://mysite.com
+             host: '<username>:<access key>@hub.browserstack.com'
+             port: 80
+             browser: chrome
+             capabilities:
+                 os: Windows
+                 os_version: 10
+                 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
 
@@ -54,7 +115,7 @@ You will need to set a browser name to `phantom` in configuration.
 * `http_proxy_port` - sets http proxy server port
 * `debug_log_entries` - how many selenium entries to print with `debugWebDriverLogs` or on fail (15 by default).
 
-#### Example (`acceptance.suite.yml`)
+Example (`acceptance.suite.yml`)
 
     modules:
        enabled:
@@ -64,31 +125,16 @@ You will need to set a browser name to `phantom` in configuration.
              window_size: 1024x768
              capabilities:
                  unexpectedAlertBehaviour: 'accept'
-                 firefox_profile: '/Users/paul/Library/Application Support/Firefox/Profiles/codeception-profile.zip.b64'
+                 firefox_profile: '~/firefox-profiles/codeception-profile.zip.b64'
 
+#### Status
 
-#### PhantomJS Example (`acceptance.suite.yml`)
-
-    modules:
-       enabled:
-          - WebDriver:
-             url: 'http://localhost/'
-             browser: phantomjs
-
-
-### SauceLabs.com Integration
-
-SauceLabs can run your WebDriver tests in the cloud, you can also create a tunnel
-enabling you to test locally hosted sites from their servers.
-
-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/#/)
-
-[CodeCeption and SauceLabs example](https://github.com/Codeception/Codeception/issues/657#issuecomment-28122164)
+Stability: **stable**
+Based on [facebook php-webdriver](https://github.com/facebook/php-webdriver)
 
+### Usage
 
-### Locating Elements
+#### Locating Elements
 
 Most methods in this module that operate on a DOM element (e.g. `click`) accept a locator as the first argument, which can be either a string or an array.
 
diff --git a/docs/reference/Commands.md b/docs/reference/Commands.md
@@ -123,7 +123,6 @@ 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('slug', function($value) {
-    return strpos(' ', $value) !== false;
+JsonType::addCustomFilter('email', function($value) {
+    return strpos(' * `',`  $value) !== false;
 });
-// => use it as 'string:slug'
+// => use it as 'string:email'
 
 
 // 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#L666)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L663)
 
 #### *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#L729)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L726)
 
 #### *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#L282)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L279)
 
 #### *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#L333)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L330)
 
 #### *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#L389)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L386)
 
 #### *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#L237)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L234)
 
 #### *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#L696)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L693)
 
 #### *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#L93)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L90)
 
 #### *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#L211)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L208)
 
 #### *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#L140)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L137)
 
 #### *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#L613)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L610)
 
 #### *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#L640)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L637)
 
 #### *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#L482)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Stub.php#L479)
 
 <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
`@@ -233,6 +233,7 @@ Take a look at the complete reference for module you are using. Most of its meth`
`233`	`233`	Also you can access framework globals inside a test or access Dependency Injection containers inside `Helper\Functional` class.
`234`	`234`
`235`	`235`	`{% highlight php %}`
	`236`	`+`
`236`	`237`	`<?php`
`237`	`238`	`namespace Helper;`
`238`	`239`
`@@ -245,6 +246,7 @@ class Functional extends \Codeception\Module`
`245`	`246`	`}`
`246`	`247`	`}`
`247`	`248`	`?>`
	`249`	`+`
`248`	`250`	`{% endhighlight %}`
`249`	`251`
`250`	`252`	`Check also all available Public Properties of used modules to get full access to its data.`
Original file line number	Diff line number	Diff line change
`@@ -123,7 +123,6 @@ 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"`
`127`	`126`
`128`	`127`
`129`	`128`