Doxygen: move device/driver under to components #10336
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The originally defined "group_Device" should actually be part of the device-driver component, so create a new "group_device_driver" and then rename "group_Device" to "group_device_driver". Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
The originally defined "group_Drivers" should actually be part of the device-driver component, so "group_Drivers" is renamed to "group_device_driver". In this way, the original "group_Device" and "group_Drivers" are merged into "group_device_driver". Adjusted the writing method of doxygen comments in the driver code to be unified as follows: ```c * @defgroup group_XXX XXX * @brief xxxxxx * @InGroup group_device_driver ``` Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
In line with the layout of the source code, the Device-Driver submodule should belong to components. The doxygen Module part has been adjusted. This commit modifies the markdown document part and moves the device-driver pages under to components. Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
github-actions
bot
added
Doc
📌 Code Review Assignment🏷️ Tag: documentationPath: Changed Files (Click to expand)
📊 Current Review Status (Last Updated: 2025-05-29 02:26 UTC)
📝 Review Instructions
|
Rbb666
approved these changes
May 29, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
和源码的布局保持一致，Device-Driver 子模块应该属于 components 下。文档的布局也相应做出调整。
调整前：我们看到 Guide 部分和 Module 部分的 Device/Driver 都是独立在 Components 之外的。而且名字还不统一，一个叫 Device，一个叫 ”RTTHREAD Driver‘
调整后： Guide 部分和 Module 部分以统一的名字 ”Device Driver“ 放在 Components 下一级。
文件改动貌似很多，但逻辑比较直接，为了方便 review，这个 PR 由三个 commit 组成：
“doxygen: change group_Device to group_device_driver”：原先定义的 group_Device 实际上应该属于 device-driver 组件的一部分，所以新建一个 group_device_driver， 然后将 group_Device 更名为 group_device_driver
“doxygen: change group_Drivers to group_device_driver”：原先定义的 "group_Drivers" 实际上应该属于 device-driver 组件的一部分，所以将 "group_Drivers" 更名为 "group_device_driver"。这样原先的 “group_Device" 和 ”group_Drivers" 就合并为 "group_device_driver"。
同时调整了 driver 代码中的 doxygen 注释的写法，统一为：
“doxygen: move device_driver under to components for pages”：doxygen Module 部分已经调整完毕，这个提交是修改了 markdown 文档部分，也将 device-driver 的 page 移到 components 下。
拉取/合并请求描述：(PR description)
[
为什么提交这份PR (why to submit this PR)
你的解决方案是什么 (what is your solution)
请提供验证的bsp和config (provide the config and bsp)
]
当前拉取/合并请求的状态 Intent for your PR
必须选择一项 Choose one (Mandatory):
代码质量 Code Quality：
我在这个拉取/合并请求中已经考虑了 As part of this pull request, I've considered the following:
#if 0代码，不包含已经被注释了的代码 All redundant code is removed and cleaned up