[kernel]add doxygen comments for scheduler.#10366
Merged
supperthomas merged 2 commits intoRT-Thread:masterfrom Jun 8, 2025
Merged
[kernel]add doxygen comments for scheduler.#10366supperthomas merged 2 commits intoRT-Thread:masterfrom
supperthomas merged 2 commits intoRT-Thread:masterfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive Doxygen comments to various scheduler-related functions across single-core and multi-core files, improving code documentation and clarity. Key changes include:
- Adding Doxygen comments for scheduler locking/unlocking functions.
- Enhancing documentation of thread initialization, scheduling, and critical section handling.
- Updating copyright years to 2025.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/scheduler_up.c | Added Doxygen-style comments to scheduler functions for UP systems. |
| src/scheduler_mp.c | Added detailed Doxygen comments for scheduler functions in SMP. |
| src/scheduler_comm.c | Added comprehensive Doxygen comments for common scheduler APIs. |
Comments suppressed due to low confidence (1)
src/scheduler_comm.c:140
- Please correct the spelling mistake: replace 'unecessary' with 'unnecessary'.
/* read only fields, so lock is unecessary */
unicornx
approved these changes
Jun 5, 2025
supperthomas
approved these changes
Jun 8, 2025
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
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.
拉取/合并请求描述:(PR description)
[
为什么提交这份PR (why to submit this PR)
完善内核scheduler部分的doxygen注释。
你的解决方案是什么 (what is your solution)
补充内核scheduler部分的doxygen注释。
请提供验证的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