Thu, 19 Dec 2019 18:47:23 +0100
adds missing documentation for custom multiplication function
src/ucx/ucx.h | file | annotate | diff | comparison | revisions |
1.1 --- a/src/ucx/ucx.h Thu Dec 19 18:40:00 2019 +0100 1.2 +++ b/src/ucx/ucx.h Thu Dec 19 18:47:23 2019 +0100 1.3 @@ -170,10 +170,7 @@ 1.4 1.5 /** 1.6 * Performs a multiplication of size_t values and checks for overflow. 1.7 - * 1.8 - * This is a custom implementation in case there is no compiler builtin 1.9 - * available. 1.10 - * 1.11 + * 1.12 * @param a first operand 1.13 * @param b second operand 1.14 * @param result a pointer to a size_t, where the result should 1.15 @@ -183,6 +180,18 @@ 1.16 */ 1.17 #define ucx_szmul(a, b, result) ucx_szmul_impl(a, b, result) 1.18 1.19 +/** 1.20 + * Performs a multiplication of size_t values and checks for overflow. 1.21 + * 1.22 + * This is a custom implementation in case there is no compiler builtin 1.23 + * available. 1.24 + * 1.25 + * @param a first operand 1.26 + * @param b second operand 1.27 + * @param result a pointer to a size_t where the result should be stored 1.28 + * @return zero, if no overflow occurred and the result is correct, non-zero 1.29 + * otherwise 1.30 + */ 1.31 int ucx_szmul_impl(size_t a, size_t b, size_t *result); 1.32 1.33 #endif