From d58fc1598a50a6635a57ee078ea78dbd2c8a67b2 Mon Sep 17 00:00:00 2001 From: Snaipe Date: Tue, 15 Sep 2015 19:02:52 +0200 Subject: [PATCH] Fixed documentation on report hook parameters --- doc/hooks.rst | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/doc/hooks.rst b/doc/hooks.rst index ff334a6..ae7d463 100644 --- a/doc/hooks.rst +++ b/doc/hooks.rst @@ -41,10 +41,7 @@ The flow of the test process goes as follows: Hook Parameters --------------- -A report hook may take zero or one parameter. If a parameter is given, it -is undefined behaviour if it is not a pointer type and not of the proper pointed -type for that phase. - +A report hook takes exactly one parameter. Valid types for each phases are: * ``struct criterion_test_set *`` for ``PRE_ALL``. @@ -56,17 +53,13 @@ Valid types for each phases are: * ``struct criterion_suite_stats *`` for ``POST_SUITE``. * ``struct criterion_global_stats *`` for ``POST_ALL``. -For instance, these are valid report hook declarations for the ``PRE_TEST`` phase: +For instance, this is a valid report hook declaration for the ``PRE_TEST`` phase: .. code-block:: c #include #include - ReportHook(PRE_TEST)() { - // not using the parameter - } - ReportHook(PRE_TEST)(struct criterion_test *test) { // using the parameter }