From 4dcc8fd97fcba43c33ed1d5616204dcdb4945199 Mon Sep 17 00:00:00 2001
From: Robbert van der Helm <mail@robbertvanderhelm.nl>
Date: Fri, 29 May 2020 11:19:38 +0200
Subject: [PATCH] Better clarify the use cases for Win32Thread

---
 src/wine-host/utils.h | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/wine-host/utils.h b/src/wine-host/utils.h
index e505cd1b..5da96c85 100644
--- a/src/wine-host/utils.h
+++ b/src/wine-host/utils.h
@@ -44,6 +44,11 @@
  *   expects a function pointer of type `LPTHREAD_START_ROUTINE`. GCC supports
  *   converting stateless lambdas to this format, but clang (as used for IDE
  *   tooling) does not.
+ *
+ * @note This should be used instead of `std::thread` whenever the thread
+ *   directly calls third party library code, i.e. `LoadLibrary()`,
+ *   `FreeLibrary()`, the plugin's entry point, or any of the `AEffect::*()`
+ *   functions.
  */
 class Win32Thread {
    public: