Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[新手任务][注释修复][doxygen]修复注释中的语法错误 #6857

Closed
supperthomas opened this issue Jan 15, 2023 · 4 comments
Closed
Labels
good first issue Good for newcomers 新手任务

Comments

@supperthomas
Copy link
Member

supperthomas commented Jan 15, 2023

可以根据文章来执行doxygen
https://club.rt-thread.org/ask/article/bf867386b24e5d7c.html

通过生成文档过程中提示的warning修复相应的.c .h
中的注释,
具体以doxygen生成的log为准,
找到自己会改的warning,改一个提交PR即可。

/workspaces/rt-thread/src/kservice.c:1398: warning: Member rt_malloc_sethook found in multiple @addtogroup groups! The member will be put in group Hook, and not in group KernelService
/workspaces/rt-thread/include/rtthread.h:250: warning: Member rt_mp_init found in multiple @addtogroup groups! The member will be put in group MM, and not in group Signals
/workspaces/rt-thread/include/rtthread.h:358: warning: Member rt_sem_init found in multiple @addtogroup groups! The member will be put in group IPC, and not in group Signals
/workspaces/rt-thread/include/rtthread.h:547: warning: Member rt_device_find found in multiple @addtogroup groups! The member will be put in group Device, and not in group Signals
Searching for friends...
Searching for documented defines...
/workspaces/rt-thread/include/rtthread.h:639: warning: Member rt_kprintf found in multiple @addtogroup groups! The member will be put in group KernelService, and not in group Signals
/workspaces/rt-thread/components/finsh/shell.c:135: warning: argument 'prompt' of command @param is not found in the argument list of finsh_set_prompt_mode(rt_uint32_t prompt_mode)
/workspaces/rt-thread/components/finsh/shell.c:142: warning: The following parameter of finsh_set_prompt_mode(rt_uint32_t prompt_mode) is not documented:
  parameter 'prompt_mode'
/workspaces/rt-thread/src/thread.c:975: warning: The following parameter of rt_thread_suspend_with_flag(rt_thread_t thread, int suspend_flag) is not documented:
  parameter 'suspend_flag'
/workspaces/rt-thread/src/object.c:639: warning: argument 'type' of command @param is not found in the argument list of rt_custom_object_create(const char *name, void *data, rt_err_t(*data_destroy)(void *))
/workspaces/rt-thread/src/ipc.c:124: warning: The following parameter of _ipc_list_suspend(rt_list_t *list, struct rt_thread *thread, rt_uint8_t flag, int suspend_flag) is not documented:
  parameter 'suspend_flag'
/workspaces/rt-thread/include/rtthread.h:432: warning: The following parameter of rt_mb_init(rt_mailbox_t mb, const char *name, void *msgpool, rt_size_t size, rt_uint8_t flag) is not documented:
  parameter 'msgpool'
/workspaces/rt-thread/include/rtthread.h:277: warning: argument 'begin_addr' from the argument list of rt_system_heap_init has multiple @param documentation sections
/workspaces/rt-thread/include/rtthread.h:277: warning: argument 'end_addr' from the argument list of rt_system_heap_init has multiple @param documentation sections
/workspaces/rt-thread/src/mem.c:165: warning: argument 'm' of command @param is not found in the argument list of rt_smem_init(const char *name, void *begin_addr, rt_size_t size)
/workspaces/rt-thread/include/rtservice.h:130: warning: Found unknown command '\pos'
/workspaces/rt-thread/include/rtservice.h:131: warning: Found unknown command '\head'
/workspaces/rt-thread/include/rtservice.h:138: warning: Found unknown command '\pos'
/workspaces/rt-thread/include/rtservice.h:140: warning: Found unknown command '\head'
/workspaces/rt-thread/include/rtservice.h:148: warning: Found unknown command '\pos'
/workspaces/rt-thread/include/rtservice.h:149: warning: Found unknown command '\head'
/workspaces/rt-thread/include/rtservice.h:150: warning: Found unknown command '\member'
/workspaces/rt-thread/include/rtservice.h:159: warning: Found unknown command '\pos'
/workspaces/rt-thread/include/rtservice.h:161: warning: Found unknown command '\head'
/workspaces/rt-thread/include/rtservice.h:162: warning: Found unknown command '\member'
/workspaces/rt-thread/include/rtservice.h:172: warning: Found unknown command '\ptr'
/workspaces/rt-thread/include/rtservice.h:173: warning: Found unknown command '\type'
/workspaces/rt-thread/include/rtservice.h:174: warning: Found unknown command '\member'
/workspaces/rt-thread/include/rtservice.h:269: warning: Found unknown command '\pos'
/workspaces/rt-thread/include/rtservice.h:270: warning: Found unknown command '\head'
/workspaces/rt-thread/include/rtservice.h:277: warning: Found unknown command '\pos'
/workspaces/rt-thread/include/rtservice.h:278: warning: Found unknown command '\head'
/workspaces/rt-thread/include/rtservice.h:279: warning: Found unknown command '\member'
/workspaces/rt-thread/include/rtservice.h:288: warning: Found unknown command '\ptr'
/workspaces/rt-thread/include/rtservice.h:289: warning: Found unknown command '\type'
/workspaces/rt-thread/include/rtservice.h:290: warning: Found unknown command '\member'
/workspaces/rt-thread/include/rtservice.h:299: warning: Found unknown command '\ptr'
/workspaces/rt-thread/include/rtservice.h:300: warning: Found unknown command '\type'
/workspaces/rt-thread/include/rtservice.h:301: warning: Found unknown command '\member'
/workspaces/rt-thread/src/ipc.c:2127: warning: The following parameter of rt_mb_init(rt_mailbox_t mb, const char *name, void *msgpool, rt_size_t size, rt_uint8_t flag) is not documented:
@mysterywolf mysterywolf added the good first issue Good for newcomers 新手任务 label Jan 15, 2023
@supperthomas
Copy link
Member Author

@supperthomas
Copy link
Member Author

参考PR
#6869

@supperthomas supperthomas changed the title [简单任务][注释修复][doxygen]修复注释中的语法错误 [新手任务][注释修复][doxygen]修复注释中的语法错误 Jan 19, 2023
mysterywolf pushed a commit that referenced this issue Apr 13, 2023
…7228)

根据这个issues #6857 在idle.c文件中找到一个函数缺失参数
@supperthomas
Copy link
Member Author

supperthomas commented Apr 17, 2023

参考中文模板:https://www.rt-thread.org/document/api/index.html

@supperthomas
Copy link
Member Author

https://github.com/RT-Thread/rt-thread/actions/workflows/doxygen.yml doxygen warning已全部修改。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers 新手任务
Projects
None yet
Development

No branches or pull requests

2 participants