xref: /nrf52832-nimble/rt-thread/documentation/doxygen/finsh.h (revision 167494296f0543431a51b6b1b83e957045294e05)
1 /*
2  * This file is only used for doxygen document generation.
3  */
4 
5 /**
6  * @defgroup finsh finsh shell
7  *
8  * @brief finsh shell is a user command shell in RT-Thread RTOS.
9  *
10  * finsh shell is a user command shell in RT-Thread RTOS, which is a shell can
11  * accept C-expression like syntax in command. From finsh shell, user can access
12  * system area, such as memory, variables and function by input C-expression in
13  * command.
14  *
15  * @image html finsh.png "Figure 3: finsh shell architecture"
16  * There is a shell thread, which named as "tshell", in the finsh shell, it read
17  * user command from console device, and then invokes system function or access
18  * system variable to output result (by rt_kprintf).
19  */
20