Document the flamegpu namespace in flamegpu.h

FLAMEGPU · Jan 4, 2024 · b4ab583 · b4ab583
1 parent 0e5650e
commit b4ab583
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/include/flamegpu/flamegpu.h b/include/flamegpu/flamegpu.h
@@ -12,6 +12,13 @@
 #include <glm/glm.hpp>
 #endif
 
+/**
+ * @namespace flamegpu
+ * The flamegpu namespace containing all namespace'd elements of the flamegpu api.
+ *
+ * The inner detail namespace and it's members are implementation details not considered part of the public facing API and may change at any time.
+ */
+
 // include all host API classes (top level header from each module)
 #include "flamegpu/version.h"
 #include "flamegpu/runtime/HostAPI.h"