mirror of https://github.com/RT-Thread/rt-thread
5a42cfd16b
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 <unicorn_wang@outlook.com> |
||
|---|---|---|
| .. | ||
| basic | ||
| interrupt | ||
| kernel-porting | ||
| memory | ||
| thread | ||
| thread-comm | ||
| thread-sync | ||
| timer | ||
| INDEX.md | ||