Skip to content

Commit 65becf6

Browse files
authored
Merge pull request #7 from arduino-libraries/enum-docs
Add doxygen compatible documentation for enums
2 parents 0b31a61 + 0263aaf commit 65becf6

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/Arduino_POSIXStorage.h

+6-6
Original file line numberDiff line numberDiff line change
@@ -90,20 +90,20 @@
9090

9191
enum DeviceNames : uint8_t
9292
{
93-
DEV_SDCARD,
94-
DEV_USB
93+
DEV_SDCARD, ///< SD Card
94+
DEV_USB ///< USB Thumb Drive
9595
};
9696

9797
enum FileSystems : uint8_t
9898
{
99-
FS_FAT,
100-
FS_LITTLEFS
99+
FS_FAT, ///< FAT file system
100+
FS_LITTLEFS ///< LittleFS file system
101101
};
102102

103103
enum MountFlags : uint8_t
104104
{
105-
MNT_DEFAULT,
106-
MNT_RDONLY // Read only
105+
MNT_DEFAULT, ///< Default mount mode
106+
MNT_RDONLY ///< Read only mode
107107
};
108108

109109
/*

0 commit comments

Comments
 (0)