updated docs

Author: DavertMik

RoboFile.php

@@ -225,12 +225,9 @@ public function buildDocsUtils()
                 ->docClass($className)
                 ->processMethod(function(ReflectionMethod $r, $text) use ($utilName) {
                     $line = $r->getStartLine();
-                    $modifiers = implode(' ', \Reflection::getModifierNames($r->getModifiers()));
-                    $title = "\n#### *$modifiers* {$r->name}";
-
                     $text = preg_replace("~@(.*?)([$\s])~",' * `$1` $2', $text);
                     $text .= "\n[See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/$utilName.php#L$line)";
-                    return $title.$text;
+                    return $text;
                 })
                 ->reorderMethods('ksort')
                 ->run();

docs/reference/commands.md

@@ -7,8 +7,8 @@
 
 Create new test suite. Requires suite name and actor name
 
-`codecept g:suite api Api` -> api + ApiGuy
-`codecept g:suite frontend Front` -> frontend + FrontGuy
+* `codecept g:suite api Api` -> api + ApiGuy
+* `codecept g:suite frontend Front` -> frontend + FrontGuy
 
 
 
@@ -59,7 +59,7 @@ Create new test suite. Requires suite name and actor name
 
 Try to execute test commands in run-time. You may try commands before writing the test.
 
-`codecept console acceptance` - starts acceptance suite environment. If you use WebDriver you can manipulate browser with Codeception commands.
+* `codecept console acceptance` - starts acceptance suite environment. If you use WebDriver you can manipulate browser with Codeception commands.
 
 
 
@@ -105,7 +105,7 @@ Try to execute test commands in run-time. You may try commands before writing th
 
 Creates empty Group file - extension which handles all group events.
 
-`codecept g:group Admin`
+* `codecept g:group Admin`
 
 
 
@@ -156,9 +156,9 @@ Creates empty Group file - extension which handles all group events.
 
 Generates Cept (scenario-driven test) file:
 
-`codecept generate:cept suite Login`
-`codecept g:cept suite subdir/subdir/testnameCept.php`
-`codecept g:cept suite LoginCept -c path/to/project`
+* `codecept generate:cept suite Login`
+* `codecept g:cept suite subdir/subdir/testnameCept.php`
+* `codecept g:cept suite LoginCept -c path/to/project`
 
 
 
@@ -209,6 +209,7 @@ Generates Cept (scenario-driven test) file:
 
 Executes tests.
 
+```
 Arguments:
  suite                 suite to be tested
  test                  test to be run
@@ -289,7 +290,7 @@ Options:
 
 Auto-updates phar archive from official site: 'http://codeception.com/codecept.phar' .
 
-`php codecept.phar self-update`
+* `php codecept.phar self-update`
 
 @author Franck Cassedanne <franck@cassedanne.com>
 
@@ -337,8 +338,8 @@ Auto-updates phar archive from official site: 'http://codeception.com/codecept.p
 
 Generates skeleton for Unit Test that extends `Codeception\TestCase\Test`.
 
-`codecept g:test unit User`
-`codecept g:test unit "App\User"`
+* `codecept g:test unit User`
+* `codecept g:test unit "App\User"`
 
 
 
@@ -390,8 +391,8 @@ Generates skeleton for Unit Test that extends `Codeception\TestCase\Test`.
 Generates Actor classes (initially Guy classes) from suite configs.
 Starting from Codeception 2.0 actor classes are auto-generated. Use this command to generate them manually.
 
-`codecept build`
-`codecept build path/to/project`
+* `codecept build`
+* `codecept build path/to/project`
 
 
 
@@ -443,7 +444,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 MyHelper`
 
 
 
@@ -546,9 +547,9 @@ You will be asked to choose one of the actors that will be used in tests. To ski
 
 Generates skeleton for unit test as in classical PHPUnit.
 
-`codecept g:phpunit unit UserTest`
-`codecept g:phpunit unit User`
-`codecept g:phpunit unit "App\User"`
+* `codecept g:phpunit unit UserTest`
+* `codecept g:phpunit unit User`
+* `codecept g:phpunit unit "App\User`
 
 
 
@@ -600,10 +601,9 @@ Generates skeleton for unit test as in classical PHPUnit.
 
 Generates user-friendly text scenarios from scenario-driven tests (Cest, Cept).
 
-`codecept g:scenarios acceptance` - for all acceptance tests
-`codecept g:scenarios acceptance --format html` - in html format
-`codecept g:scenarios acceptance --path doc` - generate scenarios to `doc` dir
-
+* `codecept g:scenarios acceptance` - for all acceptance tests
+* `codecept g:scenarios acceptance --format html` - in html format
+* `codecept g:scenarios acceptance --path doc` - generate scenarios to `doc` dir
 
 
 
