Add the detailed descriptions for the structure data member in these protocol.

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

diff --git a/MdePkg/Include/Protocol/SimpleFileSystem.h b/MdePkg/Include/Protocol/SimpleFileSystem.h
index bea935977762ccb1b9bf9595b4f757369b197b6f..ddfbebb80c598bdb97a5fdc36b1dfd9fbd02fe1e 100644 (file)
--- a/MdePkg/Include/Protocol/SimpleFileSystem.h
+++ b/MdePkg/Include/Protocol/SimpleFileSystem.h
@@ -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
@@ -314,50 +319,19 @@ EFI_STATUS
 // \r
 #define EFI_FILE_REVISION   EFI_FILE_PROTOCOL_REVISION\r
 \r
-/**  \r
-  @par Protocol Description:\r
-  The EFI_FILE_PROTOCOL provides file IO access to supported file systems.\r
-  An EFI_FILE_PROTOCOL provides access to a file's or directory's contents, \r
-  and is also a reference to a location in the directory tree of the file system \r
-  in which the file resides. With any given file handle, other files may be opened \r
-  relative to this file's location, yielding new file handles.\r
-\r
-  @param Revision\r
-  The version of the EFI_FILE_PROTOCOL interface. The version specified \r
-  by this specification is 0x00010000. Future versions are required \r
-  to be backward compatible to version 1.0.\r
-\r
-  @param Open\r
-  Opens or creates a new file. \r
-\r
-  @param Close\r
-  Closes the current file handle. \r
-\r
-  @param Delete\r
-  Deletes a file. \r
-\r
-  @param Read\r
-  Reads bytes from a file. \r
-\r
-  @param Write\r
-  Writes bytes to a file. \r
-\r
-  @param GetPosition\r
-  Returns the current file position. \r
-\r
-  @param SetPosition\r
-  Sets the current file position. \r
-\r
-  @param GetInfo\r
-  Gets the requested file or volume information. \r
-\r
-  @param SetInfo\r
-  Sets the requested file information. \r
-\r
-  @param Flush\r
-  Flushes all modified data associated with the file to the device. \r
-**/\r
+///\r
+/// The EFI_FILE_PROTOCOL provides file IO access to supported file systems.\r
+/// An EFI_FILE_PROTOCOL provides access to a file's or directory's contents, \r
+/// and is also a reference to a location in the directory tree of the file system \r
+/// in which the file resides. With any given file handle, other files may be opened \r
+/// relative to this file's location, yielding new file handles.\r
+///\r
 struct _EFI_FILE_PROTOCOL {\r
+  ///\r
+  /// The version of the EFI_FILE_PROTOCOL interface. The version specified \r
+  /// by this specification is 0x00010000. Future versions are required \r
+  /// to be backward compatible to version 1.0.\r
+  ///\r
   UINT64                Revision;\r
   EFI_FILE_OPEN         Open;\r
   EFI_FILE_CLOSE        Close;\r