Skip to content

doxygen: promote object management to a separate page #10532

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.

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

Merged
merged 1 commit into from
Jul 22, 2025

Conversation

unicornx
Copy link
Contributor

@unicornx unicornx commented Jul 22, 2025

将 object mangement 提升为一个独立的页面

将 “RT-Thread User Guide” 中的 “RT-Thread Kernel Object Model” 这个章节从 “Kernel Basics” 拿出来作为一个相对独立的章节并改名为 “Object Management”(主要是希望和 “Thread Management“ 这些名字的风格一致)。

对应的,“RT-Thread API Guide” 中的 “Kernel Object Management” 也改名为 “Object Management”

note: 代码部分的修改只是 doxygen 注释,没有修改代码逻辑。

对于 “RT-Thread User Guide”:

修改前的页面 存在两个问题:

  • (1)“RT-Thread Kernel Object Model”(即 “Object Management")部分放在 ”Kernel Basics“ 下,但是实际上它应该和 ”Thread Management“ 这些章节同一个级别放在 ”Kenrel“ 下面。
  • (2) ”RT-Thread Kernel Configuration Example“ 和 ”Common Macro Definition Description“ 这两个部分不属于 ”RT-Thread Kernel Object Model”,应该直接在 “Kernel Basics” 下面。
image

修改后:

image

对于 “RT-Thread API Guide”

修改前:

image ## 修改后: 改了个名字,和 “RT-Thread User Guide” 中的描述保持一致。 image

For "RT-Thread User Guide":
Take the "RT-Thread Kernel Object Model" sub-section out of
the "Kernel Basics" section and rename it to "Object Management".

Correspondingly, rename the "Kernel Object Management" section
in the "RT-Thread API Guide" to "Object Management".

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
@github-actions github-actions bot added Doc This PR/issue related with documents Kernel PR has src relate code labels Jul 22, 2025
Copy link

📌 Code Review Assignment

🏷️ Tag: documentation

Reviewers: @CXSforHPU @GorrayLi @lianux-mm @unicornx

Changed Files (Click to expand)
  • documentation/0.doxygen/1.core.h
  • documentation/3.kernel/INDEX.md
  • documentation/3.kernel/basic/basic.md
  • documentation/3.kernel/object/figures/03kernel_object.png
  • documentation/3.kernel/object/figures/03kernel_object2.png
  • documentation/3.kernel/object/object.md

🏷️ Tag: kernel

Reviewers: @GorrayLi @ReviewSun @hamburger-os @lianux-mm @wdfk-prog @xu18838022837

Changed Files (Click to expand)
  • src/object.c

📊 Current Review Status (Last Updated: 2025-07-22 17:08 CST)


📝 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 unicornx requested a review from Rbb666 July 22, 2025 09:10
@Rbb666 Rbb666 merged commit 3c04664 into RT-Thread:master Jul 22, 2025
62 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Doc This PR/issue related with documents Kernel PR has src relate code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy