mirror of
https://github.com/RT-Thread/rt-thread.git
synced 2025-12-05 15:15:29 +00:00
c40b79037c
* doxygen: add prefix for groups
Add "group_" prefix to doxygen group names. This makes
it easier to grep with group name later.
This patch only modifies the groups defined in the pathes
of INPUT of documentation/Doxyfile:
INPUT = . \
../src \
../include \
../components/finsh \
../components/drivers/include/drivers \
../components/drivers/clk \
../components/dfs/dfs_v2/src \
../components/dfs/dfs_v2/include
Other groups are not touched.
Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
* ci: fixed error report when run file_check.py
Such as:
- "please delete extra space at the end of this line."
- "the RT-Thread error code should return negative value. e.g. return
-RT_ERROR"
Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
---------
Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
20 lines
714 B
C
20 lines
714 B
C
/*
|
|
* This file is only used for doxygen document generation.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup group_finsh finsh shell
|
|
*
|
|
* @brief finsh shell is a user command shell in RT-Thread RTOS.
|
|
*
|
|
* finsh shell is a user command shell in RT-Thread RTOS, which is a shell can
|
|
* accept C-expression like syntax in command. From finsh shell, user can access
|
|
* system area, such as memory, variables and function by input C-expression in
|
|
* command.
|
|
*
|
|
* @image html finsh.png "Figure 3: finsh shell architecture"
|
|
* There is a shell thread, which named as "tshell", in the finsh shell, it read
|
|
* user command from console device, and then invokes system function or access
|
|
* system variable to output result (by rt_kprintf).
|
|
*/
|