Skip to content

Commit 27a8ebf

Browse files
author
Alrik Vidstrom
committed
Change DeviceNames enum to StorageDevices in documentation
1 parent 5a5b90b commit 27a8ebf

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Start pathnames on SD Cards with "/sdcard/" and pathnames on USB thumb drives wi
4343

4444
The following are additional functions provided by the library:
4545

46-
### `int` [`mount`](#)`(enum DeviceNames deviceName, enum FileSystems fileSystem, enum MountFlags mountFlags)`
46+
### `int` [`mount`](#)`(enum StorageDevices deviceName, enum FileSystems fileSystem, enum MountFlags mountFlags)`
4747

4848
Attach a file system to a device.
4949

@@ -56,7 +56,7 @@ Attach a file system to a device.
5656
On success: 0. On failure: -1 with an error code in the errno variable.
5757

5858

59-
### `int` [`umount`](#)`(enum DeviceNames deviceName)`
59+
### `int` [`umount`](#)`(enum StorageDevices deviceName)`
6060

6161
Remove the attached file system from a device.
6262

@@ -67,7 +67,7 @@ Remove the attached file system from a device.
6767
On success: 0. On failure: -1 with an error code in the errno variable.
6868

6969

70-
### `int` [`register_hotplug_callback`](#)`(enum DeviceNames deviceName, void (*callbackFunction)())`
70+
### `int` [`register_hotplug_callback`](#)`(enum StorageDevices deviceName, void (*callbackFunction)())`
7171

7272
Register a hotplug callback function. Currently only supported for DEV_USB on Portenta C33.
7373

@@ -79,7 +79,7 @@ Register a hotplug callback function. Currently only supported for DEV_USB on Po
7979
On success: 0. On failure: -1 with an error code in the errno variable.
8080

8181

82-
### `int` [`deregister_hotplug_callback`](#)`(enum DeviceNames deviceName)`
82+
### `int` [`deregister_hotplug_callback`](#)`(enum StorageDevices deviceName)`
8383

8484
Deregister a previously registered hotplug callback function. Not currently supported on any platform.
8585

@@ -90,7 +90,7 @@ Deregister a previously registered hotplug callback function. Not currently supp
9090
On success: 0. On failure: -1 with an error code in the errno variable.
9191

9292

93-
### `int` [`mkfs`](#)`(enum DeviceNames deviceName, enum FileSystems fileSystem)`
93+
### `int` [`mkfs`](#)`(enum StorageDevices deviceName, enum FileSystems fileSystem)`
9494

9595
Format a device (make file system).
9696

0 commit comments

Comments
 (0)