From 2ee605a4ec1a818f77c1147ebeadba8f648f3a7b Mon Sep 17 00:00:00 2001 From: Niklas Hauser Date: Thu, 11 Feb 2016 22:27:55 +0000 Subject: [PATCH] Update documentation of greentea default handlers. --- "frameworks\\utest/utest/default_handlers.h" | 22 ++++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git "a/frameworks\\utest/utest/default_handlers.h" "b/frameworks\\utest/utest/default_handlers.h" index 69c819fef8..3ef00ce584 100644 --- "a/frameworks\\utest/utest/default_handlers.h" +++ "b/frameworks\\utest/utest/default_handlers.h" @@ -149,8 +149,8 @@ namespace v1 { status_t verbose_test_setup_handler (const size_t number_of_cases); /// Prints the number of tests that passed and failed with a reason if provided. void verbose_test_teardown_handler(const size_t passed, const size_t failed, const failure_t failure); - /// Prints the failure. - void verbose_test_failure_handler(const failure_t failure); + /// Prints the failure for `REASON_TEST_SETUP` and `REASON_TEST_TEARDOWN` and then dies. + void verbose_test_failure_handler (const failure_t failure); /// Prints the index and description of the case being run and continues. status_t verbose_case_setup_handler (const Case *const source, const size_t index_of_case); @@ -162,19 +162,19 @@ namespace v1 { /// Prints a helpful error message and aborts. /// This function **NEEDS** to be overridden by the user when using greentea. status_t greentea_test_setup_handler (const size_t number_of_cases); - /// Calls `verbose_test_teardown_handler` and then prints the greentea failure and success and end strings. + /// Reports the test results to greentea. void greentea_test_teardown_handler(const size_t passed, const size_t failed, const failure_t failure); - /// Does nothing. Use this for forwards compatibility. - void greentea_test_failure_handler(const failure_t failure); + /// Reports the failure for `REASON_TEST_SETUP` and `REASON_TEST_TEARDOWN` to greentea and then dies. + void greentea_test_failure_handler (const failure_t failure); - /// Forwards to `verbose_case_setup_handler`. Use this for forwards compatibility. + /// Registers the test case setup with greentea. status_t greentea_case_setup_handler (const Case *const source, const size_t index_of_case); - /// Forwards to `verbose_case_teardown_handler`. Use this for forwards compatibility. + /// Registers the test case teardown with greentea. status_t greentea_case_teardown_handler(const Case *const source, const size_t passed, const size_t failed, const failure_t failure); - /// Calls `verbose_case_failure_handler` but then aborts. - status_t greentea_case_failure_abort_handler (const Case *const source, const failure_t reason); - /// Forwards to `verbose_case_failure_handler`. Use this for forwards compatibility. - status_t greentea_case_failure_continue_handler (const Case *const source, const failure_t reason); + /// Reports the failure to greentea and then aborts. + status_t greentea_case_failure_abort_handler (const Case *const source, const failure_t reason); + /// Reports the failure to greentea and then continues. + status_t greentea_case_failure_continue_handler(const Case *const source, const failure_t reason); /// The verbose default handlers that always continue on failure extern const handlers_t verbose_continue_handlers;