mirror of
https://github.com/RT-Thread/rt-thread.git
synced 2025-10-19 03:13:34 +08: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>
45 lines
1.0 KiB
C
45 lines
1.0 KiB
C
/*
|
|
* This file is only used for doxygen document generation.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup group_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 group_DFS
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @defgroup group_Fd File Descriptor
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* @defgroup group_FsApi File System API
|
|
*/
|
|
|
|
/**
|
|
* @defgroup group_FileApi File API
|
|
*/
|
|
|
|
/**
|
|
* @defgroup group_FsPosixApi File POSIX API
|
|
*/
|
|
|
|
/**@}*/
|