BaseTools: Clean up source files

[mirror_edk2.git] / BaseTools / Source / C / Include / Protocol / UgaDraw.h

diff --git a/BaseTools/Source/C/Include/Protocol/UgaDraw.h b/BaseTools/Source/C/Include/Protocol/UgaDraw.h
index 3911fa98849bca7eeaa0ff9f08b386214a878a73..a89a867ac3c5d00a91f477e2a5be70bf3e4055f8 100644 (file)
--- a/BaseTools/Source/C/Include/Protocol/UgaDraw.h
+++ b/BaseTools/Source/C/Include/Protocol/UgaDraw.h
@@ -3,7 +3,7 @@
 \r
   Abstraction of a very simple graphics device.\r
 \r
 \r
   Abstraction of a very simple graphics device.\r
 \r

-  Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r

 \r
   This program and the accompanying materials are licensed and made available\r
   under the terms and conditions of the BSD License which accompanies this\r
 \r
   This program and the accompanying materials are licensed and made available\r
   under the terms and conditions of the BSD License which accompanies this\r


@@ -99,33 +99,33 @@ typedef enum {
 \r
     The following table defines actions for BltOperations:\r
 \r
 \r
     The following table defines actions for BltOperations:\r
 \r

-    <B>EfiUgaVideoFill</B> - 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
+    <B>EfiUgaVideoFill</B> - 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
       Only one pixel will be used from the BltBuffer. Delta is NOT used.\r
 \r

-    <B>EfiUgaVideoToBltBuffer</B> - 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
+    <B>EfiUgaVideoToBltBuffer</B> - 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
       of a row in the BltBuffer.\r
 \r

-    <B>EfiUgaBltBufferToVideo</B> - 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
+    <B>EfiUgaBltBufferToVideo</B> - 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
     <B>EfiUgaVideoToVideo</B> - Copy from the video display rectangle (SourceX, SourceY)\r
       BltBuffer.\r
 \r
     <B>EfiUgaVideoToVideo</B> - 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
+     (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
     @param[in] This          - Protocol instance pointer.\r
      The BltBuffer and Delta  are not used in this mode.\r
 \r
 \r
     @param[in] This          - Protocol instance pointer.\r

-    @param[in] BltBuffer     - Buffer containing data to blit into video buffer. This \r
+    @param[in] BltBuffer     - Buffer containing data to blit into video buffer. This\r

                                buffer has a size of Width*Height*sizeof(EFI_UGA_PIXEL)\r
     @param[in] BltOperation  - Operation to perform on BlitBuffer and video memory\r
     @param[in] SourceX       - X coordinate of source for the BltBuffer.\r
                                buffer has a size of Width*Height*sizeof(EFI_UGA_PIXEL)\r
     @param[in] BltOperation  - Operation to perform on BlitBuffer and video memory\r
     @param[in] SourceX       - X coordinate of source for the BltBuffer.\r


@@ -135,7 +135,7 @@ typedef enum {
     @param[in] Width         - Width of rectangle in BltBuffer in pixels.\r
     @param[in] Height        - Hight of rectangle in BltBuffer in pixels.\r
     @param[in] Delta         - OPTIONAL\r
     @param[in] Width         - Width of rectangle in BltBuffer in pixels.\r
     @param[in] Height        - Hight of rectangle in BltBuffer in pixels.\r
     @param[in] Delta         - OPTIONAL\r

-  \r
+\r

     @retval EFI_SUCCESS           - The Blt operation completed.\r
     @retval EFI_INVALID_PARAMETER - BltOperation is not valid.\r
     @retval EFI_DEVICE_ERROR      - A hardware error occured writting to the video buffer.\r
     @retval EFI_SUCCESS           - The Blt operation completed.\r
     @retval EFI_INVALID_PARAMETER - BltOperation is not valid.\r
     @retval EFI_DEVICE_ERROR      - A hardware error occured writting to the video buffer.\r