[libc][syscall] 新手PR任务_Add detailed function comments for memory management #7426 #10880
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_libcReviewers: GorrayLi mysterywolf Changed Files (Click to expand)
📊 Current Review Status (Last Updated: 2025-11-03 16:59 CST)
📝 Review Instructions
|
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation comments for memory management wrapper functions (malloc, realloc, calloc, free) in the ARM compiler libc implementation. The changes improve code documentation by adding detailed function descriptions, parameter explanations, and return value documentation in Doxygen format.
Key Changes
- Added detailed Doxygen-style comments for all four memory allocation/deallocation functions
- Documented parameters, return values, and special behavior when heap is not configured
- Updated the file change log to reflect the documentation additions
| * Date Author Notes | ||
| * 2014-08-03 bernard Add file header | ||
| * 2021-11-13 Meco Man implement no-heap warning | ||
| * 2025-11-1 MaChengyang Add detailed function comments |
There was a problem hiding this comment.
Date format is inconsistent with other entries. Should use 'YYYY-MM-DD' format (2025-11-01) instead of 'YYYY-MM-D' (2025-11-1). / 日期格式与其他条目不一致。应使用 'YYYY-MM-DD' 格式（2025-11-01）而不是 'YYYY-MM-D'（2025-11-1）。
| * 2025-11-1 MaChengyang Add detailed function comments | |
| * 2025-11-01 MaChengyang Add detailed function comments |
| * Date Author Notes | ||
| * 2014-08-03 bernard Add file header | ||
| * 2021-11-13 Meco Man implement no-heap warning | ||
| * 2025-11-1 MaChengyang Add detailed function comments |
There was a problem hiding this comment.
Trailing whitespace detected at the end of the line. Remove the extra spaces after 'comments'. / 检测到行尾有多余的空格。请删除 'comments' 之后的空格。
| * 2025-11-1 MaChengyang Add detailed function comments | |
| * 2025-11-1 MaChengyang Add detailed function comments |
| #endif /* __CC_ARM */ | ||
|
|
||
| /** | ||
| * @brief Allocate memory block |
There was a problem hiding this comment.
| * Date Author Notes | ||
| * 2014-08-03 bernard Add file header | ||
| * 2021-11-13 Meco Man implement no-heap warning | ||
| * 2025-11-1 MaChengyang Add detailed function comments |
There was a problem hiding this comment.
建议不要更新这种列表了，不理解为啥 RTT 还在用这种很古老的方式。现在有 git，在git 的 commit 里加上你的签名就好了，可以看一下其他用 git的开源项目里的加签名的方式 ”Signed-off-by: Your name "。
| * | ||
| * @note The returned pointer is always suitably aligned for any built-in type. | ||
| * @see rt_malloc | ||
| */ |
There was a problem hiding this comment.
建议仔细看一下 https://rt-thread.github.io/rt-thread/page_howto_function.html 了解如何为函数写 doxygen 注释。
…functions
拉取/合并请求描述：(PR description)
[
为什么提交这份PR (why to submit this PR)
执行新手PR任务，为LIBC文件夹下的libc函数提供注释
你的解决方案是什么 (what is your solution)
查询mircosoft c++英文手册和询问deepseek，给 components/libc/compilers/armlibc/syscall_mem.c 中的所有libc函数编写了英文注释
请提供验证的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