ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Move inline code snippets to code blocks

pull/8462/head
Kevin Gilbert 2018-10-17 17:26:39 -05:00 committed by kegilbert
parent fc41c3d8e3
commit 6b3bf28d0d
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
platform/DirHandle.h
View File

@ -35,12 +35,18 @@ namespace mbed {
* but only a subset needs to be provided.
*
* If a FileSystemLike class defines the opendir method, then the
* directories of an object of that type can be accessed by
* DIR *d = opendir("/example/directory") (or opendir("/example")
* to open the root of the filesystem), and then using readdir(d) etc.
* directories of an object of that type can be accessed by either:
* @code
* DIR *d = opendir("/example/directory");
* @endcode
* or
* @code
* DIR *d = opendir("/example");
* @endcode
* to open the root of the file system.
*
* The root directory is considered to contain all FileHandle and
* FileSystem objects, so the DIR* returned by opendir("/") will
* FileSystem objects, so the DIR pointer returned by opendir("/") will
* reflect this.
*
* @note to create a directory, @see Dir