summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorXu Biang <[email protected]>2023-04-15 00:33:43 +0800
committerGitHub <[email protected]>2023-04-14 12:33:43 -0400
commit2c98ce4605515910025212a85b2f776129a0981c (patch)
tree8ff69183cc0465ed66f818b917557dbb9bc4f718 /src
parent4157a2802bc1197eae738d204cd414d0d1bc0934 (diff)
[HUST CSE][document] Fix some comments, invalid grouping commands and warnings in Doxygen.
将Doxygen输入文件(由Doxyfile中的INPUT定义)中的失效Doxygen分组指令(如/*@*/和/*@}*/)更改为有效的分组指令(如/**@*/和/**@}*/);(此处只对INPUT中的文件做了修改,bsp目录下和libcpu目录下存在近万个失效的Doxygen分组指令,但由于不作为文档的输入文件且这些文件过于庞大老旧,没有对这些文件中的无效指令做修改) 将图片文件统一放入了images目录下; 修改了Doxyfile和部分Doxygen注释,使得Doxyfile能够定位到新的代码路径且不受重复实现的影响; 解决了一些注释中的参数名不匹配、参数多余/缺失等问题。
Diffstat (limited to 'src')
-rw-r--r--src/components.c4
-rw-r--r--src/cpu.c4
-rw-r--r--src/device.c2
-rw-r--r--src/kservice.c4
-rw-r--r--src/scheduler_mp.c2
-rw-r--r--src/scheduler_up.c2
6 files changed, 17 insertions, 1 deletions
diff --git a/src/components.c b/src/components.c
index 809ca72a1d..97ace80990 100644
--- a/src/components.c
+++ b/src/components.c
@@ -174,6 +174,8 @@ struct rt_thread main_thread;
* @brief The system main thread. In this thread will call the rt_components_init()
* for initialization of RT-Thread Components and call the user's programming
* entry main().
+ *
+ * @param parameter is the arg of the thread.
*/
void main_thread_entry(void *parameter)
{
@@ -228,6 +230,8 @@ void rt_application_init(void)
/**
* @brief This function will call all levels of initialization functions to complete
* the initialization of the system, and finally start the scheduler.
+ *
+ * @return Normally never returns. If 0 is returned, the scheduler failed.
*/
int rtthread_startup(void)
{
diff --git a/src/cpu.c b/src/cpu.c
index a89a0cca6a..8108d28da4 100644
--- a/src/cpu.c
+++ b/src/cpu.c
@@ -178,6 +178,8 @@ struct rt_cpu *rt_cpu_self(void)
/**
* @brief This fucntion will return the cpu object corresponding to index.
*
+ * @param index is the index of target cpu object.
+ *
* @return Return a pointer to the cpu object corresponding to index.
*/
struct rt_cpu *rt_cpu_index(int index)
@@ -242,6 +244,8 @@ RTM_EXPORT(rt_cpus_unlock);
* This function is invoked by scheduler.
* It will restore the lock state to whatever the thread's counter expects.
* If target thread not locked the cpus then unlock the cpus lock.
+ *
+ * @param thread is a pointer to the target thread.
*/
void rt_cpus_lock_status_restore(struct rt_thread *thread)
{
diff --git a/src/device.c b/src/device.c
index 9665788c77..2bd2289e22 100644
--- a/src/device.c
+++ b/src/device.c
@@ -461,8 +461,8 @@ RTM_EXPORT(rt_device_set_tx_complete);
/**
* This function bind drvier and device
*
- * @param driver the pointer of driver structure
* @param device the pointer of device structure
+ * @param driver the pointer of driver structure
* @param node the pointer of fdt node structure
*
* @return the error code, RT_EOK on successfully.
diff --git a/src/kservice.c b/src/kservice.c
index 1c1d8da848..1f06055ff1 100644
--- a/src/kservice.c
+++ b/src/kservice.c
@@ -1902,6 +1902,8 @@ const rt_uint8_t __lowest_bit_bitmap[] =
* Bits are numbered starting at 1 (the least significant bit). A return value of
* zero from any of these functions means that the argument was zero.
*
+ * @param value is the value to find the first bit set in.
+ *
* @return return the index of the first bit set. If value is 0, then this function
* shall return 0.
*/
@@ -1937,6 +1939,8 @@ const rt_uint8_t __lowest_bit_bitmap[] =
* Bits are numbered starting at 1 (the least significant bit). A return value of
* zero from any of these functions means that the argument was zero.
*
+ * @param value is the value to find the first bit set in.
+ *
* @return Return the index of the first bit set. If value is 0, then this function
* shall return 0.
*/
diff --git a/src/scheduler_mp.c b/src/scheduler_mp.c
index 543d9abc6a..243cfd8dbe 100644
--- a/src/scheduler_mp.c
+++ b/src/scheduler_mp.c
@@ -239,6 +239,7 @@ void rt_system_scheduler_start(void)
/**
* @addtogroup Thread
+ * @cond
*/
/**@{*/
@@ -754,3 +755,4 @@ rt_uint16_t rt_critical_level(void)
RTM_EXPORT(rt_critical_level);
/**@}*/
+/**@endcond*/
diff --git a/src/scheduler_up.c b/src/scheduler_up.c
index 6c552c6a24..4c96089e34 100644
--- a/src/scheduler_up.c
+++ b/src/scheduler_up.c
@@ -212,6 +212,7 @@ void rt_system_scheduler_start(void)
/**
* @addtogroup Thread
+ * @cond
*/
/**@{*/
@@ -500,3 +501,4 @@ rt_uint16_t rt_critical_level(void)
RTM_EXPORT(rt_critical_level);
/**@}*/
+/**@endcond*/