rt-thread icon indicating copy to clipboard operation
rt-thread copied to clipboard

[Feature] documents improve summary

Open unicornx opened this issue 6 months ago • 0 comments

这个 issue 用于 draft & summary 一些我看到的和 doxygen 有关的问题。本 issue 是 #9824 的 child issue。

  • http://192.168.2.6:8000/group__group__kernel__core.html 上面列的这些函数感觉应该放到 bsp 部分去。

    • rt_interrupt_enter
    • rt_interrupt_leave
    • rt_interrupt_get_nest
  • 【已解决】group 名字统一改小写 #10432 & #10530

    • group_KernelObject 需要改成 group_kernel_object
    • group_Thread 名字改成小写 group_thread
  • documentation/0.doxygen/1.core.h 上的内容(会出现在 API Guide 部分)和 markdown 部分(会出现在 User Guide 部分)重复,需要清理掉。

  • #10097

  • mp.c 和 up.c 中两份注释的统一解决方案,问题描述见 #10599

  • 目前 documentation/0.doxygen/ 下的 header 文件严格意义上应该只用于定义 doxygen 的 group,而不应该包括代码的 doxygen 注释。(类似的问题还有一些,譬如 documentation/0.doxygen/3.hardware.h 和 documentation/0.doxygen/core/systeminit.h, 有待进一步清理。)

unicornx avatar Jun 19 '25 09:06 unicornx