From 3337d38651411b576a3a387396928d160de6d2f1 Mon Sep 17 00:00:00 2001
From: gingerBill <bill@gingerbill.org>
Date: Wed, 13 Oct 2021 23:39:17 +0100
Subject: [PATCH] Add comments to procedure groups

---
 core/sync/sync2/primitives.odin |  2 +-
 core/sync/sync2/sync_util.odin  | 18 ++++++++++++++++++
 2 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/core/sync/sync2/primitives.odin b/core/sync/sync2/primitives.odin
index 05e069e2a..d9e013664 100644
--- a/core/sync/sync2/primitives.odin
+++ b/core/sync/sync2/primitives.odin
@@ -24,7 +24,7 @@ mutex_unlock :: proc(m: ^Mutex) {
 	_mutex_unlock(m)
 }
 
-// mutex_lock tries to lock m, will return true on success, and false on failure
+// mutex_try_lock tries to lock m, will return true on success, and false on failure
 mutex_try_lock :: proc(m: ^Mutex) -> bool {
 	return _mutex_try_lock(m)
 }
diff --git a/core/sync/sync2/sync_util.odin b/core/sync/sync2/sync_util.odin
index 800bcd5e6..853c3c685 100644
--- a/core/sync/sync2/sync_util.odin
+++ b/core/sync/sync2/sync_util.odin
@@ -1,6 +1,12 @@
 package sync2
 
 
+// Example:
+//
+// if guard(&m) {
+//         ...
+// }
+//
 guard :: proc{
 	mutex_guard,
 	rw_mutex_guard,
@@ -12,11 +18,18 @@ guard :: proc{
 	atomic_rw_mutex_guard,
 }
 
+// Example:
+//
+// if shared_guard(&m) {
+//         ...
+// }
+//
 shared_guard :: proc{
 	rw_mutex_shared_guard,
 	atomic_rw_mutex_shared_guard,
 }
 
+// lock locks m
 lock :: proc{
 	mutex_lock,
 	rw_mutex_lock,
@@ -28,6 +41,7 @@ lock :: proc{
 	atomic_rw_mutex_lock,
 }
 
+// unlock locks m
 unlock :: proc{
 	mutex_unlock,
 	rw_mutex_unlock,
@@ -39,6 +53,7 @@ unlock :: proc{
 	atomic_rw_mutex_unlock,
 }
 
+// try_lock tries to lock m, will return true on success, and false on failure
 try_lock :: proc{
 	mutex_try_lock,
 	rw_mutex_try_lock,
@@ -49,16 +64,19 @@ try_lock :: proc{
 	atomic_rw_mutex_try_lock,
 }
 
+// shared_lock locks rw for reading (with arbitrary number of readers)
 shared_lock :: proc{
 	rw_mutex_shared_lock,
 	atomic_rw_mutex_shared_lock,
 }
 
+// shared_unlock unlocks rw for reading (with arbitrary number of readers)
 shared_unlock :: proc{
 	rw_mutex_shared_unlock,
 	atomic_rw_mutex_shared_unlock,
 }
 
+// try_shared_lock tries to lock rw for reading (with arbitrary number of readers)
 try_shared_lock :: proc{
 	rw_mutex_try_shared_lock,
 	atomic_rw_mutex_try_shared_lock,