diff options
Diffstat (limited to 'include')
| -rw-r--r-- | include/dynstr.h | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/include/dynstr.h b/include/dynstr.h index 7283de5..d667e03 100644 --- a/include/dynstr.h +++ b/include/dynstr.h @@ -131,9 +131,11 @@ enum dynstr_err dynstr_dup(struct dynstr *dst, const struct dynstr *src); /** * This function frees memory used by the dynamic string. * @param d Dynamic string to be freed. - * @attention Attempting to call this function on an uninitialized or empty - * instance is undefined behaviour. - * @attention Parameters inside the struct are reset once memory is freed. + * @note This function does nothing on empty, initialized instances. + * @attention Calling this function on an uninitialized instance leads to + * undefined behaviour. + * @attention Once memory is freed, @ref dynstr_init is called so it can be + * used again. */ void dynstr_free(struct dynstr *d); |