From 7212e6bc1cddc4afbab99837b829b7e5aaac68bf Mon Sep 17 00:00:00 2001
From: Nephr1te <3403323661@qq.com>
Date: Tue, 25 Apr 2023 12:36:39 +0800
Subject: [PATCH] [HUST_CSE] add doxygen missing `@brief` (#7368)

---
 src/clock.c    |  3 +--
 src/cpu.c      |  6 ++---
 src/kservice.c | 64 +++++++++++++++++++++++++-------------------------
 3 files changed, 36 insertions(+), 37 deletions(-)

diff --git a/src/clock.c b/src/clock.c
index e736bc9f91..b664e0d986 100644
--- a/src/clock.c
+++ b/src/clock.c
@@ -40,7 +40,7 @@ static void (*rt_tick_hook)(void);
 /**@{*/
 
 /**
- * This function will set a hook function, which will be invoked when tick increase
+ * @brief This function will set a hook function, which will be invoked when tick increase
  *
  *
  * @param hook the hook function
@@ -176,4 +176,3 @@ rt_weak rt_tick_t rt_tick_get_millisecond(void)
 }
 
 /**@}*/
-
diff --git a/src/cpu.c b/src/cpu.c
index 8108d28da4..77ce65d69f 100644
--- a/src/cpu.c
+++ b/src/cpu.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2006-2021, RT-Thread Development Team
+ * Copyright (c) 2006-2023, RT-Thread Development Team
  *
  * SPDX-License-Identifier: Apache-2.0
  *
@@ -19,7 +19,7 @@ static struct rt_cpu _cpus[RT_CPUS_NR];
 rt_hw_spinlock_t _cpus_lock;
 
 /*
- * disable scheduler
+ * @brief   disable scheduler
  */
 static void _cpu_preempt_disable(void)
 {
@@ -44,7 +44,7 @@ static void _cpu_preempt_disable(void)
 }
 
 /*
- * enable scheduler
+ * @brief   enable scheduler
  */
 static void _cpu_preempt_enable(void)
 {
diff --git a/src/kservice.c b/src/kservice.c
index 1f06055ff1..ecae2f72ec 100644
--- a/src/kservice.c
+++ b/src/kservice.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2006-2022, RT-Thread Development Team
+ * Copyright (c) 2006-2023, RT-Thread Development Team
  *
  * SPDX-License-Identifier: Apache-2.0
  *
@@ -84,7 +84,7 @@ static const char* rt_errno_strs[] =
 };
 
 /**
- * This function return a pointer to a string that contains the
+ * @brief This function return a pointer to a string that contains the
  * message of error.
  *
  * @param error the errorno code
@@ -102,7 +102,7 @@ const char *rt_strerror(rt_err_t error)
 RTM_EXPORT(rt_strerror);
 
 /**
- * This function gets the global errno for the current thread.
+ * @brief This function gets the global errno for the current thread.
  *
  * @return errno
  */
@@ -127,7 +127,7 @@ rt_err_t rt_get_errno(void)
 RTM_EXPORT(rt_get_errno);
 
 /**
- * This function sets the global errno for the current thread.
+ * @brief This function sets the global errno for the current thread.
  *
  * @param error is the errno shall be set.
  */
@@ -156,7 +156,7 @@ void rt_set_errno(rt_err_t error)
 RTM_EXPORT(rt_set_errno);
 
 /**
- * This function returns the address of the current thread errno.
+ * @brief This function returns the address of the current thread errno.
  *
  * @return The errno address.
  */
@@ -181,7 +181,7 @@ RTM_EXPORT(_rt_errno);
 
 #ifndef RT_KSERVICE_USING_STDLIB_MEMORY
 /**
- * This function will set the content of memory to specified value.
+ * @brief  This function will set the content of memory to specified value.
  *
  * @param  s is the address of source memory, point to the memory block to be filled.
  *
@@ -262,7 +262,7 @@ rt_weak void *rt_memset(void *s, int c, rt_ubase_t count)
 RTM_EXPORT(rt_memset);
 
 /**
- * This function will copy memory content from source address to destination address.
+ * @brief  This function will copy memory content from source address to destination address.
  *
  * @param  dst is the address of destination memory, points to the copied content.
  *
@@ -346,7 +346,7 @@ rt_weak void *rt_memcpy(void *dst, const void *src, rt_ubase_t count)
 RTM_EXPORT(rt_memcpy);
 
 /**
- * This function will move memory content from source address to destination
+ * @brief  This function will move memory content from source address to destination
  * address. If the destination memory does not overlap with the source memory,
  * the function is the same as memcpy().
  *
@@ -381,7 +381,7 @@ void *rt_memmove(void *dest, const void *src, rt_size_t n)
 RTM_EXPORT(rt_memmove);
 
 /**
- * This function will compare two areas of memory.
+ * @brief  This function will compare two areas of memory.
  *
  * @param  cs is a block of memory.
  *
@@ -410,7 +410,7 @@ RTM_EXPORT(rt_memcmp);
 
 #ifndef RT_KSERVICE_USING_STDLIB
 /**
- * This function will return the first occurrence of a string, without the
+ * @brief  This function will return the first occurrence of a string, without the
  * terminator '\0'.
  *
  * @param  s1 is the source string.
@@ -446,7 +446,7 @@ char *rt_strstr(const char *s1, const char *s2)
 RTM_EXPORT(rt_strstr);
 
 /**
- * This function will compare two strings while ignoring differences in case
+ * @brief  This function will compare two strings while ignoring differences in case
  *
  * @param  a is the string to be compared.
  *
@@ -477,7 +477,7 @@ rt_int32_t rt_strcasecmp(const char *a, const char *b)
 RTM_EXPORT(rt_strcasecmp);
 
 /**
- * This function will copy string no more than n bytes.
+ * @brief  This function will copy string no more than n bytes.
  *
  * @param  dst points to the address used to store the copied content.
  *
@@ -514,7 +514,7 @@ char *rt_strncpy(char *dst, const char *src, rt_size_t n)
 RTM_EXPORT(rt_strncpy);
 
 /**
- * This function will copy string.
+ * @brief  This function will copy string.
  *
  * @param  dst points to the address used to store the copied content.
  *
@@ -539,7 +539,7 @@ char *rt_strcpy(char *dst, const char *src)
 RTM_EXPORT(rt_strcpy);
 
 /**
- * This function will compare two strings with specified maximum length.
+ * @brief  This function will compare two strings with specified maximum length.
  *
  * @param  cs is the string to be compared.
  *
@@ -571,7 +571,7 @@ rt_int32_t rt_strncmp(const char *cs, const char *ct, rt_size_t count)
 RTM_EXPORT(rt_strncmp);
 
 /**
- * This function will compare two strings without specified length.
+ * @brief  This function will compare two strings without specified length.
  *
  * @param  cs is the string to be compared.
  *
@@ -595,7 +595,7 @@ rt_int32_t rt_strcmp(const char *cs, const char *ct)
 RTM_EXPORT(rt_strcmp);
 
 /**
- * This function will return the length of a string, which terminate will
+ * @brief  This function will return the length of a string, which terminate will
  * null character.
  *
  * @param  s is the string
@@ -616,7 +616,7 @@ RTM_EXPORT(rt_strlen);
 #endif /* RT_KSERVICE_USING_STDLIB */
 
 /**
- * The  strnlen()  function  returns the number of characters in the
+ * @brief  The  strnlen()  function  returns the number of characters in the
  * string pointed to by s, excluding the terminating null byte ('\0'),
  * but at most maxlen.  In doing this, strnlen() looks only at the
  * first maxlen characters in the string pointed to by s and never
@@ -641,7 +641,7 @@ RTM_EXPORT(rt_strnlen);
 
 #ifdef RT_USING_HEAP
 /**
- * This function will duplicate a string.
+ * @brief  This function will duplicate a string.
  *
  * @param  s is the string to be duplicated.
  *
@@ -665,7 +665,7 @@ RTM_EXPORT(rt_strdup);
 #endif /* RT_USING_HEAP */
 
 /**
- * This function will show the version of rt-thread rtos
+ * @brief This function will show the version of rt-thread rtos
  */
 void rt_show_version(void)
 {
@@ -685,7 +685,7 @@ RTM_EXPORT(rt_show_version);
 #define _ISDIGIT(c)  ((unsigned)((c) - '0') < 10)
 
 /**
- * This function will duplicate a string.
+ * @brief  This function will duplicate a string.
  *
  * @param  n is the string to be duplicated.
  *
@@ -961,7 +961,7 @@ static char *print_number(char *buf,
 }
 
 /**
- * This function will fill a formatted string to buffer.
+ * @brief  This function will fill a formatted string to buffer.
  *
  * @param  buf is the buffer to save formatted string.
  *
@@ -1281,7 +1281,7 @@ rt_weak int rt_vsnprintf(char *buf, rt_size_t size, const char *fmt, va_list arg
 RTM_EXPORT(rt_vsnprintf);
 
 /**
- * This function will fill a formatted string to buffer.
+ * @brief  This function will fill a formatted string to buffer.
  *
  * @param  buf is the buffer to save formatted string.
  *
@@ -1305,7 +1305,7 @@ int rt_snprintf(char *buf, rt_size_t size, const char *fmt, ...)
 RTM_EXPORT(rt_snprintf);
 
 /**
- * This function will fill a formatted string to buffer.
+ * @brief  This function will fill a formatted string to buffer.
  *
  * @param  buf is the buffer to save formatted string.
  *
@@ -1322,7 +1322,7 @@ int rt_vsprintf(char *buf, const char *format, va_list arg_ptr)
 RTM_EXPORT(rt_vsprintf);
 
 /**
- * This function will fill a formatted string to buffer
+ * @brief  This function will fill a formatted string to buffer
  *
  * @param  buf the buffer to save formatted string.
  *
@@ -1347,7 +1347,7 @@ RTM_EXPORT(rt_sprintf);
 
 #ifdef RT_USING_DEVICE
 /**
- * This function returns the device using in console.
+ * @brief  This function returns the device using in console.
  *
  * @return Returns the console device pointer or RT_NULL.
  */
@@ -1358,7 +1358,7 @@ rt_device_t rt_console_get_device(void)
 RTM_EXPORT(rt_console_get_device);
 
 /**
- * This function will set a device as console device.
+ * @brief  This function will set a device as console device.
  * After set a device to console, all output of rt_kprintf will be
  * redirected to this new device.
  *
@@ -1427,7 +1427,7 @@ rt_weak void rt_hw_console_output(const char *str)
 RTM_EXPORT(rt_hw_console_output);
 
 /**
- * This function will put string to the console.
+ * @brief This function will put string to the console.
  *
  * @param str is the string output to the console.
  */
@@ -1453,7 +1453,7 @@ void rt_kputs(const char *str)
 }
 
 /**
- * This function will print a formatted string on system console.
+ * @brief This function will print a formatted string on system console.
  *
  * @param fmt is the format parameters.
  *
@@ -1816,7 +1816,7 @@ void rt_page_free(void *addr, rt_size_t npages)
 #endif
 
 /**
- * This function allocates a memory block, which address is aligned to the
+ * @brief  This function allocates a memory block, which address is aligned to the
  * specified alignment size.
  *
  * @param  size is the allocated memory block size.
@@ -1867,7 +1867,7 @@ rt_weak void *rt_malloc_align(rt_size_t size, rt_size_t align)
 RTM_EXPORT(rt_malloc_align);
 
 /**
- * This function release the memory block, which is allocated by
+ * @brief This function release the memory block, which is allocated by
  * rt_malloc_align function and address is aligned.
  *
  * @param ptr is the memory block pointer.
@@ -1896,7 +1896,7 @@ const rt_uint8_t __lowest_bit_bitmap[] =
 };
 
 /**
- * This function finds the first bit set (beginning with the least significant bit)
+ * @brief This function finds the first bit set (beginning with the least significant bit)
  * in value and return the index of that bit.
  *
  * Bits are numbered starting at 1 (the least significant bit).  A return value of
@@ -1933,7 +1933,7 @@ const rt_uint8_t __lowest_bit_bitmap[] =
 };
 
 /**
- * This function finds the first bit set (beginning with the least significant bit)
+ * @brief This function finds the first bit set (beginning with the least significant bit)
  * in value and return the index of that bit.
  *
  * Bits are numbered starting at 1 (the least significant bit).  A return value of