汪辰_高级工程师_RT-Thread 内核仓库文档改进工作介绍.pptx

1、RT-Thread 内核仓库文档改进工作介绍,汪辰 PLCT实验室,目录,01,问题描述,RT-Thread 现有可访问的在线文档,问题总结,针对关键的内核 API 文档维护缺失文档内容更新不及时，和最新代码脱节文档存在多处管理，不集中中英文文档不同步.,02,改进目标和方案,改进目标,先重点完善内核 API 文档将 API 文档和内核代码仓库(https:/gitee 仓库内容和 github 的英文内容对齐后合并。参考：Issue#9871,改进方案,将现有 RT-Thread 内核仓库中的 documentation 下的 markdown 文档和代码中的 doxygen 注释整合起来。

2、完善 doxygen 模块（group）分类。完善内核 C 代码中针对 API 的 doxygen 注释。更新 markdown 文档中对 API 的描述。,03,改进进展汇报,进展汇报,采用 doxygen 统一 makrdown 和 c 源码 API。相关 PR：#9946#10197,改进前 RTT 代码仓库的 documentation/采用 doxygen 生成的 html 页面,进展汇报,采用 doxygen 统一 makrdown 和 c 源码 API。相关 PR：#9946#10197,改进后 RTT 代码仓库的 documentation/采用 doxygen 生成的 htm

3、l 页面，https:/rt-thread.github.io/rt-thread/,进展汇报,规范 C 源码中doxygen 编写规范。相关 PR：#9975#9989#9991.,https:/rt-thread.github.io/rt-thread/,进展汇报,改进特定 group 的 markdown 文档和 API 的 doxygen 注释。相关 PR：add doxygen comment for clk.c and clk.h：#9950finsh:Normalize macro definitions：#10006improve doc for kernel basics s

4、ection：#10066.更多 PR 信息参考 Issue 总结：#9824,进展汇报,其他改进：利用 github page,实时生成 API 文档页面：https:/rt-thread.github.io/rt-thread/利用 github CI,对 RTT 内核仓库下的 documentation 目录进行 PR 期间的编译检测。提供方便开发使用的工具，文档。.,04,未来工作,未来工作,继续整理 group继续改进、补充特定 group 的 API doxygen 注释继续改进、补充特定 group 的 markdown 文档加入中文支持（markdown 部分）其他（欢迎提出建议）,未来工作,感谢贡献者（排名不分先后，如有遗漏请补充）Supper Thomas wumingzi.欢迎大家积极参与，有文档或者 Doxygen 相关问题可以在 https:/提出，或者联系我：Chen Wang,谢谢,