Skip to content

Commit ee74181

Browse files
committed
Add missing documentation for enums
1 parent 6d99aa3 commit ee74181

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/Arduino_POSIXStorage.h

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,21 +88,24 @@
8888
*********************************************************************************************************
8989
*/
9090

91+
/// @brief Enum to select the storage device to use.
9192
enum StorageDevices : uint8_t
9293
{
9394
DEV_SDCARD, ///< SD Card
9495
DEV_USB ///< USB Thumb Drive
9596
};
9697

98+
/// @brief Enum to select the file system to use.
9799
enum FileSystems : uint8_t
98100
{
99101
FS_FAT, ///< FAT file system
100102
FS_LITTLEFS ///< LittleFS file system
101103
};
102104

105+
/// @brief Enum to select the mount mode to use. The default mode is Read/Write.
103106
enum MountFlags : uint8_t
104107
{
105-
MNT_DEFAULT, ///< Default mount mode
108+
MNT_DEFAULT, ///< Default mount mode (Read/Write)
106109
MNT_RDONLY ///< Read only mode
107110
};
108111

0 commit comments

Comments
 (0)