Update the copyright notice format

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

diff --git a/MdePkg/Include/Protocol/UgaIo.h b/MdePkg/Include/Protocol/UgaIo.h
index ba097db86a80e5d33780bcff353532407acb2db0..b6884219180cfaeecfae22b005661c7b2c2508c6 100644 (file)
--- a/MdePkg/Include/Protocol/UgaIo.h
+++ b/MdePkg/Include/Protocol/UgaIo.h
@@ -3,8 +3,8 @@
 \r
   Abstraction of a very simple graphics device.\r
   \r
-  Copyright (c) 2006 - 2008, Intel Corporation \r
-  All rights reserved. This program and the accompanying materials                          \r
+  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r
   which accompanies this distribution.  The full text of the license may be found at        \r
   http://opensource.org/licenses/bsd-license.php                                            \r
@@ -30,8 +30,7 @@ typedef enum {
   UgaDtOutputController,\r
   UgaDtOutputPort,\r
   UgaDtOther\r
-}\r
-UGA_DEVICE_TYPE, *PUGA_DEVICE_TYPE;\r
+} UGA_DEVICE_TYPE, *PUGA_DEVICE_TYPE;\r
 \r
 typedef UINT32 UGA_DEVICE_ID, *PUGA_DEVICE_ID;\r
 \r
@@ -40,8 +39,7 @@ typedef struct {
   UGA_DEVICE_ID   deviceId;\r
   UINT32          ui32DeviceContextSize;\r
   UINT32          ui32SharedContextSize;\r
-}\r
-UGA_DEVICE_DATA, *PUGA_DEVICE_DATA;\r
+} UGA_DEVICE_DATA, *PUGA_DEVICE_DATA;\r
 \r
 typedef struct _UGA_DEVICE {\r
   VOID                *pvDeviceContext;\r
@@ -51,8 +49,7 @@ typedef struct _UGA_DEVICE {
   VOID                *pvBusIoServices;\r
   VOID                *pvStdIoServices;\r
   UGA_DEVICE_DATA     deviceData;\r
-}\r
-UGA_DEVICE, *PUGA_DEVICE;\r
+} UGA_DEVICE, *PUGA_DEVICE;\r
 \r
 typedef enum {\r
   UgaIoGetVersion             = 1,\r
@@ -78,8 +75,7 @@ typedef enum {
   UgaIoGetDevicePropertySize,\r
   UgaIoGetDeviceProperty,\r
   UgaIoBtPrivateInterface\r
-}\r
-UGA_IO_REQUEST_CODE, *PUGA_IO_REQUEST_CODE;\r
+} UGA_IO_REQUEST_CODE, *PUGA_IO_REQUEST_CODE;\r
 \r
 typedef struct {\r
   IN UGA_IO_REQUEST_CODE  ioRequestCode;\r
@@ -91,18 +87,17 @@ typedef struct {
 } 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.
+/**\r
+  Dynamically allocate storage for a child UGA_DEVICE.\r
+\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
@@ -120,14 +115,14 @@ EFI_STATUS
   );\r
 \r
 \r
-/**
-  Delete a dynamically allocated child UGA_DEVICE object that was allocated via CreateDevice() .\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
@@ -163,19 +158,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