From d86ad60aa538ea9a376f979af83e364bae77f8f4 Mon Sep 17 00:00:00 2001 From: Chris Jones Date: Fri, 29 Jan 2021 15:47:47 +0000 Subject: [PATCH] Change mbedtls_set_err_add_hook to use doxygen style comment Signed-off-by: Chris Jones --- include/mbedtls/error.h | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/include/mbedtls/error.h b/include/mbedtls/error.h index d060d177b..752f7bf05 100644 --- a/include/mbedtls/error.h +++ b/include/mbedtls/error.h @@ -114,19 +114,17 @@ extern "C" { #define MBEDTLS_ERR_ERROR_GENERIC_ERROR -0x0001 /**< Generic error */ #define MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED -0x006E /**< This is a bug in the library */ -/** Helper macro and function to combine a high and low level error code. - * - * This function uses a hook (`mbedtls_test_err_add_hook`) to allow invasive - * testing of its inputs. This is used in the test infrastructure to report - * on errors when combining two error codes of the same level (e.g: two high - * or two low level errors). - * - * To set a hook use - * ``` - * mbedtls_set_err_add_hook(&mbedtls_check_foo); - * ``` - */ + #if defined(MBEDTLS_TEST_HOOKS) +/** + * \brief Set a function pointer (hook) to allow for invasive testing of error + * code addition. + * + * This hook is used in the test infrastructure to report on errors when + * combining two error codes of the same level. + * + * \param hook hook to invasive testing function + */ void mbedtls_set_err_add_hook( void *hook ); int mbedtls_err_add( int high, int low, const char *file, int line ); #define MBEDTLS_ERR_ADD( high, low ) \