[Feature] RTT doxygen 文档改进

[unicornx]

Describe problem solved by the proposed feature

需求来源：

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

这个 issue 用于搜集 RTT 代码仓库中和 doxygen 文档维护改进相关的 issue，可以分为下面两大部分：

• 基础框架和 group 组织

  • [Feature] 初始的统一 doxgen 框架 #9880
  • API 的 group 组织整理，缺的需要补上。（issue 还没有提，待定 TBD）

• 特定 group 的 API 的 doxygen 注释。依赖于基础框架和 group 组织

  • [Feature] lwp, dm 等组件需要补充 doxygen 注释 | Add Doxygen Comments for Components #9263
  • [Feature] [doc] doxygen文档中缺少driver相关的doxygen #9424
  • 其他具体条目有待进一步收集，issue 待整理和提交。
    • 看 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 感觉有点怪怪的。

• 此外：我建议在 doxygen 整理这项工作开展的同时，我建议也同步开展 utest 的整理工作。具体来说，就是每梳理一个模块（对应 doxygen 中的一个 group），同时整理这个 group 对应的 utest。也就是说下面这两项工作会同步协调开展：

  • [Feature] RTT doxygen 文档改进 #9824（即本 issue）
  • [Feature] 改进自动化测试以及 ci 看护 #9775

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]

部分涉及文档中心改进的内容我新建了一个

• [Feature] RTT 文档优化 #9871
  来讨论，这个 issue 以后将主要用于搜集和跟进代码(.h/.c）文件中 doxygen 编写 API 文档的工作。

[1078249029]

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

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

请问这个还需要补充doxygen么？我看到熊大在 #9924 (comment) 说最好先梳理lwp模块，之后再补充doxygen注释。driver是否也有类似的问题？

[supperthomas]

http://rt-thread.github.io/rt-thread/group___drivers.html

我觉得这部分应该还是不是很完善的。

参考下面链接中的文件

https://github.com/RT-Thread/rt-thread/tree/master/components/drivers
https://github.com/RT-Thread/rt-thread/tree/master/components/drivers/include/drivers