From b7d945124e17677abb2232e96b14c8be8871a82c Mon Sep 17 00:00:00 2001
From: Max Hilbrunner
Date: Fri, 22 Dec 2017 16:46:09 +0100
Subject: [DOCS] Small fixes for Mutex
---
doc/classes/Mutex.xml | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/doc/classes/Mutex.xml b/doc/classes/Mutex.xml
index 4b845c05a..74d59b2dd 100644
--- a/doc/classes/Mutex.xml
+++ b/doc/classes/Mutex.xml
@@ -4,7 +4,7 @@
A synchronization Mutex.
- A synchronization Mutex. Element used in multi-threadding. Basically a binary [Semaphore]. Guarantees that only one thread has this lock, can be used to protect a critical section.
+ A synchronization Mutex. Element used to synchronize multiple [Thread]s. Basically a binary [Semaphore]. Guarantees that only one thread can ever acquire this lock at a time. Can be used to protect a critical section. Be careful to avoid deadlocks.
@@ -22,14 +22,14 @@
- Try locking this [code]Mutex[/code], does not block. Returns [OK] on success else [ERR_BUSY].
+ Try locking this [code]Mutex[/code], does not block. Returns [OK] on success, [ERR_BUSY] otherwise.
- Unlock this [code]Mutex[/code], leaving it to others threads.
+ Unlock this [code]Mutex[/code], leaving it to other threads.
--
cgit v1.2.3-70-g09d2