RT-Thread-RTTHREAD Doxygen 阅读RT-Thread问答社区

RTTHREAD Doxygen 阅读

发布于 2024-06-26 15:04:59 浏览：317 订阅该版

[tocm]

## 简介

本文主要介绍RT-THREAD doxygen如何进行阅读和方便查找。

之前做了几篇doxygen如何生成和自动CI的内容，觉得还是需要让读者在使用的时候，尽快的了解这个doxygen生成的文档如何阅读和使用。

[如何在线查看RT-THREAD的API 的注释](https://club.rt-thread.org/ask/article/0323c2c543515f29.html)

## 页面解析

依照RT-THREAD作为例子。

首先打开下面的[RTTHREAD_API](https://supperthomas.github.io/RTT_doxygen_API/index.html)

第一个页面mainpage.h

![image-20240626093256934.png](https://oss-club.rt-thread.org/uploads/20240626/4961b6549b2fadf273e96014dff84d0c.png.webp)

这里一共有三个模块，introduce，Modules(模块)， Data Structures(结构体)

### Introduce

这个主要内容在`rt-thread\documentation\doxygen\mainpage.h`里面

这里分了三个section ： `RT-Thread Architecture`  `Kernel API` `System Initialization`

这里的所有内容都在mainpage.h里面有些图片通过`images`来引用

这里主要介绍了RT-THREAD的一些大概内容，可以简单阅读一下。这里的页面基本都是固定的，所以这里基本上改动不大。

### Modules (主要内容)

模块这里内容比较丰富，也比较重要，如下图所示，这里也是通过doxygen下面的一些头文件来索引到对应的group

这里的group是个比较重要的索引概念，可以将不同文 件中的group都放到一起整理。

![image-20240626094753064.png](https://oss-club.rt-thread.org/uploads/20240626/10e3167e88b5d402c3724235e6f38f44.png)

这里根据每个文档.h中的group，我们来整理出对应的关系图，如图所示

![image-20240626094452911.png](https://oss-club.rt-thread.org/uploads/20240626/878738bc47b1a79863aff3e87f1a8c9b.png.webp)

接下来就是modules里面的group了： `basic Definitions`, `Device virtual file system`, `finsh shell`,`Hardware Related Packages`, `RT-THREAD kernel API`, `Application module`, `System Initialization`

下面根据重要性依次简介一下这些模块。

#### Kernel (主要内容)

Kernel是最重要的这里包含，线程管理，时钟管理，内核结构体管理，线程间通信，内存管理，设备系统，实时跟踪和记录，其他kernel service， error code，等等。都是比较重要的模块

这个group名字叫`Kernel`

![image-20240626095603527.png](https://oss-club.rt-thread.org/uploads/20240626/88c0b08d1022bcd11cdb32ac2fa5fa33.png)

![image-20240626100516416.png](https://oss-club.rt-thread.org/uploads/20240626/a36ad41e6d423d83486dac69f1193796.png)

在kernel.h中又定义了几个group，然后在其他文件中`@addtogroup Hook` 就可以索引到这里的group中。这里的group在其他.c和.h中，这里就不一一列出了，src和include下面有很多.c和.h都包含了这些group。

#####  Thread  线程管理

线程管理常见函数以`rt_thread_` 打头的函数

##### Clock  时间和时钟管理

时间管理函数以`rt_tick_` 和`rt_timer_` 打头的函数

##### Object  对象管理

对象管理以`rt_object_` 打头的函数

##### Inter-Thread 线程间通信  (主要内容)

这里有`semaphore`, `Mutex`, `event`, `mailbox`,`messagequeue`,

#### Device Virtual File System

![image-20240626100951988.png](https://oss-club.rt-thread.org/uploads/20240626/9804cb35f2e5101d881f2a1b79e97f1f.png)

这个是文件系统，调用的是dfs_v2中的注释

#### finsh

这个是finsh系统

![image-20240626101033263.png](https://oss-club.rt-thread.org/uploads/20240626/c55ec19ab30d7bb92114921206740ade.png)
放的是finsh中的doxygen注释。

####  Hardware

这个是硬件libcpu中需要实现的一些函数，在hardware.h中。

![image-20240626101108194.png](https://oss-club.rt-thread.org/uploads/20240626/18ecc7b596cf06ab77dbefc00c848943.png)
### Data Structures

这个是数据结构体。自动生成的。

## PR 内容

这边检查过程中发现以下问题。

1. Signal 信号有两个，而且是空的，这是由于`addtogroup`的时候，看起来很不和谐，需要在kernel.h中添加如下机制

![image-20240626082626266.png](https://oss-club.rt-thread.org/uploads/20240626/9ecdda0a47e51979382a3588173341aa.png)

2. Inter-Thread communication 中，Mutex中的内容和下面的函数内容重复，

![image-20240626151211938.png](https://oss-club.rt-thread.org/uploads/20240626/4ba61e3fe582eeae794634280f4b7414.png)

# 如果读者在使用阅读的时候，发现有什么问题，可以留言回复，我来修复或者你也可以修复

https://github.com/RT-Thread/rt-thread/pull/9103

回到
底部

RTTHREAD Doxygen 阅读

关于作者

RTT_逍遥

相关文章

热门标签

本月文章贡献

RTTHREAD Doxygen 阅读

关于作者

RTT_逍遥

相关文章

推荐文章

热门标签

本月问答贡献

本月文章贡献