Update comments for Protocol definitions to match UEFI spec.

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

diff --git a/MdePkg/Include/Protocol/UgaIo.h b/MdePkg/Include/Protocol/UgaIo.h
index 3faf1841c35647d706def213ecd58515aee1dcb4..e0fa68a36889e6cc0351f76c34f3e75002d58b27 100644 (file)
--- a/MdePkg/Include/Protocol/UgaIo.h
+++ b/MdePkg/Include/Protocol/UgaIo.h
@@ -91,17 +91,17 @@ typedef struct {
 } UGA_IO_REQUEST, *PUGA_IO_REQUEST;\r
 \r
 \r
-/**
+/**\r
   Dynamically allocate storage for a child UGA_DEVICE .\r
-
-  @param[in]     This            The EFI_UGA_IO_PROTOCOL instance. 
-  @param[in]     ParentDevice    ParentDevice specifies a pointer to the parent device of Device.
+\r
+  @param[in]     This            The EFI_UGA_IO_PROTOCOL instance. \r
+  @param[in]     ParentDevice    ParentDevice specifies a pointer to the parent device of Device.\r
   @param[in]     DeviceData      A pointer to UGA_DEVICE_DATA returned from a call to DispatchService()\r
-                                 with a UGA_DEVICE of Parent and an IoRequest of type UgaIoGetChildDevice.      
-  @param[in]     RunTimeContext  Context to associate with Device.  
+                                 with a UGA_DEVICE of Parent and an IoRequest of type UgaIoGetChildDevice.      \r
+  @param[in]     RunTimeContext  Context to associate with Device.  \r
   @param[out]    Device          The Device returns a dynamically allocated child UGA_DEVICE object\r
-                                 for ParentDevice. The caller is responsible for deleting Device.
-
+                                 for ParentDevice. The caller is responsible for deleting Device.\r
+\r
                                  \r
   @retval  EFI_SUCCESS           Device was returned.\r
   @retval  EFI_INVALID_PARAMETER One of the arguments was not valid.\r
@@ -119,14 +119,14 @@ EFI_STATUS
   );\r
 \r
 \r
-/**
+/**\r
   Delete a dynamically allocated child UGA_DEVICE object that was allocated via CreateDevice() .\r
-
+\r
   @param[in]     This            The EFI_UGA_IO_PROTOCOL instance. Type EFI_UGA_IO_PROTOCOL is \r
-                                 defined in Section 10.7.
+                                 defined in Section 10.7.\r
   @param[in]     Device          The Device points to a UGA_DEVICE object that was dynamically\r
                                  allocated via a CreateDevice() call.\r
-
+\r
                                  \r
   @retval  EFI_SUCCESS           Device was returned.\r
   @retval  EFI_INVALID_PARAMETER The Device was not allocated via CreateDevice().\r
@@ -162,19 +162,9 @@ typedef UGA_STATUS
   IN OUT PUGA_IO_REQUEST pIoRequest\r
   );\r
 \r
-/**  \r
-  @par Protocol Description:\r
-  Provides a basic abstraction to send I/O requests to the graphics device and any of its children.\r
-\r
-  @param CreateDevice \r
-  Create a UGA_DEVICE object for a child device of a given parent UGA_DEVICE.\r
-\r
-  @param DeleteDevice \r
-  Delete the UGA_DEVICE returned from CreateDevice().\r
-\r
-  @param DispatchService \r
-  Dispatches I/O requests to the display device and its associate child devices.\r
-**/\r
+///\r
+/// Provides a basic abstraction to send I/O requests to the graphics device and any of its children.\r
+///\r
 struct _EFI_UGA_IO_PROTOCOL {\r
   EFI_UGA_IO_PROTOCOL_CREATE_DEVICE CreateDevice;\r
   EFI_UGA_IO_PROTOCOL_DELETE_DEVICE DeleteDevice;\r