diff mbox series

[Concept,06/23] expo: Tidy up a few key-related comments

Message ID 20250915122905.1217249-7-sjg@u-boot.org
State New
Headers
Series expo: Support interactions with a mouse or touchpad |

Commit Message

Simon Glass Sept. 15, 2025, 12:28 p.m. UTC 
  From: Simon Glass <sjg@chromium.org>

Fix up send_key_obj() to mention a missing argument. Add a bit more
detail in scene_send_key() to explain what 'processing' means.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

 boot/scene.c          | 1 +
 boot/scene_internal.h | 3 +++
 2 files changed, 4 insertions(+)
diff mbox series

Patch

diff --git a/boot/scene.c b/boot/scene.c
index 0a62dc6212b..50a7dfb22a1 100644
--- a/boot/scene.c
+++ b/boot/scene.c
@@ -909,6 +909,7 @@  int scene_render(struct scene *scn)
  * send_key_obj() - Handle a keypress for moving between objects
  *
  * @scn: Scene to receive the key
+ * @obj: Object to receive the key
  * @key: Key to send (KEYCODE_UP)
  * @event: Returns resulting event from this keypress
  * Returns: 0 if OK, -ve on error
diff --git a/boot/scene_internal.h b/boot/scene_internal.h
index eada390275c..c6f2615a2c5 100644
--- a/boot/scene_internal.h
+++ b/boot/scene_internal.h
@@ -231,6 +231,9 @@  int scene_render(struct scene *scn);
 /**
  * scene_send_key() - set a keypress to a scene
  *
+ * This processes the key, taking any action that is needed, such as moving
+ * between menu items or editing the text in a textline
+ *
  * @scn: Scene to receive the key
  * @key: Key to send (KEYCODE_UP)
  * @event: Returns resulting event from this keypress