Fix typo in FirmwareVolumeBlock.h

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

diff --git a/MdePkg/Include/Protocol/UgaIo.h b/MdePkg/Include/Protocol/UgaIo.h
index ebe0a1b5895cf1c997ca194c7ba2eb0d6077bce2..02654051afea36893669b9eb47909df0448ec2e7 100644 (file)
--- a/MdePkg/Include/Protocol/UgaIo.h
+++ b/MdePkg/Include/Protocol/UgaIo.h
@@ -94,49 +94,51 @@ typedef struct {
   OUT VOID                *pvOutBuffer;\r
   IN UINT64               ui64OutBufferSize;\r
   OUT UINT64              ui64BytesReturned;\r
-}\r
-UGA_IO_REQUEST, *PUGA_IO_REQUEST;\r
+} UGA_IO_REQUEST, *PUGA_IO_REQUEST;\r
+\r
+\r
+/**
+  Dynamically allocate storage for a child UGA_DEVICE .\r
+
+  @param[in]     This            The EFI_UGA_IO_PROTOCOL instance. Type EFI_UGA_IO_PROTOCOL is \r
+                                 defined in Section 10.7.
+  @param[in]     ParentDevice    ParentDevice specifies a pointer to the parent device of Device.
+  @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.  
+  @param[out]    Device          The Device returns a dynamically allocated child UGA_DEVICE object\r
+                                 for ParentDevice. The caller is responsible for deleting Device.
+
+                                 \r
+  @retval  EFI_SUCCESS           Device was returned.\r
+  @retval  EFI_INVALID_PARAMETER One of the arguments was not valid.\r
+  @retval  EFI_DEVICE_ERROR      The device had an error and could not complete the request.\r
 \r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_UGA_IO_PROTOCOL_CREATE_DEVICE) (\r
-  IN  EFI_UGA_IO_PROTOCOL  * This,\r
-  IN  UGA_DEVICE           * ParentDevice,\r
-  IN  UGA_DEVICE_DATA      * DeviceData,\r
+  IN  EFI_UGA_IO_PROTOCOL  *This,\r
+  IN  UGA_DEVICE           *ParentDevice,\r
+  IN  UGA_DEVICE_DATA      *DeviceData,\r
   IN  VOID                 *RunTimeContext,\r
   OUT UGA_DEVICE           **Device\r
   );\r
 \r
-/*++\r
-\r
-  Routine Description:\r
-\r
-    Dynamically allocate storage for a child UGA_DEVICE .\r
-\r
-  Arguments:\r
-\r
-    This           - The EFI_UGA_IO_PROTOCOL instance. Type EFI_UGA_IO_PROTOCOL is \r
-                     defined in Section 10.7.\r
-\r
-    ParentDevice   - ParentDevice specifies a pointer to the parent device of Device.\r
-\r
-    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.\r
-\r
-    RuntimeContext - Context to associate with Device.\r
-\r
-    Device         - The Device returns a dynamically allocated child UGA_DEVICE object\r
-                     for ParentDevice. The caller is responsible for deleting Device.\r
-      \r
-  Returns:\r
-\r
-    EFI_SUCCESS           - Device was returned.\r
 \r
-    EFI_INVALID_PARAMETER - One of the arguments was not valid.\r
+/**
+  Delete a dynamically allocated child UGA_DEVICE object that was allocated via CreateDevice() .\r
+
+  @param[in]     This            The EFI_UGA_IO_PROTOCOL instance. Type EFI_UGA_IO_PROTOCOL is \r
+                                 defined in Section 10.7.
+  @param[in]     Device          The Device points to a UGA_DEVICE object that was dynamically\r
+                                 allocated via a CreateDevice() call.\r
+
+                                 \r
+  @retval  EFI_SUCCESS           Device was returned.\r
+  @retval  EFI_INVALID_PARAMETER The Device was not allocated via CreateDevice().\r
 \r
-    EFI_DEVICE_ERROR      - The device had an error and could not complete the request.\r
-\r
---*/\r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_UGA_IO_PROTOCOL_DELETE_DEVICE) (\r
@@ -144,31 +146,10 @@ EFI_STATUS
   IN UGA_DEVICE           * Device\r
   );\r
 \r
-/*++\r
-\r
-  Routine Description:\r
-\r
-    Delete a dynamically allocated child UGA_DEVICE object that was allocated via\r
-    CreateDevice() .\r
-\r
-  Arguments:\r
-\r
-    This   - The EFI_UGA_IO_PROTOCOL instance. Type EFI_UGA_IO_PROTOCOL is defined \r
-             in Section 10.7.\r
-\r
-    Device - The Device points to a UGA_DEVICE object that was dynamically\r
-             allocated via a CreateDevice() call.\r
-\r
-  Returns:\r
 \r
-    EFI_SUCCESS           - Device was deleted.\r
-\r
-    EFI_INVALID_PARAMETER - The Device was not allocated via CreateDevice()\r
-\r
---*/\r
 typedef UGA_STATUS (EFIAPI *PUGA_FW_SERVICE_DISPATCH) (IN PUGA_DEVICE pDevice, IN OUT PUGA_IO_REQUEST pIoRequest);\r
 \r
-/*++\r
+/**\r
 \r
   Routine Description:\r
 \r
@@ -190,7 +171,7 @@ typedef UGA_STATUS (EFIAPI *PUGA_FW_SERVICE_DISPATCH) (IN PUGA_DEVICE pDevice, I
 \r
   Varies depending on pIoRequest.\r
 \r
---*/\r
+**/\r
 struct _EFI_UGA_IO_PROTOCOL {\r
   EFI_UGA_IO_PROTOCOL_CREATE_DEVICE CreateDevice;\r
   EFI_UGA_IO_PROTOCOL_DELETE_DEVICE DeleteDevice;\r