aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/plugins/PluginAPI.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/plugins/PluginAPI.hpp')
-rw-r--r--src/plugins/PluginAPI.hpp2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/plugins/PluginAPI.hpp b/src/plugins/PluginAPI.hpp
index c58d982e..a7a998b4 100644
--- a/src/plugins/PluginAPI.hpp
+++ b/src/plugins/PluginAPI.hpp
@@ -125,6 +125,8 @@ namespace HyprlandAPI {
/*
Get a config value.
+ Please see the <hyprlang.hpp> header or https://hyprland.org/hyprlang/ for docs regarding Hyprlang types.
+
returns: a pointer to the config value struct, which is guaranteed to be valid for the life of this plugin, unless another `addConfigValue` is called afterwards.
nullptr on error.
*/