diff options
author | David Timber <mieabby@gmail.com> | 2021-11-13 22:35:31 +0800 |
---|---|---|
committer | David Timber <mieabby@gmail.com> | 2021-11-13 22:35:31 +0800 |
commit | f5d9956c3e2343455a3025b9d38c539b680da8f5 (patch) | |
tree | 717c48f651899623f818a76f9d08ed7cb0aaee43 /src/imap.h | |
parent | d19a792e58eba8f13d9c7a0160cc5f1402e7f117 (diff) |
Doc progress, improve prne_mbedtls_pth_handle() ..
* Add param to prne_mbedtls_pth_handle() for returning return value from
the function or poll().
Diffstat (limited to 'src/imap.h')
-rw-r--r-- | src/imap.h | 5 |
1 files changed, 4 insertions, 1 deletions
@@ -69,7 +69,8 @@ void prne_free_imap (prne_imap_t *im); * \brief Clear the elements of the integer map object. * \param im The pointer to the integer map object. * \warning The function call may have the exact same effect as - * \c prne_free_imap() but \c prne_free_imap() must always be used. + * \c prne_free_imap() but \c prne_free_imap() must always be used to free the + * resources allocated for the object. */ void prne_imap_clear (prne_imap_t *im); /** @@ -79,6 +80,8 @@ void prne_imap_clear (prne_imap_t *im); * \param val The value of the new tuple. * \return The pointer to the new tuple allocated in the map. The pointer is * valid as long as the map object remains unmodified. + * \retval NULL if a memory allocation has occurred and \c errno is set to + * \c ENOMEM * \note Calling the function invalidates the pointers previously returned by * other functions. */ |