diff options
| author | Andrey Andreev <narf@devilix.net> | 2014-02-08 03:27:48 +0100 |
|---|---|---|
| committer | Andrey Andreev <narf@devilix.net> | 2014-02-08 03:27:48 +0100 |
| commit | 28c2c975b118016d07212ed8e7c22ff280309f82 (patch) | |
| tree | f1552392a3d87efebd7c565c6414ae41dc208ee9 /user_guide_src/source/libraries/unit_testing.rst | |
| parent | 9228f85b1b4f59cc88ba7c4addc258a7a5fd0ac0 (diff) | |
[ci skip] Add return types to library docs
Diffstat (limited to 'user_guide_src/source/libraries/unit_testing.rst')
| -rw-r--r-- | user_guide_src/source/libraries/unit_testing.rst | 33 |
1 files changed, 18 insertions, 15 deletions
diff --git a/user_guide_src/source/libraries/unit_testing.rst b/user_guide_src/source/libraries/unit_testing.rst index 2d4a27a25..0bc860f61 100644 --- a/user_guide_src/source/libraries/unit_testing.rst +++ b/user_guide_src/source/libraries/unit_testing.rst @@ -193,45 +193,48 @@ Class Reference .. method:: run($test[, $expected = TRUE[, $test_name = 'undefined'[, $notes = '']]]) - :param mixed $test: Test data - :param mixed $expected: Expected result - :param string $test_name: Test name - :param string $notes: Any notes to be attached to the test - :returns: string + :param mixed $test: Test data + :param mixed $expected: Expected result + :param string $test_name: Test name + :param string $notes: Any notes to be attached to the test + :returns: Test report + :rtype: string Runs unit tests. .. method:: report([$result = array()]) - :param array $result: Array containing tests results - :returns: string + :param array $result: Array containing tests results + :returns: Test report + :rtype: string Generates a report about already complete tests. .. method:: use_strict([$state = TRUE]) - :param bool $state: Strict state flag - :returns: void + :param bool $state: Strict state flag + :rtype: void Enables/disables strict type comparison in tests. .. method:: active([$state = TRUE]) - :param bool $state: Whether to enable testing - :returns: void + :param bool $state: Whether to enable testing + :rtype: void Enables/disables unit testing. .. method:: result([$results = array()]) - :param array $results: Tests results list - :returns: array + :param array $results: Tests results list + :returns: Array of raw result data + :rtype: array Returns raw tests results data. .. method:: set_template($template) - :param string $template: Test result template - :returns: void + :param string $template: Test result template + :rtype: void Sets the template for displaying tests results.
\ No newline at end of file |