Minor fix to cursor key mapping when NumLock is on and added tiny API documentation improvements

src/contour/helper.h

@@ -103,7 +103,7 @@ constexpr inline vtbackend::Modifiers makeModifiers(Qt::KeyboardModifiers qtModi
 
     Modifiers modifiers {};
 
-    if (qtModifiers & Qt::KeypadModifier)
+    if (qtModifiers & Qt::GroupSwitchModifier)
         modifiers |= Modifier::NumLock;
 
     if (qtModifiers & Qt::AltModifier)

src/vtbackend/InputGenerator.cpp

@@ -154,13 +154,14 @@ std::string StandardKeyboardInputGenerator::selectNumpad(Modifiers modifiers,
     if (modifiers.contains(Modifier::NumLock))
         return select(modifiers, { .std = mapping.std, .mods = mapping.std, .appKeypad = mapping.std });
 
-    return select(modifiers, mapping);
+    return select(modifiers.without(Modifier::NumLock), mapping);
 }
 
 std::string StandardKeyboardInputGenerator::select(Modifiers modifiers, FunctionKeyMapping mapping) const
 {
-    if (modifiers && !mapping.mods.empty())
-        return crispy::replace(mapping.mods, "{}"sv, makeVirtualTerminalParam(modifiers));
+    if (modifiers.without(Modifier::NumLock) && !mapping.mods.empty())
+        return crispy::replace(
+            mapping.mods, "{}"sv, makeVirtualTerminalParam(modifiers.without(Modifier::NumLock)));
 
     auto const prefix = modifiers.contains(Modifier::Alt) ? "\033" : ""s;
 

src/vtbackend/InputGenerator.h

@@ -279,11 +279,16 @@ class StandardKeyboardInputGenerator: public KeyboardInputGenerator
     }
 
   protected:
+    /// Maps a function key to its corresponding VT sequences based on different modes and modifiers.
     struct FunctionKeyMapping
     {
+        /// Standard VT sequence.
         std::string_view std {};
+        /// VT sequence when modifiers are pressed.
         std::string_view mods {};
+        /// VT sequence when Application Cursor Keys mode is enabled.
         std::string_view appCursor {};
+        /// VT sequence when Application Keypad mode is enabled.
         std::string_view appKeypad {};
     };