@@ -658,8 +658,8 @@ Generates user-friendly text scenarios from scenario-driven tests (Cest, Cept).
 
 Generates StepObject class. You will be asked for steps you want to implement.
 
-`codecept g:step acceptance AdminSteps`
-`codecept g:step acceptance UserSteps --silent` - skip action questions
+* `codecept g:step acceptance AdminSteps`
+* `codecept g:step acceptance UserSteps --silent` - skip action questions
 
 
 
@@ -710,8 +710,9 @@ Generates StepObject class. You will be asked for steps you want to implement.
 * *Uses* `Codeception\Command\Shared\Config`
 
 Cleans `log` directory
-`codecept clean`
-`codecept clean -c path/to/project`
+
+* `codecept clean`
+* `codecept clean -c path/to/project`
 
 
 
@@ -756,10 +757,10 @@ Cleans `log` directory
 
 Generates Cest (scenario-driven object-oriented test) file:
 
-`codecept generate:cest suite Login`
-`codecept g:cest suite subdir/subdir/testnameCest.php`
-`codecept g:cest suite LoginCest -c path/to/project`
-`codecept g:cest "App\Login"`
+* `codecept generate:cest suite Login`
+* `codecept g:cest suite subdir/subdir/testnameCest.php`
+* `codecept g:cest suite LoginCest -c path/to/project`
+* `codecept g:cest "App\Login"`
 
 
 
@@ -812,9 +813,9 @@ Generates Cest (scenario-driven object-oriented test) file:
 Generates PageObject. Can be generated either globally, or just for one suite.
 If PageObject is generated globally it will act as UIMap, without any logic in it.
 
-`codecept g:page Login`
-`codecept g:page Registration`
-`codecept g:page acceptance Login`
+* `codecept g:page Login`
+* `codecept g:page Registration`
+* `codecept g:page acceptance Login`
 
 
 

docs/utils/Annotation.md

@@ -8,8 +8,7 @@ Simple annotation parser. Take only key-value annotations for methods or class.
 
 
 
-
-#### *public static* forClass#### *public static* forClass($class) Grabs annotation values.
+#### *public static* forClass($class) Grabs annotation values.
 
 Usage example:
 
@@ -26,25 +25,20 @@ Annotation::forClass('MyTestCase')->method('testData')->fetchAll('depends');
 
  * `return`  $this
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/Annotation.php#L39)
-
-#### *public static* forMethod#### *public static* forMethod($class, $method) * `param`  $class
+#### *public static* forMethod($class, $method) * `param`  $class
  * `param`  $method
 
  * `return`  $this
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/Annotation.php#L58)
-
-#### *public* __construct#### *public* __construct($class) 
+#### *public* __construct($class) 
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/Annotation.php#L63)
-
-#### *public* method#### *public* method($method) * `param`  $method
+#### *public* method($method) * `param`  $method
 
  * `return`  $this
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/Annotation.php#L73)
-
-#### *public* fetch#### *public* fetch($annotation) * `param`  $annotation
+#### *public* fetch($annotation) * `param`  $annotation
  * `return`  null
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/Annotation.php#L83)
-
-#### *public* fetchAll#### *public* fetchAll($annotation) * `param`  $annotation
+#### *public* fetchAll($annotation) * `param`  $annotation
  * `return`  array
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/Annotation.php#L96)

docs/utils/Autoload.md

@@ -6,8 +6,7 @@
 Custom autoloader to load classes by suffixes: `Helper`, `Page`, `Step`, etc.
 
 
-
-#### *public static* register#### *public static* register($namespace, $suffix, $path) A very basic yet useful autoloader, not compatible with PSR-0.
+#### *public static* register($namespace, $suffix, $path) A very basic yet useful autoloader, not compatible with PSR-0.
 It is used to autoload classes by namespaces with suffixes.
 
 Example:
@@ -26,18 +25,15 @@ Autoload::register('app\tests','Controller', __DIR__.'/controllers/');
  * `param`  $suffix
  * `param`  $path
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/Autoload.php#L34)
-
-#### *public static* registerSuffix#### *public static* registerSuffix($suffix, $path) Shortcut for { * `link`  self::register} for classes with empty namespaces.
+#### *public static* registerSuffix($suffix, $path) Shortcut for { * `link`  self::register} for classes with empty namespaces.
 
  * `param`  $suffix
  * `param`  $path
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/Autoload.php#L49)
-
-#### *public static* load#### *public static* load($class) * `param`  $class
+#### *public static* load($class) * `param`  $class
  * `return`  bool
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/Autoload.php#L58)
-
-#### *public static* matches#### *public static* matches($class, $namespace, $suffix) *is public for testing purposes*
+#### *public static* matches($class, $namespace, $suffix) *is public for testing purposes*
 
  * `param`  $class
  * `param`  $namespace

