Skip to content

Commit db31a62

Browse files
more javadoc fixes
1 parent c0877ec commit db31a62

File tree

3 files changed

+38
-4
lines changed

3 files changed

+38
-4
lines changed

src/Arduino_UnifiedStorage.h

+31
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,49 @@
2525
#include "FATFileSystem.h"
2626
#endif
2727

28+
29+
/**
30+
* Abstract class representing the common features of the supported storage methods
31+
*/
2832
class Arduino_UnifiedStorage {
2933
public:
34+
/**
35+
* Initializes the storage.
36+
*
37+
* @return 1 if successful, 0 if failed.
38+
*/
3039
virtual int begin() = 0;
3140

41+
/**
42+
* Initializes the storage with the specified file system.
43+
* @param fs The desired file system (FS_FAT or FS_LITTLEFS).
44+
* @return 1 if successful, 0 if failed.
45+
*/
3246
virtual int begin(FileSystems fs) = 0;
3347

48+
/**
49+
* Unmounts the storage.
50+
* @return 1 if successful, 0 if failed.
51+
*/
3452
virtual int unmount() = 0;
3553

54+
/**
55+
* Retrieves the root folder of the storage.
56+
* @return The root folder as a Folder object.
57+
*/
3658
virtual Folder getRootFolder() = 0;
3759

60+
/**
61+
* Formats the storage with the FAT file system.
62+
* @return 1 if successful, 0 if failed.
63+
*/
3864
virtual int formatLittleFS() = 0;
3965

66+
/**
67+
* Formats the storage with the FAT file system.
68+
*
69+
* @return 1 if successful, 0 if failed.
70+
*/
4071
virtual int formatFAT() = 0;
4172
};
4273

src/UFile.h

+3-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ class Folder;
1111

1212

1313

14-
14+
/**
15+
* Class representing a File
16+
*/
1517
class UFile{
1618
public:
1719

src/USBStorage.h

+4-3
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@
33
#ifndef USBStorage_H
44
#define USBStorage_H
55

6-
/**
7-
* Represents USB storage using the Arduino Unified Storage library.
8-
*/
6+
97
static bool usb_available = false;
108

9+
/**
10+
* Represents a USB storage using the Arduino Unified Storage library.
11+
*/
1112
class USBStorage : public Arduino_UnifiedStorage {
1213
public:
1314

0 commit comments

Comments
 (0)