From b0e3a884f542cf000483f9ec30ae8bcd7e1b6547 Mon Sep 17 00:00:00 2001 From: Vaxry Date: Thu, 15 Feb 2024 02:58:26 +0000 Subject: [PATCH] docs: document configvalue's special STRING storage --- include/hyprlang.hpp | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/include/hyprlang.hpp b/include/hyprlang.hpp index 3447594..d3a6498 100644 --- 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;