mirror of
https://github.com/RT-Thread/rt-thread.git
synced 2025-10-21 15:41:41 +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>
45 lines
997 B
C
45 lines
997 B
C
/*
|
|
* This file is only used for doxygen document generation.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup DFS Device Virtual File System
|
|
*
|
|
* @brief DFS is a virtual file system in RT-Thread RTOS.
|
|
*
|
|
* The DFS (Device Virtual File System) is a vfs file system of RT-Thread RTOS,
|
|
* which is focused on embedded device. VFS is an abstraction layer on top of a
|
|
* more concrete file system. The purpose of a VFS is to allow client applications
|
|
* to access different types of concrete file systems in a uniform way.
|
|
*
|
|
* @image html dfs.png "Figure 4: Device Virtual File System Architecture"
|
|
*
|
|
* The DFS specifies an interface between the kernel and a concrete file system.
|
|
* Therefore, it is easy to add support for new file system types to the kernel
|
|
* simply by fulfilling the interface.
|
|
*/
|
|
|
|
/**
|
|
* @addtogroup DFS
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @defgroup Fd File Descriptor
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* @defgroup FsApi File System API
|
|
*/
|
|
|
|
/**
|
|
* @defgroup FileApi File API
|
|
*/
|
|
|
|
/**
|
|
* @defgroup FsPosixApi File POSIX API
|
|
*/
|
|
|
|
/**@}*/
|