doxygen docs for ghash/edgehash

1 files changed, 14 insertions, 5 deletions

diff --git a/source/blender/blenlib/intern/edgehash.c b/source/blender/blenlib/intern/edgehash.c
index dac107187f3..cae23356782 100644
--- a/source/blender/blenlib/intern/edgehash.c
+++ b/source/blender/blenlib/intern/edgehash.c
@@ -82,9 +82,8 @@ struct EdgeHash {
 /* -------------------------------------------------------------------- */
 /* EdgeHash API */
 
-/* internal utility API */
-
-#define EDGE_HASH(v0, v1)  ((v0 * 39) ^ (v1 * 31))
+/** \name Internal Utility API
+ * \{ */
 
 BLI_INLINE bool edgehash_test_expand_buckets(const unsigned int nentries, const unsigned int nbuckets)
 {
@@ -94,7 +93,8 @@ BLI_INLINE bool edgehash_test_expand_buckets(const unsigned int nentries, const
 BLI_INLINE unsigned int edgehash_keyhash(EdgeHash *eh, unsigned int v0, unsigned int v1)
 {
 	BLI_assert(v0 < v1);
-	return EDGE_HASH(v0, v1) % eh->nbuckets;
+
+	return ((v0 * 39) ^ (v1 * 31)) % eh->nbuckets;
 }
 
 BLI_INLINE EdgeEntry *edgehash_lookup_entry_ex(EdgeHash *eh, unsigned int v0, unsigned int v1,
@@ -156,9 +156,11 @@ static void edgehash_insert_ex(EdgeHash *eh, unsigned int v0, unsigned int v1, v
 		MEM_freeN(old);
 	}
 }
+/** \} */
 
-#undef EDGE_HASH
 
+/** \name Public API
+ * \{ */
 
 /* Public API */
 
@@ -305,10 +307,15 @@ void BLI_edgehash_flag_clear(EdgeHash *eh, unsigned int flag)
 	eh->flag &= ~flag;
 }
 
+/** \} */
+
 
 /* -------------------------------------------------------------------- */
 /* EdgeHash Iterator API */
 
+/** \name Iterator API
+ * \{ */
+
 struct EdgeHashIterator {
 	EdgeHash *eh;
 	unsigned int curBucket;
@@ -398,3 +405,5 @@ bool BLI_edgehashIterator_isDone(EdgeHashIterator *ehi)
 {
 	return (ehi->curEntry == NULL);
 }
+
+/** \} */