Documentation|libdeng2: Note about Shared's thread safety

skyjake · Apr 8, 2014 · 6ace3b0 · 6ace3b0
1 parent a510114
commit 6ace3b0
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/doomsday/libdeng2/include/de/data/shared.h b/doomsday/libdeng2/include/de/data/shared.h
@@ -31,6 +31,11 @@ namespace de {
  * You must use the DENG2_SHARED_INSTANCE() macro to define where the static
  * instance pointer is located.
  *
+ * @par Thread-safety
+ *
+ * Shared is not thread safe. The shared object can only be accessed from a
+ * single thread.
+ *
  * @ingroup data
  */
 template <typename Type>