From 4424d1a7d295397eeed5345ad3f9cc11cdc05448 Mon Sep 17 00:00:00 2001 From: Peter Heywood Date: Thu, 4 Jan 2024 14:46:02 +0000 Subject: [PATCH] Document the flamegpu namespace in flamegpu.h --- include/flamegpu/flamegpu.h | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/include/flamegpu/flamegpu.h b/include/flamegpu/flamegpu.h index 539324a43..6850b0f4c 100644 --- a/include/flamegpu/flamegpu.h +++ b/include/flamegpu/flamegpu.h @@ -12,6 +12,13 @@ #include #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"