mirror of
https://github.com/RT-Thread/rt-thread.git
synced 2025-10-19 20:43:43 +08:00
40f3b6a569
* doxygen: adjust documentation directory structure - Rename documentation/doxygen to documentation/0.doxygen and cleanup some unused files. - Add/rename folders for each sub sections, such as 1.introduction/...... Each sub section will be created as a subpage. - Generate initial Doxyfile, this Doxyfile will be used to unify doxygen generated API documents and those markdown files under documentation folder. This patch just add the default Doxyfile generated by running "doxygen -g". It is used as baseline to add more features/configurations. - Rename documentation/README.md to documentation/INDEX.md, and use it as mainpage. - Move 0.doxygen/readme.md to documentation/README.md. * doxygen: update configurations These configurations are from old documentation/doxygen/Doxyfile. Try best to compatible exixting design. * doxygen: add run script Add a script to automatic some operations. Updated the README.md. --------- Signed-off-by: Chen Wang <unicorn_wang@outlook.com> Co-authored-by: Supper Thomas <78900636@qq.com>
20 lines
708 B
C
20 lines
708 B
C
/*
|
|
* This file is only used for doxygen document generation.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup 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).
|
|
*/
|