summaryrefslogtreecommitdiff
path: root/src/SConscript
diff options
context:
space:
mode:
authorChen Wang <[email protected]>2025-03-12 11:00:32 +0800
committerRbb666 <[email protected]>2025-03-12 12:54:25 +0800
commit5a42cfd16b62cd5482af5007dff56c38aad76732 (patch)
treea40f6a21999ec0afd9b337273dc1e9f3e1df681d /src/SConscript
parent5a09694f05b3882a1e22cb4cbabdf8d4d031c4ec (diff)
doxygen: update doc for kenrel object model
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]>
Diffstat (limited to 'src/SConscript')
0 files changed, 0 insertions, 0 deletions