rt-thread/documentation/3.kernel/basic
Chen Wang 5a42cfd16b 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 <unicorn_wang@outlook.com>
2025-03-12 12:54:25 +08:00
..
figures doxygen: reorganize directory structure 2025-02-25 11:27:58 +08:00
basic.md doxygen: update doc for kenrel object model 2025-03-12 12:54:25 +08:00