Skip to content

doxygen: group name all in lowcase (part 1) #10432

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
Rbb666 merged 1 commit into from
Jun 25, 2025
Merged

doxygen: group name all in lowcase (part 1) #10432

Rbb666 merged 1 commit into from
Jun 25, 2025

Conversation

@unicornx
Copy link
Contributor

@unicornx unicornx commented Jun 24, 2025 •
edited
Loading

group 的名字全部统一采用小写。

此补丁仅更新了 documentation/0.doxygen 中定义的 group。其他 group 的定义以后将陆续被移至 documentation/0.doxygen 并同时更新。

本 PR 只是对注释进行改动，不涉及参与编译的代码。

拉取/合并请求描述：(PR description)

[

为什么提交这份PR (why to submit this PR)

你的解决方案是什么 (what is your solution)

请提供验证的bsp和config (provide the config and bsp)

  • BSP:
  • .config:
  • action:

]

当前拉取/合并请求的状态 Intent for your PR

必须选择一项 Choose one (Mandatory):

  • 本拉取/合并请求是一个草稿版本 This PR is for a code-review and is intended to get feedback
  • 本拉取/合并请求是一个成熟版本 This PR is mature, and ready to be integrated into the repo

代码质量 Code Quality：

我在这个拉取/合并请求中已经考虑了 As part of this pull request, I've considered the following:

  • 已经仔细查看过代码改动的对比 Already check the difference between PR and old code
  • 代码风格正确，包括缩进空格，命名及其他风格 Style guide is adhered to, including spacing, naming and other styles
  • 没有垃圾代码，代码尽量精简，不包含#if 0代码，不包含已经被注释了的代码 All redundant code is removed and cleaned up
  • 所有变更均有原因及合理的，并且不会影响到其他软件组件代码或BSP All modifications are justified and not affect other components or BSP
  • 对难懂代码均提供对应的注释 I've commented appropriately where code is tricky
  • 代码是高质量的 Code in this PR is of high quality
  • 已经使用formatting 等源码格式化工具确保格式符合RT-Thread代码规范 This PR complies with RT-Thread code specification
  • 如果是新增bsp, 已经添加ci检查到.github/workflows/bsp_buildings.yml 详细请参考链接BSP自查

@unicornx
doxygen: group name all in lowcase
94c433e 
This patch only updated the groups defined in documentation/0.doxygen.

Other groups will be moved into documentation/0.doxygen and updated at
that time.

Signed-off-by: Chen Wang <[email protected]>
@github-actions github-actions bot added Doc This PR/issue related with documents Kernel PR has src relate code Component labels Jun 24, 2025
@github-actions
Copy link

github-actions bot commented Jun 24, 2025 •
edited
Loading

📌 Code Review Assignment

🏷️ Tag: documentation

Path: documentation
Reviewers: unicornx GorrayLi lianux-mm CXSforHPU

Changed Files (Click to expand)
  • documentation/0.doxygen/0.basicdef.h
  • documentation/0.doxygen/1.core.h
  • documentation/0.doxygen/2.components.h
  • documentation/0.doxygen/components/filesystem.h
  • documentation/0.doxygen/core/ipc.h
  • documentation/0.doxygen/core/systeminit.h
  • documentation/0.doxygen/core/thread.h

🏷️ Tag: kernel

Path: src
Reviewers: GorrayLi lianux-mm wdfk-prog

Changed Files (Click to expand)
  • src/clock.c
  • src/ipc.c
  • src/irq.c
  • src/kservice.c
  • src/mem.c
  • src/mempool.c
  • src/object.c
  • src/scheduler_mp.c
  • src/scheduler_up.c
  • src/slab.c
  • src/thread.c
  • src/timer.c

📊 Current Review Status (Last Updated: 2025-06-25 02:04 UTC)

  • ⌛ CXSforHPU Pending Review
  • ⌛ GorrayLi Pending Review
  • ⌛ lianux-mm Pending Review
  • ⌛ unicornx Pending Review
  • ⌛ wdfk-prog Pending Review

📝 Review Instructions

  1. 维护者可以通过单击此处来刷新审查状态: 🔄 刷新状态
    Maintainers can refresh the review status by clicking here: 🔄 Refresh Status

  2. 确认审核通过后评论 LGTM/lgtm
    Comment LGTM/lgtm after confirming approval

  3. PR合并前需至少一位维护者确认
    PR must be confirmed by at least one maintainer before merging

ℹ️ 刷新CI状态操作需要具备仓库写入权限。
ℹ️ Refresh CI status operation requires repository Write permission.

@unicornx
Copy link
Contributor Author

unicornx commented Jun 24, 2025

本 PR 只是对注释进行改动，不涉及参与编译的代码。所以 ci check 报错部分和本 pr 无关。

@unicornx unicornx requested a review from Rbb666 June 24, 2025 08:58
@BernardXiong
Copy link
Member

BernardXiong commented Jun 25, 2025

后续可以看看，一些核心部分应该在检查中都应该能过的。后续需要提PR修修这个问题了。

@kurisaW
Copy link
Member

kurisaW commented Jun 25, 2025

bsp报错是正常现象，等待此PR合并后重新跑一下就可以了：

@Rbb666 Rbb666 closed this Jun 25, 2025
@Rbb666 Rbb666 reopened this Jun 25, 2025
@Rbb666 Rbb666 merged commit 8e9872a into RT-Thread:master Jun 25, 2025
118 of 123 checks passed
@unicornx unicornx changed the title doxygen: group name all in lowcase doxygen: group name all in lowcase (part 1) Jul 22, 2025
@unicornx unicornx mentioned this pull request Jul 22, 2025
Merged
@unicornx unicornx deleted the dev-doxygen-groupname branch July 22, 2025 07:22
@unicornx unicornx mentioned this pull request Sep 2, 2025
Open
@Rbb666 Rbb666 mentioned this pull request Sep 18, 2025
Open
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Rbb666 Rbb666 Rbb666 approved these changes

@mysterywolf mysterywolf Awaiting requested review from mysterywolf mysterywolf is a code owner

@Cathy-lulu Cathy-lulu Awaiting requested review from Cathy-lulu Cathy-lulu is a code owner

@BernardXiong BernardXiong Awaiting requested review from BernardXiong BernardXiong is a code owner

Assignees

No one assigned

Labels

Component Doc This PR/issue related with documents Kernel PR has src relate code

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@unicornx @BernardXiong @kurisaW @Rbb666