Add comment how to use EnumFlag

0blu · Sep 7, 2024 · 60ddc5c · 60ddc5c
1 parent eb2d287
commit 60ddc5c
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/src/shared/EnumFlag.h b/src/shared/EnumFlag.h
@@ -20,6 +20,25 @@
 
 #include <type_traits>
 
+/* Example usage:
+// In header
+enum class MyCoolFlags
+{
+    None   = 0,
+    FlagA  = (1 << 0),
+    FlagB  = (1 << 0),
+    FlagC  = (1 << 0),
+    FlagD  = (1 << 0),
+    FlagE  = (1 << 0),
+};
+DEFINE_ENUM_FLAG(MyCoolFlags);
+// In CPP file
+void MyCoolFunction(EnumFlag<MyCoolFlags> flags)
+{
+    if (flags.HasFlag(MyCoolFlags::FlagA))
+        // Do something
+}
+ */
 template<typename T>
 constexpr bool IsEnumFlag(T) { return false; }