doxygen: update doc for kenrel object model #10104
Merged
Conversation
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
Move the introduction of function parameters in markdown to source code comments, because this part of the content is completely repeated. We only need to keep and maintain the comments in the code. The detailed explanation of the API in markdown can directly refer to the comments in the code. Try not to directly copy the definition of the structure in the markdown document, because this part of the content may change with the upgrade of the code. Therefore, when the structure definition is involved in markdown, try to indicate that it is just a code snippet. The specific definition is still directly quoted from the source code and the source code comments. It is very convenient to quote structures and functions in markdown. Just use "`" to enclose the structure name or function name, and the generated html is a link to its definition. According to this principle, this patch only modifies the documents and code comments of the kernel object model. Other modules will be modified one by one in separate patches later. Signed-off-by: Chen Wang <[email protected]>
github-actions
bot
added
Doc
|
@1078249029 有空请看一下，以后 driver 那边的文档改进也可以参考这个原则进行。 |
Rbb666
approved these changes
Mar 12, 2025
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.
将 markdown 中对函数的参数的介绍移到源码注释中，因为这部分内容完全是重复的，我们只要保留并维护代码中的注释即可，markdown 中涉及 API 的详细解释可以直接引用代码中的注释。
尽量不在 markdown 文档中直接复制结构体的定义，因为这部分内容可能随着代码的升级而发生改动，所以 markdown 中涉及结构体定义时尽量注明这只是代码片段，具体的定义还是直接引用源码以及源码的注释。
markdown 中引用结构体和函数非常方便，只要用 “`" 将结构体名字或者函数名字括起来，生成的 html 就是指向其定义的链接。
按照这个原则，本补丁只是修改了 kernel object model 部分的文档和代码注释。其他模块以后另外提补丁逐个修改。
拉取/合并请求描述：(PR description)
[
为什么提交这份PR (why to submit this PR)
见 PR 描述。
你的解决方案是什么 (what is your solution)
请提供验证的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