Update comments for Protocol definitions to match UEFI spec.

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

diff --git a/MdePkg/Include/Protocol/DeviceIo.h b/MdePkg/Include/Protocol/DeviceIo.h
index 7b79d2355f13e7b423a445d1954c5eba79b91343..f2dd067bb7ecbc8683e6c35ad13bcd8f9aa3ed46 100644 (file)
--- a/MdePkg/Include/Protocol/DeviceIo.h
+++ b/MdePkg/Include/Protocol/DeviceIo.h
@@ -213,43 +213,22 @@ EFI_STATUS
   IN EFI_PHYSICAL_ADDRESS             HostAddress\r
   );\r
 \r
-/**\r
-  @par Protocol Description:\r
-  This protocol provides the basic Memory, I/O, and PCI interfaces that \r
-  are used to abstract accesses to devices.\r
-\r
-  @param Mem \r
-  Allows reads and writes to memory mapped I/O space.\r
-\r
-  @param Io \r
-  Allows reads and writes to I/O space.\r
-\r
-  @param Pci \r
-  Allows reads and writes to PCI configuration space.\r
-\r
-  @param Map \r
-  Provides the device specific addresses needed to access system memory for DMA. \r
-\r
-  @param PciDevicePath \r
-  Provides an EFI Device Path for a PCI device with the given PCI\r
-  configuration space address.\r
-\r
-  @param Unmap \r
-  Releases any resources allocated by Map(). \r
-\r
-  @param AllocateBuffer \r
-  Allocates pages that are suitable for a common buffer mapping. \r
-\r
-  @param Flush \r
-  Flushes any posted write data to the device. \r
-\r
-  @param FreeBuffer \r
-  Free pages that were allocated with AllocateBuffer(). \r
-\r
-**/ \r
+///\r
+/// This protocol provides the basic Memory, I/O, and PCI interfaces that \r
+/// are used to abstract accesses to devices.\r
+///\r
 struct _EFI_DEVICE_IO_PROTOCOL {\r
+  ///\r
+  /// Allows reads and writes to memory mapped I/O space.\r
+  ///\r
   EFI_IO_ACCESS           Mem;\r
+  ///\r
+  /// Allows reads and writes to I/O space.\r
+  ///\r
   EFI_IO_ACCESS           Io;\r
+  ///\r
+  /// Allows reads and writes to PCI configuration space.\r
+  ///\r
   EFI_IO_ACCESS           Pci;\r
   EFI_IO_MAP              Map;\r
   EFI_PCI_DEVICE_PATH     PciDevicePath;\r