From 4c905dad33c9fb89e319ec648f16d1291634edc7 Mon Sep 17 00:00:00 2001 From: Daniel Imms <2193314+Tyriar@users.noreply.github.com> Date: Fri, 9 Jan 2026 13:02:18 -0800 Subject: [PATCH] Update API jsdoc --- typings/xterm-headless.d.ts | 8 +++++--- typings/xterm.d.ts | 2 +- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/typings/xterm-headless.d.ts b/typings/xterm-headless.d.ts index 7d2277d7..4f828184 100644 --- a/typings/xterm-headless.d.ts +++ b/typings/xterm-headless.d.ts @@ -323,9 +323,11 @@ declare module '@xterm/headless' { */ export interface IVtExtensions { /** - * Whether the kitty keyboard protocol is enabled. When enabled, the - * terminal will respond to keyboard protocol queries and allow programs to - * enable enhanced keyboard reporting. The default is false. + * Whether the [kitty keyboard protocol][0] (`CSI =|?|>|< u`) is enabled. When + * enabled, the terminal will respond to keyboard protocol queries and allow + * programs to enable enhanced keyboard reporting. The default is false. + * + * [0]: https://sw.kovidgoyal.net/kitty/keyboard-protocol/ */ kittyKeyboard?: boolean; } diff --git a/typings/xterm.d.ts b/typings/xterm.d.ts index e79e4713..6ca2fae4 100644 --- a/typings/xterm.d.ts +++ b/typings/xterm.d.ts @@ -440,7 +440,7 @@ declare module '@xterm/xterm' { */ export interface IVtExtensions { /** - * Whether the [kitty keyboard protocol][0] (`CSI u`) is enabled. When + * Whether the [kitty keyboard protocol][0] (`CSI =|?|>|< u`) is enabled. When * enabled, the terminal will respond to keyboard protocol queries and allow * programs to enable enhanced keyboard reporting. The default is false. *