components:libc:cplusplus:os/utest:Some comments have been initially added.

Some comments have been initially added as a bignner task.
components/libc/cplusplus/os/cxx_Semaphore.cpp
components/libc/cplusplus/os/cxx_Thread.cpp
components/libc/cplusplus/utest/tc_atomic.cpp
components/libc/cplusplus/utest/tc_smartptr.cpp
components/libc/cplusplus/utest/tc_thread.cpp

Signed-off-by:Liu Chengtao<2739960959@qq.com>

Author: github-actions[bot]

components/libc/cplusplus/os/cxx_Semaphore.cpp

@@ -12,7 +12,7 @@
 using namespace rtthread;
 
 /** 
- * @brief Semaphore class implementation.
+ * @brief Semaphore class constructor.
  * @param name Semaphore name
  * @param count Initial semaphore count
  */

components/libc/cplusplus/os/cxx_Thread.cpp

@@ -101,7 +101,7 @@ void Thread::sleep(int32_t millisec)
 }
 
 /** 
- * @brief function to run the thread's entry function.
+ * @brief Function to run the thread's entry function.
  */
 void Thread::func(Thread *pThis)
 {
@@ -136,9 +136,9 @@ rt_err_t Thread::wait(int32_t millisec)
 }
 
 /** 
- * @brief the thread with a timeout.
+ * @brief Join the thread with a timeout.
  * @param millisec Timeout in milliseconds.
- * @return Status code indicating the execution status.
+ * @return RT_EOK if the thread completed within the timeout, error code otherwise.
  */
 rt_err_t Thread::join(int32_t millisec)
 {
@@ -156,4 +156,4 @@ rt_err_t Thread::join(int32_t millisec)
     {
         return -RT_ENOSYS;
     }
-}
+}

components/libc/cplusplus/utest/tc_atomic.cpp

@@ -112,7 +112,7 @@ static void test_atomic_basic_int32(void)
     val.fetch_and(14);
     uassert_int_equal(val.load(), 10);
 
-    val.fetch_or(11); //1010
+    val.fetch_or(11); /* 1010 */
     uassert_int_equal(val.load(), 11);
 
     val.fetch_xor(4);
@@ -159,7 +159,7 @@ static void test_atomic_basic_int64(void)
     val.fetch_and(14);
     uassert_int_equal(val.load(), 10);
 
-    val.fetch_or(11); //1010
+    val.fetch_or(11); /* 1010 */
     uassert_int_equal(val.load(), 11);
 
     val.fetch_xor(4);
@@ -217,7 +217,7 @@ static void test_memory_order(void)
 {
     std::atomic<int> x(0);
     std::atomic<int> y(0);
-    // Simple test for memory order
+    /* Simple test for memory order */
     x.store(1, std::memory_order_release);
     y.store(2, std::memory_order_release);
     uassert_int_equal(x.load(std::memory_order_acquire), 1);
@@ -234,22 +234,32 @@ static void test_compare_exchange_weak(void)
     int desired = 2;
     while (!val.compare_exchange_weak(expected, desired))
     {
-        expected = 1; // reset
+        /* Reset */
+        expected = 1; 
     }
     uassert_int_equal(val.load(), 2);
 }
-// Test case initialization function.
+/**
+ * @brief Test case initialization function.
+ * @return RT_EOK on success.
+ */
 static rt_err_t utest_tc_init(void)
 {
     return RT_EOK;
 }
 
-// Test case cleanup function.
+/**
+ * @brief Test case cleanup function.
+ * @return RT_EOK on success.
+ */
 static rt_err_t utest_tc_cleanup(void)
 {
     return RT_EOK;
 }
 
+/**
+ * @brief Main test case function that runs the test.
+ */
 static void testcase(void)
 {
     /* Test load and store operations for int32_t atomic variables in multi-threaded environment */
@@ -269,4 +279,6 @@ static void testcase(void)
     /* Test compare_exchange_weak operation */
     UTEST_UNIT_RUN(test_compare_exchange_weak);
 }
+
+/* Export the test case with initialization and cleanup functions and a timeout of 10 ticks. */
 UTEST_TC_EXPORT(testcase, "components.libc.cpp.atomic_tc", utest_tc_init, utest_tc_cleanup, 10);

components/libc/cplusplus/utest/tc_smartptr.cpp

@@ -37,6 +37,7 @@ static void test_shared_ptr(void)
 
 /**
  * @brief Test case initialization function.
+ * @return RT_EOK on success.
  */
 static rt_err_t utest_tc_init(void)
 {
@@ -45,17 +46,23 @@ static rt_err_t utest_tc_init(void)
 
 /**
  * @brief Test case cleanup function.
+ * @return RT_EOK on success.
  */
 static rt_err_t utest_tc_cleanup(void)
 {
     return RT_EOK;
 }
 
+/**
+ * @brief Main test case function that runs the test.
+ */
 static void testcase(void)
 {
     /* Test unique_ptr basic operations */
     UTEST_UNIT_RUN(test_unique_ptr);
     /* Test shared_ptr basic operations */
     UTEST_UNIT_RUN(test_shared_ptr);
 }
+
+/* Export the test case with initialization and cleanup functions and a timeout of 10 ticks. */
 UTEST_TC_EXPORT(testcase, "components.libc.cpp.smartptr_tc", utest_tc_init, utest_tc_cleanup, 10);

components/libc/cplusplus/utest/tc_thread.cpp

@@ -18,51 +18,52 @@
  */
 static void test_thread(void)
 {
-    int count = 0; 
+    int count = 0;
 
-    /* Lambda function to increment the count.*/
+    /* Lambda function to increment the count. */
     auto func = [&]() mutable {
         for (int i = 0; i < 100; ++i)
         {
-            ++count; 
+            ++count;
         }
     };
 
     /* Create and run a thread executing the lambda function. */
     std::thread t1(func);
-    /* Wait for the thread to finish execution.*/
-    t1.join();  
+    /* Wait for the thread to finish execution. */
+    t1.join();
 
-    /* Verify if the count is as expected after the first thread execution.*/
+    /* Verify if the count is as expected after the first thread execution. */
     if (count != 100)
     {
-        uassert_false(1);  
+        uassert_false(1);
     }
 
     /* Create and run another thread executing the same lambda function. */
     std::thread t2(func);
-    t2.join();  
+    t2.join();
 
     if (count != 200)
     {
-        uassert_false(1);  
+        uassert_false(1);
     }
 
-    /* If both assertions passed, the test is successful.*/
+    /* If both assertions passed, the test is successful. */
     uassert_true(1);
 }
 
 
 /**
  * @brief Test case initialization function.
+ * @return RT_EOK on success.
  */
-
 static rt_err_t utest_tc_init(void)
 {
     return RT_EOK;
 }
 /**
  * @brief Test case cleanup function.
+ * @return RT_EOK on success.
  */
 static rt_err_t utest_tc_cleanup(void)
 {