docs/utils/Debug.md

@@ -5,14 +5,11 @@
 
 This class is used only when Codeception is executed in `--debug` mode.
 In other cases method of this class won't be seen.
-
-#### *public static* setOutput#### *public static* setOutput($output) 
+#### *public static* setOutput($output) 
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/Debug.php#L18)
-
-#### *public static* debug#### *public static* debug($message) Prints data to screen. Message can be any time of data
+#### *public static* debug($message) Prints data to screen. Message can be any time of data
 
  * `param`  $message
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/Debug.php#L28)
-
-#### *public static* pause#### *public static* pause() Pauses execution and waits for user input to proceed.
+#### *public static* pause() Pauses execution and waits for user input to proceed.
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/Debug.php#L39)

docs/utils/FileSystem.md

@@ -4,14 +4,11 @@
 
 
 Set of functions to work with filesystem
-
-#### *public static* doEmptyDir#### *public static* doEmptyDir($path) * `param`  $path
+#### *public static* doEmptyDir($path) * `param`  $path
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/FileSystem.php#L13)
-
-#### *public static* deleteDir#### *public static* deleteDir($dir) * `param`  $dir
+#### *public static* deleteDir($dir) * `param`  $dir
  * `return`  bool
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/FileSystem.php#L39)
-
-#### *public static* copyDir#### *public static* copyDir($src, $dst) * `param`  $src
+#### *public static* copyDir($src, $dst) * `param`  $src
  * `param`  $dst
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/FileSystem.php#L69)

docs/utils/Fixtures.md

@@ -13,12 +13,9 @@ Fixtures::get('user1');
 ?>
 ```
 
-
-#### *public static* add#### *public static* add($name, $data) 
+#### *public static* add($name, $data) 
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/Fixtures.php#L21)
-
-#### *public static* get#### *public static* get($name) 
+#### *public static* get($name) 
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/Fixtures.php#L26)
-
-#### *public static* cleanup#### *public static* cleanup() 
+#### *public static* cleanup() 
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/Fixtures.php#L35)

docs/utils/Locator.md

@@ -6,8 +6,7 @@
 Set of useful functions for using CSS and XPath locators.
 Please check them before writing complex functional or acceptance tests.
 
-
-#### *public static* combine#### *public static* combine($selector1, $selector2) Applies OR operator to any number of CSS or XPath selectors.
+#### *public static* combine($selector1, $selector2) Applies OR operator to any number of CSS or XPath selectors.
 You can mix up CSS and XPath selectors here.
 
 ```php
@@ -36,8 +35,7 @@ As a result the Locator will produce a mixed XPath value that will be used in fi
  * `throws`  \Exception
  * `return`  string
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/Locator.php#L46)
-
-#### *public static* href#### *public static* href($url) Matches the *a* element with given URL
+#### *public static* href($url) Matches the *a* element with given URL
 
 ```php
 <?php
@@ -51,8 +49,7 @@ $I->see('Log In', Locator::href('/login.php'));
  * `param`  $url
  * `return`  string
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/Locator.php#L73)
-
-#### *public static* tabIndex#### *public static* tabIndex($index) Matches the element with given tab index
+#### *public static* tabIndex($index) Matches the element with given tab index
 
 Do you often use the `TAB` key to navigate through the web page? How do your site respond to this navigation?
 You could try to match elements by their tab position using `tabIndex` method of `Locator` class.
@@ -70,16 +67,14 @@ $I->click('Login');
  * `param`  $index
  * `return`  string
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/Locator.php#L97)
-
-#### *public static* option#### *public static* option($value) Matches option by text
+#### *public static* option($value) Matches option by text
 
  * `param`  $value
 
  * `return`  string
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/Locator.php#L109)
 
-
-#### *public static* find#### *public static* find($element, array $attributes) Finds element by it's attribute(s)
+#### *public static* find($element, array $attributes) Finds element by it's attribute(s)
 
  * `static` 
 
@@ -88,16 +83,13 @@ $I->click('Login');
 
  * `return`  string
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/Locator.php#L137)
-
-#### *public static* isCSS#### *public static* isCSS($selector) * `param`  $selector
+#### *public static* isCSS($selector) * `param`  $selector
  * `return`  bool
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/Locator.php#L154)
-
-#### *public static* isXPath#### *public static* isXPath($locator) Checks that locator is an XPath
+#### *public static* isXPath($locator) Checks that locator is an XPath
 
  * `param`  $locator
  * `return`  bool
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/Locator.php#L170)
-
-#### *public static* isID#### *public static* isID($id) Checks that string and CSS selector for element by ID
+#### *public static* isID($id) Checks that string and CSS selector for element by ID
 [See source](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Util/Locator.php#L181)