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

Edit DirHandle.h 

Edit for active voice.
pull/8462/head
Amanda Butler 2018-10-18 11:11:03 -05:00 committed by GitHub
parent 7d604fedf8
commit 1f9ef36483
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
platform/DirHandle.h
View File

@ -30,12 +30,12 @@ namespace mbed {
*/
/** Represents a directory stream. Objects of this type are returned
* by an opendir function. The core functions are read and seek,
/** Represents a directory stream. An opendir function returns
* objects of this type. The core functions are read and seek,
* 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 either:
* If a FileSystemLike class defines the opendir method, then you
* can access the directories of an object of that type by either:
* @code
* DIR *d = opendir("/example/directory");
* @endcode
@ -46,8 +46,8 @@ namespace mbed {
* to open the root of the file system.
*
* The root directory is considered to contain all FileHandle and
* FileSystem objects, so the DIR pointer returned by opendir("/") will
* reflect this.
* FileSystem objects, so the DIR pointer returned by opendir("/")
* reflects this.
*
* @note to create a directory, @see Dir
* @note Synchronization level: Set by subclass