docs: document configvalue's special STRING storage

hyprwm · Feb 15, 2024 · 4b467f0 · 4b467f0
1 parent 61507d1
commit 4b467f0
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/include/hyprlang.hpp b/include/hyprlang.hpp
@@ -207,6 +207,12 @@ namespace Hyprlang {
 
             Please note only the first (outer) pointer is static. The second
             may (and most likely will) be changing.
+
+            For all types except STRING typeof(**retval) is the config value type
+            (e.g. INT or FLOAT)
+
+            Please note STRING is a special type and instead of
+            typeof(**retval) being const char*, typeof(*retval) is a const char*.
         */
         void* const* getDataStaticPtr() const;