Skip to content

Commit 17c3581

Browse files
committed
Update code documentation after changing return type to bool
1 parent 27605d7 commit 17c3581

File tree

4 files changed

+16
-16
lines changed

4 files changed

+16
-16
lines changed

src/Arduino_UnifiedStorage.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,20 +34,20 @@ class Arduino_UnifiedStorage {
3434
/**
3535
* Initializes the storage.
3636
*
37-
* @return 1 if successful, 0 if failed.
37+
* @return true if successful, false if failed.
3838
*/
3939
virtual bool begin() = 0;
4040

4141
/**
4242
* Initializes the storage with the specified file system.
4343
* @param fs The desired file system (FS_FAT or FS_LITTLEFS).
44-
* @return 1 if successful, 0 if failed.
44+
* @return true if successful, false if failed.
4545
*/
4646
virtual bool begin(FileSystems fs) = 0;
4747

4848
/**
4949
* Unmounts the storage.
50-
* @return 1 if successful, 0 if failed.
50+
* @return true if successful, false if failed.
5151
*/
5252
virtual bool unmount() = 0;
5353

@@ -59,7 +59,7 @@ class Arduino_UnifiedStorage {
5959

6060
/**
6161
* Formats the storage with the selected file system.
62-
* @return 1 if successful, 0 if failed.
62+
* @return true if successful, false if failed.
6363
*/
6464
virtual bool format(FileSystems fs) = 0;
6565

src/InternalStorage.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,22 +25,22 @@ class InternalStorage : public Arduino_UnifiedStorage {
2525
/**
2626
* Initializes the internal storage.
2727
*
28-
* @return 1 if successful, 0 if failed.
28+
* @return true if successful, false if failed.
2929
*/
3030
bool begin() override;
3131

3232
/**
3333
* Initializes the internal storage with the specified file system.
3434
*
3535
* @param fs The desired file system (FS_FAT or FS_LITTLEFS).
36-
* @return 1 if successful, 0 if failed.
36+
* @return true if successful, false if failed.
3737
*/
3838
bool begin(FileSystems fs) override;
3939

4040
/**
4141
* Unmounts the internal storage.
4242
*
43-
* @return 1 if successful, 0 if failed.
43+
* @return true if successful, false if failed.
4444
*/
4545
bool unmount() override;
4646

@@ -68,7 +68,7 @@ class InternalStorage : public Arduino_UnifiedStorage {
6868
/**
6969
* Formats the internal storage with the selceted file system.
7070
*
71-
* @return 1 if successful, 0 if failed.
71+
* @return true if successful, false if failed.
7272
*/
7373
bool format(FileSystems fs) override;
7474

src/SDStorage.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,22 @@ class SDStorage: public Arduino_UnifiedStorage {
2020
/**
2121
* Initializes the SD card storage.
2222
*
23-
* @return 1 if successful, 0 if failed.
23+
* @return true if successful, false if failed.
2424
*/
2525
bool begin() override ;
2626

2727
/**
2828
* Initializes the SD card storage with the specified file system.
2929
*
3030
* @param fs The desired file system (FS_FAT or FS_LITTLEFS).
31-
* @return 1 if successful, 0 if failed.
31+
* @return true if successful, false if failed.
3232
*/
3333
bool begin(FileSystems fs) override;
3434

3535
/**
3636
* Unmounts the SD card storage.
3737
*
38-
* @return 1 if successful, 0 if failed.
38+
* @return true if successful, false if failed.
3939
*/
4040
bool unmount() override;
4141

@@ -49,7 +49,7 @@ class SDStorage: public Arduino_UnifiedStorage {
4949
/**
5050
* Formats the SD card storage with the selected file system.
5151
*
52-
* @return 1 if successful, 0 if failed.
52+
* @return true if successful, false if failed.
5353
*/
5454
bool format(FileSystems fs) override;
5555

src/USBStorage.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,22 +17,22 @@ class USBStorage : public Arduino_UnifiedStorage {
1717
/**
1818
* Initializes the USB storage.
1919
*
20-
* @return 1 if successful, 0 if failed.
20+
* @return true if successful, false if failed.
2121
*/
2222
bool begin() override;
2323

2424
/**
2525
* Initializes the USB storage with the specified file system.
2626
*
2727
* @param fs The desired file system (FS_FAT or FS_LITTLEFS).
28-
* @return 1 if successful, 0 if failed.
28+
* @return true if successful, false if failed.
2929
*/
3030
bool begin(FileSystems fs) override;
3131

3232
/**
3333
* Unmounts the USB storage.
3434
*
35-
* @return 1 if successful, 0 if failed.
35+
* @return true if successful, false if failed.
3636
*/
3737
bool unmount() override;
3838

@@ -46,7 +46,7 @@ class USBStorage : public Arduino_UnifiedStorage {
4646
/**
4747
* Formats the USB storage with the selected file system.
4848
*
49-
* @return 1 if successful, 0 if failed.
49+
* @return true if successful, false if failed.
5050
*/
5151
bool format(FileSystems fs) override;
5252

0 commit comments

Comments
 (0)