MdePkg: Clean up source files

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

diff --git a/MdePkg/Include/Protocol/UgaDraw.h b/MdePkg/Include/Protocol/UgaDraw.h
index b2dd1db4c913ff7bb07f1872981a605f1f029e61..18eecc059d3551480e8577c6eafdec1de1e605bd 100644 (file)
--- a/MdePkg/Include/Protocol/UgaDraw.h
+++ b/MdePkg/Include/Protocol/UgaDraw.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 - 2018, 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
@@ -84,34 +84,34 @@ typedef union {
   UINT32        Raw;\r
 } EFI_UGA_PIXEL_UNION;\r
 \r
-/**\r
- Enumration value for actions of Blt operations.\r
- **/\r
+///\r
+/// Enumration value for actions of Blt operations.\r
+///\r
 typedef enum {\r
   EfiUgaVideoFill,          ///< Write data from the  BltBuffer pixel (SourceX, SourceY)\r
                             ///< directly to every pixel of the video display rectangle\r
                             ///< (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height).\r
                             ///< Only one pixel will be used from the BltBuffer. Delta is NOT used.\r
-                            \r
+\r
   EfiUgaVideoToBltBuffer,   ///< Read data from the video display rectangle\r
                             ///< (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in\r
                             ///< the BltBuffer rectangle (DestinationX, DestinationY )\r
                             ///< (DestinationX + Width, DestinationY + Height). If DestinationX or\r
                             ///< DestinationY is not zero then Delta must be set to the length in bytes\r
                             ///< of a row in the BltBuffer.\r
-                            \r
+\r
   EfiUgaBltBufferToVideo,   ///< Write data from the  BltBuffer rectangle\r
                             ///< (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the\r
                             ///< video display rectangle (DestinationX, DestinationY)\r
                             ///< (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is\r
                             ///< not zero then Delta must be set to the length in bytes of a row in the\r
                             ///< BltBuffer.\r
-  \r
+\r
   EfiUgaVideoToVideo,       ///< Copy from the video display rectangle (SourceX, SourceY)\r
                             ///< (SourceX + Width, SourceY + Height) .to the video display rectangle\r
                             ///< (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height).\r
                             ///< The BltBuffer and Delta  are not used in this mode.\r
-                            \r
+\r
   EfiUgaBltMax              ///< Maxmimum value for enumration value of Blt operation. If a Blt operation\r
                             ///< larger or equal to this enumration value, it is invalid.\r
 } EFI_UGA_BLT_OPERATION;\r
@@ -135,7 +135,7 @@ typedef enum {
     @retval EFI_INVALID_PARAMETER - BltOperation is not valid.\r
     @retval EFI_DEVICE_ERROR      - A hardware error occured writting to the video buffer.\r
 \r
---*/\r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_UGA_DRAW_PROTOCOL_BLT)(\r
@@ -151,25 +151,10 @@ EFI_STATUS
   IN  UINTN                                   Delta         OPTIONAL\r
   );\r
 \r
-/** \r
-  This protocol provides a basic abstraction to set video modes and \r
-  copy pixels to and from the graphics controller's frame buffer. \r
-\r
-  @par Protocol Description:\r
-  The EFI_UGA_DRAW_PROTOCOL provides a software abstraction to allow pixels to be drawn\r
-  directly to the frame buffer. The EFI_UGA_DRAW_PROTOCOL is designed to be lightweight and\r
-  to support the basic needs of graphics output prior to Operating System boot.  \r
-\r
-  @param GetMode \r
-  Returns information about the geometry and configuration of the\r
-  graphics controller's current frame buffer configuration.\r
-\r
-  @param SetMode \r
-  Set the graphics device into a given mode and clears the frame buffer to black.\r
-\r
-  @param Blt \r
-  Software abstraction to draw on the video device's frame buffer.  \r
-**/\r
+///\r
+/// This protocol provides a basic abstraction to set video modes and\r
+/// copy pixels to and from the graphics controller's frame buffer.\r
+///\r
 struct _EFI_UGA_DRAW_PROTOCOL {\r
   EFI_UGA_DRAW_PROTOCOL_GET_MODE  GetMode;\r
   EFI_UGA_DRAW_PROTOCOL_SET_MODE  SetMode;\r