From: Stephen Seo <seo.disparate@gmail.com>
Date: Thu, 7 Feb 2019 07:20:57 +0000 (+0900)
Subject: Add docs to HashMap
X-Git-Tag: 1.0~260
X-Git-Url: https://git.seodisparate.com/stephenseo/search/main.js?a=commitdiff_plain;h=eb9eb17a147466cba68ad1dfddde2afc6e218a44;p=UDPConnection

Add docs to HashMap
---

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