From 2c98ce4605515910025212a85b2f776129a0981c Mon Sep 17 00:00:00 2001 From: Xu Biang Date: Sat, 15 Apr 2023 00:33:43 +0800 Subject: [HUST CSE][document] Fix some comments, invalid grouping commands and warnings in Doxygen. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 将Doxygen输入文件（由Doxyfile中的INPUT定义）中的失效Doxygen分组指令（如/*@*/和/*@}*/）更改为有效的分组指令（如/**@*/和/**@}*/）；（此处只对INPUT中的文件做了修改，bsp目录下和libcpu目录下存在近万个失效的Doxygen分组指令，但由于不作为文档的输入文件且这些文件过于庞大老旧，没有对这些文件中的无效指令做修改） 将图片文件统一放入了images目录下； 修改了Doxyfile和部分Doxygen注释，使得Doxyfile能够定位到新的代码路径且不受重复实现的影响； 解决了一些注释中的参数名不匹配、参数多余/缺失等问题。 --- src/components.c | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'src/components.c') 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) { -- cgit v1.3.1