summaryrefslogtreecommitdiff
path: root/src/cpu.c
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/cpu.c
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/cpu.c')
-rw-r--r--src/cpu.c4
1 files changed, 4 insertions, 0 deletions
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)
{