From 6c0546d82955d8bcd475d678b3439e618e7e6fd6 Mon Sep 17 00:00:00 2001
From: Max Kellermann <max.kellermann@gmail.com>
Date: Thu, 18 Aug 2022 14:27:54 +0200
Subject: [PATCH] mixer/Internal: document that caller must lock the mutex

---
 src/mixer/MixerInternal.hxx | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/mixer/MixerInternal.hxx b/src/mixer/MixerInternal.hxx
index 585e3cf86..47d0c3507 100644
--- a/src/mixer/MixerInternal.hxx
+++ b/src/mixer/MixerInternal.hxx
@@ -72,18 +72,24 @@ public:
 	/**
 	 * Open mixer device
 	 *
+	 * Caller must lock the mutex.
+	 *
 	 * Throws std::runtime_error on error.
 	 */
 	virtual void Open() = 0;
 
 	/**
 	 * Close mixer device
+	 *
+	 * Caller must lock the mutex.
 	 */
 	virtual void Close() noexcept = 0;
 
 	/**
 	 * Reads the current volume.
 	 *
+	 * Caller must lock the mutex.
+	 *
 	 * Throws std::runtime_error on error.
 	 *
 	 * @return the current volume (0..100 including) or -1 if
@@ -94,6 +100,8 @@ public:
 	/**
 	 * Sets the volume.
 	 *
+	 * Caller must lock the mutex.
+	 *
 	 * Throws std::runtime_error on error.
 	 *
 	 * @param volume the new volume (0..100 including)