[Concept,04/22] sandbox: Add a comment for sandbox_sdl_get_mouse_event()

Message ID 20251003165525.440173-5-sjg@u-boot.org
State New
Headers
Series video: Enhancements to support a pointer |

Commit Message

Simon Glass Oct. 3, 2025, 4:54 p.m. UTC
  From: Simon Glass <sjg@chromium.org>

This function was added without a comment. Fix it.

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

 arch/sandbox/include/asm/sdl.h | 9 +++++++++
 1 file changed, 9 insertions(+)
  

Patch

diff --git a/arch/sandbox/include/asm/sdl.h b/arch/sandbox/include/asm/sdl.h
index 86368c8a0a6..735652de6bd 100644
--- a/arch/sandbox/include/asm/sdl.h
+++ b/arch/sandbox/include/asm/sdl.h
@@ -106,6 +106,15 @@  int sandbox_sdl_sound_init(int rate, int channels);
  */
 int sandbox_sdl_set_bpp(struct udevice *dev, enum video_log2_bpp l2bpp);
 
+/**
+ * sandbox_sdl_get_mouse_event() - Read a mouse event from SDL
+ *
+ * If a mouse event has been recorded since the last call, this marked the event
+ * as used and then returns its.
+ *
+ * @evt: Mouse event
+ * ReturnL 0 if OK, -EAGAIN if there is no event available
+ */
 int sandbox_sdl_get_mouse_event(struct mouse_event *evt);
 
 #else