From d1cf66ce1465302f171da51588d9cb576641ca99 Mon Sep 17 00:00:00 2001
From: Undeadamien <damien.trala@outlook.com>
Date: Sun, 12 Apr 2026 22:23:44 +0200
Subject: [PATCH] improve `getAnyConfigValue` documentation

---
 include/hyprlang.hpp | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/include/hyprlang.hpp b/include/hyprlang.hpp
index f851485..031bfb7 100644
--- a/include/hyprlang.hpp
+++ b/include/hyprlang.hpp
@@ -411,6 +411,12 @@ namespace Hyprlang {
 
         /*!
             Get a basic or special config value's stored value. Empty on fail.
+
+            Syntax:
+            - `name` -> `general:gaps_out`
+            - `category[key]:name` -> `windowrule[name]:enable`
+
+            \note Prefer `getConfigValuePtr` or `getSpecialConfigValuePtr` to avoid unnecessary lookup and parsing.
         */
         std::any getAnyConfigValue(const char* name);