Skip to content

Commit 30cc457

Browse files
committed
Add space between each member in docs
1 parent 7ff6486 commit 30cc457

File tree

1 file changed

+49
-8
lines changed

1 file changed

+49
-8
lines changed

docs/api.md

Lines changed: 49 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,56 @@
22

33
Members | Descriptions
44
--------------------------------|---------------------------------------------
5+
`define ` [`PATH_MAX`](#_types_8h_1ae688d728e1acdfe5988c7db45d6f0166) |
6+
`enum ` [`FileMode`](#_types_8h_1a031770da453a180e21dcbef5cf5aeab6) |
7+
`public static bool ` [`copyFolder`](#_types_8h_1ae376909a80f5f275a87d98a4d04379b3)`(const char * source, const char * destination)` |
8+
`public static std::string ` [`replaceLastPathComponent`](#_types_8h_1a1231b36e02c6532fe382bd77c07ac933)`(const std::string & path, const std::string & newComponent)` |
9+
`public static std::string ` [`getLastPathComponent`](#_types_8h_1aef7f02955007c4af74bc4539be935ed9)`(const std::string & path)` |
10+
`public static std::string ` [`replaceFirstPathComponent`](#_types_8h_1ae04577d71725c561b6a741435bed465a)`(const std::string & path, const std::string & destinationPath)` |
11+
`public inline static String ` [`getErrno`](#_types_8h_1a6f2ca9f121d182e6715776886b08ace5)`()` |
512
`class ` [`Arduino_UnifiedStorage`](#class_arduino___unified_storage) | Abstract class representing the common features of the supported storage methods
613
`class ` [`Folder`](#class_folder) | Class representing a directory.
714
`class ` [`InternalStorage`](#class_internal_storage) | Represents internal storage using the Arduino Unified Storage library.
815
`class ` [`SDStorage`](#class_s_d_storage) | Represents an SD card storage using the Arduino Unified Storage library.
916
`class ` [`UFile`](#class_u_file) | Class representing a File
1017
`class ` [`USBStorage`](#class_u_s_b_storage) | Represents a USB storage using the Arduino Unified Storage library.
1118

19+
## Members
20+
21+
#### `define ` [`PATH_MAX`](#_types_8h_1ae688d728e1acdfe5988c7db45d6f0166) <a id="_types_8h_1ae688d728e1acdfe5988c7db45d6f0166" class="anchor"></a>
22+
23+
<hr />
24+
25+
#### `enum ` [`FileMode`](#_types_8h_1a031770da453a180e21dcbef5cf5aeab6) <a id="_types_8h_1a031770da453a180e21dcbef5cf5aeab6" class="anchor"></a>
26+
27+
Values | Descriptions
28+
--------------------------------|---------------------------------------------
29+
READ |
30+
WRITE |
31+
APPEND |
32+
33+
<hr />
34+
35+
#### `public static bool ` [`copyFolder`](#_types_8h_1ae376909a80f5f275a87d98a4d04379b3)`(const char * source, const char * destination)` <a id="_types_8h_1ae376909a80f5f275a87d98a4d04379b3" class="anchor"></a>
36+
37+
<hr />
38+
39+
#### `public static std::string ` [`replaceLastPathComponent`](#_types_8h_1a1231b36e02c6532fe382bd77c07ac933)`(const std::string & path, const std::string & newComponent)` <a id="_types_8h_1a1231b36e02c6532fe382bd77c07ac933" class="anchor"></a>
40+
41+
<hr />
42+
43+
#### `public static std::string ` [`getLastPathComponent`](#_types_8h_1aef7f02955007c4af74bc4539be935ed9)`(const std::string & path)` <a id="_types_8h_1aef7f02955007c4af74bc4539be935ed9" class="anchor"></a>
44+
45+
<hr />
46+
47+
#### `public static std::string ` [`replaceFirstPathComponent`](#_types_8h_1ae04577d71725c561b6a741435bed465a)`(const std::string & path, const std::string & destinationPath)` <a id="_types_8h_1ae04577d71725c561b6a741435bed465a" class="anchor"></a>
48+
49+
<hr />
50+
51+
#### `public inline static String ` [`getErrno`](#_types_8h_1a6f2ca9f121d182e6715776886b08ace5)`()` <a id="_types_8h_1a6f2ca9f121d182e6715776886b08ace5" class="anchor"></a>
52+
53+
<hr />
54+
1255
# class `Arduino_UnifiedStorage` <a id="class_arduino___unified_storage" class="anchor"></a>
1356

1457
Abstract class representing the common features of the supported storage methods
@@ -88,8 +131,8 @@ Class representing a directory.
88131
`public String ` [`getPathString`](#class_folder_1a30dd952da8ae977dca4e3dfde8fbd5be)`()` | Returns the path of the file.
89132
`public ` [`Folder`](#class_folder)` ` [`createSubfolder`](#class_folder_1a78f2f9b297f62b67c2e0656b15a95868)`(const char * subfolderName, bool overwrite)` | Creates a subfolder in the directory.
90133
`public ` [`Folder`](#class_folder)` ` [`createSubfolder`](#class_folder_1ab50743664becb7b2a1fb564b5513d69c)`(String subfolderName, bool overwrite)` | Creates a subfolder in the directory.
91-
`public std::vector< ` [`UFile`](#class_u_file)` > ` [`getFiles`](#class_folder_1a3c2e01e19b48e3aa709cbdbb0acbdd78)`()` | Returns File objects for all files in the current directory.
92-
`public std::vector< ` [`Folder`](#class_folder)` > ` [`getFolders`](#class_folder_1a69d3df42dacbd1d64d0f527e090f1fbb)`()` | Returns [Folder](#class_folder) objects for all files in the current directory.
134+
`public std::vector< ` [`UFile`](#class_u_file)` > ` [`getFiles`](#class_folder_1a3c2e01e19b48e3aa709cbdbb0acbdd78)`()` | Returns File objects for all files in the current dirctory.
135+
`public std::vector< ` [`Folder`](#class_folder)` > ` [`getFolders`](#class_folder_1a69d3df42dacbd1d64d0f527e090f1fbb)`()` | Returns [Folder](#class_folder) objects for all files in the current dirctory.
93136
`public bool ` [`copyTo`](#class_folder_1aabf0818b7ee45b2d871e82e86edb4ebd)`(` [`Folder`](#class_folder)` destination, bool overwrite)` | Copies the current directory.
94137
`public bool ` [`copyTo`](#class_folder_1a058d193f53c559eefe343b30797500eb)`(const char * destination, bool overwrite)` | Copies the current directory.
95138
`public bool ` [`copyTo`](#class_folder_1a3162979e4c679c7f5503cc4584949714)`(String destination, bool overwrite)` | Copies the current directory.
@@ -128,7 +171,7 @@ Creates a file inside the directory.
128171
* `const` char * fileName - The name of the file to create.
129172

130173
#### Returns
131-
A File object if successful, NULL if not.
174+
A File object if successfull, NULL if not.
132175

133176
### `public ` [`UFile`](#class_u_file)` ` [`createFile`](#class_folder_1a44255e2c0c4ffa37d7637a601bc590f6)`(String fileName, FileMode fmode)` <a id="class_folder_1a44255e2c0c4ffa37d7637a601bc590f6" class="anchor"></a>
134177

@@ -138,7 +181,7 @@ Creates a file inside the directory.
138181
* `String` fileName - The name of the file to create.
139182

140183
#### Returns
141-
A File object if successful, NULL if not.
184+
A File object if successfull, NULL if not.
142185

143186
### `public bool ` [`remove`](#class_folder_1aca893daac6c6747895d50987cf9cf34c)`()` <a id="class_folder_1aca893daac6c6747895d50987cf9cf34c" class="anchor"></a>
144187

@@ -217,14 +260,14 @@ The created subfolder.
217260

218261
### `public std::vector< ` [`UFile`](#class_u_file)` > ` [`getFiles`](#class_folder_1a3c2e01e19b48e3aa709cbdbb0acbdd78)`()` <a id="class_folder_1a3c2e01e19b48e3aa709cbdbb0acbdd78" class="anchor"></a>
219262

220-
Returns File objects for all files in the current directory.
263+
Returns File objects for all files in the current dirctory.
221264

222265
#### Returns
223266
A std::vector of File objects representing the files in the directory.
224267

225268
### `public std::vector< ` [`Folder`](#class_folder)` > ` [`getFolders`](#class_folder_1a69d3df42dacbd1d64d0f527e090f1fbb)`()` <a id="class_folder_1a69d3df42dacbd1d64d0f527e090f1fbb" class="anchor"></a>
226269

227-
Returns [Folder](#class_folder) objects for all files in the current directory.
270+
Returns [Folder](#class_folder) objects for all files in the current dirctory.
228271

229272
#### Returns
230273
A std::vector of [Folder](#class_folder) objects representing the files in the directory.
@@ -884,5 +927,3 @@ Checks the USB storage connection status.
884927
### `private unsigned long ` [`previousMillis`](#class_u_s_b_storage_1a1421967255a94a2f4be67a5e37017307) <a id="class_u_s_b_storage_1a1421967255a94a2f4be67a5e37017307" class="anchor"></a>
885928

886929
### `private int ` [`interval`](#class_u_s_b_storage_1aecbd90e5183fd2dc86d98725d1577444) <a id="class_u_s_b_storage_1aecbd90e5183fd2dc86d98725d1577444" class="anchor"></a>
887-
888-
Generated by [Moxygen](https://github.com/sourcey/moxygen)

0 commit comments

Comments
 (0)