[components/lwp]add doxygen comment for lwp futex. (#10763)

components/lwp/lwp_futex_internal.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2006-2023, RT-Thread Development Team
+ * Copyright (c) 2006-2025 RT-Thread Development Team
  *
  * SPDX-License-Identifier: Apache-2.0
  *
@@ -25,25 +25,38 @@
 #include <lwp_user_mm.h>
 #endif /* ARCH_MM_MMU */
 
+/**
+ * @brief Shared futex key structure
+ *
+ * @note This structure represents a key used to identify shared futexes
+ *       in the system.
+ */
 struct shared_futex_key
 {
-    rt_mem_obj_t mobj;
+    rt_mem_obj_t mobj; /**< Memory object associated with the futex */
-    rt_base_t offset;
+    rt_base_t offset;  /**< Offset within the memory object */
 };
 DEFINE_RT_UTHASH_TYPE(shared_futex_entry, struct shared_futex_key, key);
 
+/**
+ * @brief Futex structure for thread synchronization
+ *
+ * @note This structure represents a futex used for thread synchronization.
+ *       It can be either private (process-local) or shared between processes.
+ */
 struct rt_futex
 {
-    union {
+    union
+    {
         /* for private futex */
-        struct lwp_avl_struct node;
+        struct lwp_avl_struct node;       /**< AVL tree node for private futex */
         /* for shared futex */
-        struct shared_futex_entry entry;
+        struct shared_futex_entry entry;  /**< Entry for shared futex */
     };
 
-    rt_list_t waiting_thread;
+    rt_list_t waiting_thread;             /**< List of threads waiting on the futex */
-    struct rt_object *custom_obj;
+    struct rt_object *custom_obj;         /**< Custom object associated with the futex */
-    rt_mutex_t mutex;
+    rt_mutex_t mutex;                     /**< kernel mutex object for futex */
 };
 typedef struct rt_futex *rt_futex_t;
 

components/lwp/lwp_futex_table.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2006-2023, RT-Thread Development Team
+ * Copyright (c) 2006-2025 RT-Thread Development Team
  *
  * SPDX-License-Identifier: Apache-2.0
  *
@@ -12,6 +12,14 @@
 
 static struct shared_futex_entry *_futex_hash_head;
 
+/**
+ * @brief Add a futex to the global hash table
+ *
+ * @param[in] key Pointer to the shared futex key structure
+ * @param[in] futex The futex to be added to the table
+ *
+ * @return rt_err_t Returns RT_EOK on success, error code on failure
+ */
 rt_err_t futex_global_table_add(struct shared_futex_key *key, rt_futex_t futex)
 {
     rt_err_t rc = 0;
@@ -23,6 +31,14 @@ rt_err_t futex_global_table_add(struct shared_futex_key *key, rt_futex_t futex)
     return rc;
 }
 
+/**
+ * @brief Find a futex in the global hash table
+ *
+ * @param[in] key Pointer to the shared futex key structure
+ * @param[out] futex Pointer to store the found futex
+ *
+ * @return rt_err_t Returns RT_EOK if found, -RT_ENOENT if not found
+ */
 rt_err_t futex_global_table_find(struct shared_futex_key *key, rt_futex_t *futex)
 {
     rt_err_t rc;
@@ -45,6 +61,13 @@ rt_err_t futex_global_table_find(struct shared_futex_key *key, rt_futex_t *futex
     return rc;
 }
 
+/**
+ * @brief Delete a futex from the global hash table
+ *
+ * @param[in] key Pointer to the shared futex key structure
+ *
+ * @return rt_err_t Returns RT_EOK if deleted successfully, -RT_ENOENT if not found
+ */
 rt_err_t futex_global_table_delete(struct shared_futex_key *key)
 {
     rt_err_t rc;