xref: /nrf52832-nimble/rt-thread/documentation/doxygen/filesystem.h (revision 104654410c56c573564690304ae786df310c91fc)
1 /*
2  * This file is only used for doxygen document generation.
3  */
4 
5 /**
6  * @defgroup DFS Device Virtual File System
7  *
8  * @brief DFS is a virtual file system in RT-Thread RTOS.
9  *
10  * The DFS (Device Virtual File System) is a vfs file system of RT-Thread RTOS,
11  * which is focused on embedded device. VFS is an abstraction layer on top of a
12  * more concrete file system. The purpose of a VFS is to allow client applications
13  * to access different types of concrete file systems in a uniform way.
14  *
15  * @image html dfs.png "Figure 4: Device Virtual File System Architecture"
16  *
17  * The DFS specifies an interface between the kernel and a concrete file system.
18  * Therefore, it is easy to add support for new file system types to the kernel
19  * simply by fulfilling the interface.
20  */
21 
22 /**
23  * @addtogroup DFS
24  */
25 /*@{*/
26 
27 /**
28  * @defgroup Fd File Descriptor
29  *
30  */
31 
32 /**
33  * @defgroup FsApi File System API
34  */
35 
36 /**
37  * @defgroup FileApi File API
38  */
39 
40 /**
41  * @defgroup FsPosixApi File POSIX API
42  */
43 
44 /*@}*/
45