From 6b3bf28d0d54fd377ed7c61b1e500d99685be5ec Mon Sep 17 00:00:00 2001 From: Kevin Gilbert Date: Wed, 17 Oct 2018 17:26:39 -0500 Subject: [PATCH 1/3] Move inline code snippets to code blocks --- platform/DirHandle.h | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/platform/DirHandle.h b/platform/DirHandle.h index d0b04d04f2..f61937df81 100644 --- a/platform/DirHandle.h +++ b/platform/DirHandle.h @@ -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 From 7d604fedf8ff1e0056258293cf174fd91000f2b6 Mon Sep 17 00:00:00 2001 From: Amanda Butler Date: Wed, 17 Oct 2018 17:41:27 -0500 Subject: [PATCH 2/3] Fix typo in DirHandle.md Add "s" for agreement. --- platform/DirHandle.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/platform/DirHandle.h b/platform/DirHandle.h index f61937df81..2c6cf2fb15 100644 --- a/platform/DirHandle.h +++ b/platform/DirHandle.h @@ -119,7 +119,7 @@ public: return close(); }; - /** Return the directory entry at the current position, and + /** Returns the directory entry at the current position, and * advances the position to the next entry. * * @returns From 1f9ef364835eef2a37cbad3c6e5db23357adee89 Mon Sep 17 00:00:00 2001 From: Amanda Butler Date: Thu, 18 Oct 2018 11:11:03 -0500 Subject: [PATCH 3/3] Edit DirHandle.h Edit for active voice. --- platform/DirHandle.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/platform/DirHandle.h b/platform/DirHandle.h index 2c6cf2fb15..d40300e360 100644 --- a/platform/DirHandle.h +++ b/platform/DirHandle.h @@ -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