From 5d09ae322176247536667994806ca8aa6bb3b1e5 Mon Sep 17 00:00:00 2001
From: "Robin.Mueller" <robin.mueller.m@gmail.com>
Date: Sat, 8 Aug 2020 23:47:44 +0200
Subject: [PATCH] additional comment

---
 container/SharedRingBuffer.h | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/container/SharedRingBuffer.h b/container/SharedRingBuffer.h
index 102cc6be8..0b5be0521 100644
--- a/container/SharedRingBuffer.h
+++ b/container/SharedRingBuffer.h
@@ -53,6 +53,11 @@ public:
 	 */
 	virtual ReturnValue_t unlockRingBufferMutex();
 
+	/**
+	 * The mutex handle can be accessed directly, for example to perform
+	 * the lock with the #MutexHelper for a RAII compliant lock operation.
+	 * @return
+	 */
 	MutexIF* getMutexHandle() const;
 private:
 	MutexIF* mutex = nullptr;