eden-emu/mbedtls
15
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve and fix documentation for error code combination

Browse source 
Improve documentation by:

- Fixing off by one errors in binary representations of error codes.
- Clarifying combinations of zero.
- Linking references to variables/macros via doxygen.

Signed-off-by: Chris Jones <christopher.jones@arm.com>
This commit is contained in:
Chris Jones 2021-04-12 15:44:47 +01:00
parent b7d02e0f15
commit abded0ed39
2 changed files with 9 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
include/mbedtls/error.h
View file

@ -133,10 +133,14 @@ extern void (*mbedtls_test_hook_error_add)( int, int, const char *, int );
* \brief Combines a high-level and low-level error code together.
*
* This function can be called directly however it is usually
* called via the mbedtls_error_add macro.
* called via the #MBEDTLS_ERROR_ADD macro.
*
* \note When invasive testing is enabled via MBEDTLS_TEST_HOOKS also try to
* call mbedtls_test_hook_error_add.
* While a value of zero is not a negative error code, it is still an
* error code (that denotes success) and can be combined with both a
* negative error code or another value of zero.
*
* \note When invasive testing is enabled via #MBEDTLS_TEST_HOOKS, also try to
* call \link mbedtls_test_hook_error_add \endlink.
*
* \param high high-level error code. See error.h for more details.
* \param low low-level error code. See error.h for more details.