Reviewed the code comments in the Include/Protocol directory for typos, grammar issue...

[mirror_edk2.git] / MdePkg / Include / Protocol / SimpleFileSystem.h

diff --git a/MdePkg/Include/Protocol/SimpleFileSystem.h b/MdePkg/Include/Protocol/SimpleFileSystem.h
index eb850be94f50c0e54ce4d0f2174cba617a9de11a..07332351808f9f445ae65ea540e6b6cdd7ab3f11 100644 (file)
--- a/MdePkg/Include/Protocol/SimpleFileSystem.h
+++ b/MdePkg/Include/Protocol/SimpleFileSystem.h
@@ -1,11 +1,11 @@
 /** @file\r
   SimpleFileSystem protocol as defined in the UEFI 2.0 specification.\r
 \r
-  The SimpleFileSystem protocol is the programatic access to the FAT (12,16,32) \r
+  The SimpleFileSystem protocol is the programmatic access to the FAT (12,16,32) \r
   file system specified in UEFI 2.0. It can also be used to abstract a file  \r
   system other than FAT.\r
 \r
-  UEFI 2.0 can boot from any valid EFI image contained in a SimpleFileSystem\r
+  UEFI 2.0 can boot from any valid EFI image contained in a SimpleFileSystem.\r
 \r
   Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
@@ -31,14 +31,13 @@ typedef struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL  EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
 typedef struct _EFI_FILE_PROTOCOL         EFI_FILE_PROTOCOL;\r
 typedef struct _EFI_FILE_PROTOCOL         *EFI_FILE_HANDLE;\r
 \r
-\r
 ///\r
-/// Protocol GUID defined in EFI1.1.\r
+/// Protocol GUID name defined in EFI1.1.\r
 /// \r
 #define SIMPLE_FILE_SYSTEM_PROTOCOL       EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID\r
 \r
 ///\r
-/// Protocol defined in EFI1.1.\r
+/// Protocol name defined in EFI1.1.\r
 /// \r
 typedef EFI_SIMPLE_FILE_SYSTEM_PROTOCOL   EFI_FILE_IO_INTERFACE;\r
 typedef struct _EFI_FILE_PROTOCOL         EFI_FILE;\r
@@ -66,12 +65,18 @@ EFI_STATUS
   );\r
 \r
 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION  0x00010000\r
+\r
 ///\r
 /// Revision defined in EFI1.1\r
 /// \r
 #define EFI_FILE_IO_INTERFACE_REVISION  EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION\r
 \r
 struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL {\r
+  ///\r
+  /// The version of the EFI_SIMPLE_FILE_SYSTEM_PROTOCOL. The version\r
+  /// specified by this specification is 0x00010000. All future revisions\r
+  /// must be backwards compatible.\r
+  ///\r
   UINT64                                      Revision;\r
   EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_OPEN_VOLUME OpenVolume;\r
 };\r
@@ -176,11 +181,11 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Write data from to the file.\r
+  Write data from or to the file.\r
 \r
   @param  This       Protocol instance pointer.\r
-  @param  BufferSize On input size of buffer, on output amount of data in buffer.\r
-  @param  Buffer     The buffer in which data to write.\r
+  @param  BufferSize On input: size of buffer. On output: amount of data in buffer.\r
+  @param  Buffer     The buffer in which to write data.\r
 \r
   @retval EFI_SUCCESS          Data was written.\r
   @retval EFI_UNSUPPORT        Writes to Open directory are not supported\r
@@ -204,7 +209,7 @@ EFI_STATUS
   Set a files current position\r
 \r
   @param  This            Protocol instance pointer.\r
-  @param  Position        Byte possition from the start of the file\r
+  @param  Position        Byte position, from the start of the file\r
                           \r
   @retval EFI_SUCCESS     Data was written.\r
   @retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open.\r
@@ -218,10 +223,10 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Get a files current position\r
+  Get a file's current position\r
 \r
   @param  This            Protocol instance pointer.\r
-  @param  Position        Byte possition from the start of the file\r
+  @param  Position        Byte position, from the start of the file\r
                           \r
   @retval EFI_SUCCESS     Data was written.\r
   @retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open.\r
@@ -239,7 +244,7 @@ EFI_STATUS
 \r
   @param  This            Protocol instance pointer.\r
   @param  InformationType Type of info to return in Buffer\r
-  @param  BufferSize      On input size of buffer, on output amount of data in buffer.\r
+  @param  BufferSize      On input: size of buffer. On output: amount of data in buffer.\r
   @param  Buffer          The buffer to return data.\r
 \r
   @retval EFI_SUCCESS          Data was returned.\r