[Feature] RTT doxygen 文档改进

[unicornx]

Describe problem solved by the proposed feature

这个 issue 用于搜集 RTT 代码仓库中和 doxygen 文档维护改进相关的问题：

• 问题 1：见 [Feature] RTT 文档优化 #9871 中的 ”问题 1“

  • [Feature] 初始的统一 doxgen 框架 #9880

• 问题 2：目前 RTT 代码中有些 API 部分缺少良好的注释，（FIXME：具体条目有待进一步收集）

  • [Feature] lwp, dm 等组件需要补充 doxygen 注释 | Add Doxygen Comments for Components #9263
  • [Feature] [doc] doxygen文档中缺少driver相关的doxygen #9424

• 问题 3: 文档部分还有些技术点需要补充完善，但我建议优先解决 ”问题 1“ 后再考虑这个 （FIXME：具体条目有待进一步收集）

  • 看 https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-smart/introduction/rt-smart-lwp/rt-smart-lwp 中提到 “RT-Thread 用户态版本 API 和原系统 API 的差异" 的问题，是说 RTT 支持 smart 后，对于原先 RTT 提供的 API，用户态程序还可以有一部分可以直接调用，如果在 RTT 上有一部分可以直接调用，那怎么区分？用户编程时怎么知道哪些 API 是可以直接调用的？习惯上我理解用户态的程序，只能通过 system call 和内核交互的吧，直接调用内核提供的 api 感觉有点怪怪的。

Describe your preferred solution

No response

Describe possible alternatives

No response

[unicornx]

有关文档改进的工作我也很有兴趣，希望能在相关方面做些工作，推进一下。

[BernardXiong]

文档中心

[BernardXiong]

英文documentation的部署是在这里： https://www.rt-thread.io/document/site/

不清楚是否是机器人自动化部署的了，可能不是。

[supperthomas]

• [Feature] [doc] doxygen文档中缺少driver相关的doxygen #9424

这个doxygen还有很多未更新的地方，汪老师可以PR维护一下。

[unicornx]

• [Feature] [doc] doxygen文档中缺少driver相关的doxygen #9424

这个doxygen还有很多未更新的地方，汪老师可以PR维护一下。

谢谢补充，我更新到 issue 的 问题 2 中了

[unicornx]

本文档用于描述 API 文档的层次结构设计

- Basic Definitions
- Device Virtual File System
- finsh shell
- Hardware Related Package
- RT-Thread Kernel API
  - Thread Management
  - Clock and Timer Management
  - Kernel Object Management
  - Inter-Thread Communication
    - Semaphore
    - Mutex
    - Event
    - Mailbox
    - Messagequeue
  - Signal
  - Memory Management
  - Device System
  - Runtime Trace and Record
  - Other useful kernel service
  - Error Code
- Application Module
- System Initialization
- RTTHREAD Driver
  - ADC
  - DAC
  - ...

是否可以和 documentation 下的文档结合起来，结构的安排尽量和其对齐。

就是有没有可能将下面两个网站的内容统一起来？

• https://www.rt-thread.io/document/site/
• https://supperthomas.github.io/RTT_doxygen_API/

[unicornx]

@supperthomas 这个 issue 列举了很多其他的问题，不是单个 #9859 就完全解决的，所以重新打开

[unicornx]

部分涉及文档中心改进的内容我新建了一个 #9871 来跟进，这个 issue 以后将主要用于搜集和跟进代码(.h/.c）文件中 doxygen 编写 API 文档的工作。