AuroraMiddleware/mbedtls
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

tests: Improve the documentation of mbedtls_test_unhexify()

Browse Source 
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
This commit is contained in:
Ronald Cron 2020-07-01 17:09:10 +02:00
parent 82ac38ee5d
commit ab500cb73c
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
tests/include/test/helpers.h
View File

@ -55,10 +55,8 @@ int mbedtls_test_platform_setup( void );
void mbedtls_test_platform_teardown( void ); void mbedtls_test_platform_teardown( void );
/** /**
* \brief This function translates an ASCII string encoding an * \brief This function decodes the hexadecimal representation of
* hexadecimal number into the encoded hexadecimal number. The * data.
* hexadecimal number is represented as an array of
* unsigned char.
* *
* \note The output buffer can be the same as the input buffer. For * \note The output buffer can be the same as the input buffer. For
* any other overlapping of the input and output buffers, the * any other overlapping of the input and output buffers, the
@ -72,7 +70,7 @@ void mbedtls_test_platform_teardown( void );
* *
* \return \c 0 on success. * \return \c 0 on success.
* \return \c -1 if the output buffer is too small or the input string * \return \c -1 if the output buffer is too small or the input string
* is not a valid ASCII encoding of an hexadecimal number. * is not a valid hexadecimal representation.
*/ */
int mbedtls_test_unhexify( unsigned char *obuf, size_t obufmax, int mbedtls_test_unhexify( unsigned char *obuf, size_t obufmax,
const char *ibuf, size_t *len ); const char *ibuf, size_t *len );