From eb9eb17a147466cba68ad1dfddde2afc6e218a44 Mon Sep 17 00:00:00 2001 From: Stephen Seo Date: Thu, 7 Feb 2019 16:20:57 +0900 Subject: [PATCH] Add docs to HashMap --- src/UDPC_HashMap.h | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/UDPC_HashMap.h b/src/UDPC_HashMap.h index 5297e40..73103ae 100644 --- a/src/UDPC_HashMap.h +++ b/src/UDPC_HashMap.h @@ -46,8 +46,16 @@ void UDPC_HashMap_destroy(UDPC_HashMap *hashMap); */ void* UDPC_HashMap_insert(UDPC_HashMap *hm, uint32_t key, void *data); +/*! + * \brief Removes data with the given key + * \return non-zero if data was successfully removed + */ int UDPC_HashMap_remove(UDPC_HashMap *hm, uint32_t key); +/*! + * \brief Returns a pointer to data with the given key + * \return non-NULL if data was found + */ void* UDPC_HashMap_get(UDPC_HashMap *hm, uint32_t key); #endif -- 2.49.0