summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorDominik Picheta <dominikpicheta@gmail.com>2016-03-23 12:47:05 +0000
committerDominik Picheta <dominikpicheta@gmail.com>2016-03-23 12:47:05 +0000
commit34401a3639d016de22050ac3703ce0daa78e18e7 (patch)
tree9ff6a448904c9694603707213c6bf9f8f100c2d8
parent1cc1a7faf46a50c1e7778b6f3d61ac1a5ae932c7 (diff)
downloadNim-34401a3639d016de22050ac3703ce0daa78e18e7.tar.gz
Documentation for `withLock`.
-rw-r--r--lib/core/locks.nim2
1 files changed, 2 insertions, 0 deletions
diff --git a/lib/core/locks.nim b/lib/core/locks.nim
index ba756a863..66e0ab520 100644
--- a/lib/core/locks.nim
+++ b/lib/core/locks.nim
@@ -56,6 +56,8 @@ proc signal*(cond: var Cond) {.inline.} =
   signalSysCond(cond)
 
 template withLock*(a: Lock, body: untyped) =
+  ## Acquires the given lock, executes the statements in body and
+  ## releases the lock after the statements finish executing.
   a.acquire()
   {.locks: [a].}:
     try: