From c83a91ab14ce40e2eb8241d26101a1c70cfb8bc1 Mon Sep 17 00:00:00 2001
From: "adrian.spycher" <adrian.spycher@etu.hesge.ch>
Date: Tue, 3 Dec 2024 13:21:12 +0100
Subject: [PATCH] docs: comment header function

---
 vmm/operation.h | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/vmm/operation.h b/vmm/operation.h
index 59c96be..4aba22f 100644
--- a/vmm/operation.h
+++ b/vmm/operation.h
@@ -268,6 +268,15 @@ void op_callback_sprite_position_store_y(void *addr);
  */
 void op_callback_sprite_position_conclude(void *addr);
 
+/**
+ * @brief Sends a keyboard input code using paravirtualized (pv) mechanisms.
+ *
+ * Prepares the keyboard input data structure with the specified key code and copies 
+ * it to the provided shared buffer. This is used for paravirtualized keyboard input handling.
+ *
+ * @param shared_buf Pointer to the shared buffer where the keyboard input data will be copied.
+ * @param key The key code representing the keyboard input.
+ */
 void op_keyboard_pv_send_code(void *shared_buf, uint32_t key);
 
 #endif // _OPERATION_H_
-- 
GitLab