Code have been checked with spec

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

diff --git a/MdePkg/Include/Protocol/DiskIo.h b/MdePkg/Include/Protocol/DiskIo.h
index fbf4384874d6fe241d08c8b1e268021e4cca23ff..77517cb672747bab9efff10298ac19f5e9726f2b 100644 (file)
--- a/MdePkg/Include/Protocol/DiskIo.h
+++ b/MdePkg/Include/Protocol/DiskIo.h
@@ -64,13 +64,13 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Read BufferSize bytes from Offset into Buffer.\r
+  Writes a specified number of bytes to a device.\r
 \r
-  @param  This       Protocol instance pointer.\r
-  @param  MediaId    Id of the media, changes every time the media is replaced.\r
-  @param  Offset     The starting byte offset to read from\r
-  @param  BufferSize Size of Buffer\r
-  @param  Buffer     Buffer containing read data\r
+  @param  This       Indicates a pointer to the calling context.\r
+  @param  MediaId    ID of the medium to be written.\r
+  @param  Offset     The starting byte offset on the logical block I/O device to write.\r
+  @param  BufferSize The size in bytes of Buffer. The number of bytes to write to the device.\r
+  @param  Buffer     A pointer to the buffer containing the data to be written.\r
 \r
   @retval EFI_SUCCESS           The data was written correctly to the device.\r
   @retval EFI_WRITE_PROTECTED   The device can not be written to.\r
@@ -98,23 +98,15 @@ EFI_STATUS
 /// \r
 #define EFI_DISK_IO_INTERFACE_REVISION  EFI_DISK_IO_PROTOCOL_REVISION\r
 \r
-/**\r
-  @par Protocol Description:\r
-  This protocol is used to abstract Block I/O interfaces.\r
-\r
-  @param Revision \r
-  The revision to which the disk I/O interface adheres. All future\r
-  revisions must be backwards compatible. If a future version is not\r
-  backwards compatible, it is not the same GUID.\r
-\r
-  @param ReadDisk \r
-  Reads data from the disk.\r
-  \r
-  @param WriteDisk \r
-  Writes data to the disk.\r
-\r
-**/\r
+///\r
+/// This protocol is used to abstract Block I/O interfaces.\r
+///\r
 struct _EFI_DISK_IO_PROTOCOL {\r
+  ///\r
+  /// The revision to which the disk I/O interface adheres. All future\r
+  /// revisions must be backwards compatible. If a future version is not\r
+  /// backwards compatible, it is not the same GUID.\r
+  ///\r
   UINT64          Revision;\r
   EFI_DISK_READ   ReadDisk;\r
   EFI_DISK_WRITE  WriteDisk;\r