[components/lwp]add doxygen comment for lwp futex.#10763
[components/lwp]add doxygen comment for lwp futex.#10763supperthomas merged 1 commit intoRT-Thread:masterfrom
Conversation
|
👋 感谢您对 RT-Thread 的贡献!Thank you for your contribution to RT-Thread! 为确保代码符合 RT-Thread 的编码规范,请在你的仓库中执行以下步骤运行代码格式化工作流(如果格式化CI运行失败)。 🛠 操作步骤 | Steps
完成后,提交将自动更新至 如有问题欢迎联系我们,再次感谢您的贡献!💐 |
📌 Code Review Assignment🏷️ Tag: componentsReviewers: Maihuanyi Changed Files (Click to expand)
🏷️ Tag: components_lwpReviewers: xu18838022837 Changed Files (Click to expand)
📊 Current Review Status (Last Updated: 2025-10-03 20:33 CST)
📝 Review Instructions
|
运行clang-format工作流,由github-actions[bot]自动提交了格式化修改,但是检查github-actions[bot]没sign CLA,如何解决? |
|
把commit改成自己的,在force-push一下 |
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive doxygen documentation comments for RT-Thread's lightweight process (lwp) futex implementation. The changes focus entirely on improving code documentation without modifying any functionality.
Key Changes
- Added detailed doxygen comments for all public and static functions in the futex module
- Added structure member documentation with inline comments
- Updated copyright year from 2023 to 2025 across all affected files
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
components/lwp/lwp_futex_table.c |
Added doxygen comments for global futex table management functions |
components/lwp/lwp_futex_internal.h |
Added documentation for futex data structures and member variables |
components/lwp/lwp_futex.c |
Added comprehensive documentation for all futex operation functions |
拉取/合并请求描述:(PR description)
[
为什么提交这份PR (why to submit this PR)
add doxygen comment for lwp futex.
你的解决方案是什么 (what is your solution)
add doxygen comment for lwp futex.
请提供验证的bsp和config (provide the config and bsp)
BSP:
.config:
action:
]
当前拉取/合并请求的状态 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