Synchronize function's comments with EFI 1.1 specification.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6060 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Protocol/UgaDraw.h b/MdePkg/Include/Protocol/UgaDraw.h
index 62e77ba81544e56bd690ee9061f792c3445d4b5a..b2dd1db4c913ff7bb07f1872981a605f1f029e61 100644 (file)
--- a/MdePkg/Include/Protocol/UgaDraw.h
+++ b/MdePkg/Include/Protocol/UgaDraw.h
@@ -17,8 +17,6 @@
 #ifndef __UGA_DRAW_H__\r
 #define __UGA_DRAW_H__\r
 \r
-#include <PiDxe.h>\r
-\r
 \r
 #define EFI_UGA_DRAW_PROTOCOL_GUID \\r
   { \\r
@@ -30,11 +28,11 @@ typedef struct _EFI_UGA_DRAW_PROTOCOL EFI_UGA_DRAW_PROTOCOL;
 /**\r
   Return the current video mode information.\r
 \r
-  @param  This                  Protocol instance pointer.\r
-  @param  HorizontalResolution  Current video horizontal resolution in pixels\r
-  @param  VerticalResolution    Current video vertical resolution in pixels\r
-  @param  ColorDepth            Current video color depth in bits per pixel\r
-  @param  RefreshRate           Current video refresh rate in Hz.\r
+  @param  This                  The EFI_UGA_DRAW_PROTOCOL instance.\r
+  @param  HorizontalResolution  The size of video screen in pixels in the X dimension.\r
+  @param  VerticalResolution    The size of video screen in pixels in the Y dimension.\r
+  @param  ColorDepth            Number of bits per pixel, currently defined to be 32.\r
+  @param  RefreshRate           The refresh rate of the monitor in Hertz.\r
 \r
   @retval EFI_SUCCESS           Mode information returned.\r
   @retval EFI_NOT_STARTED       Video display is not initialized. Call SetMode ()\r
@@ -54,11 +52,11 @@ EFI_STATUS
 /**\r
   Set the current video mode information.\r
 \r
-  @param  This                 Protocol instance pointer.\r
-  @param  HorizontalResolution Current video horizontal resolution in pixels\r
-  @param  VerticalResolution   Current video vertical resolution in pixels\r
-  @param  ColorDepth           Current video color depth in bits per pixel\r
-  @param  RefreshRate          Current video refresh rate in Hz.\r
+  @param  This                 The EFI_UGA_DRAW_PROTOCOL instance.\r
+  @param  HorizontalResolution The size of video screen in pixels in the X dimension.\r
+  @param  VerticalResolution   The size of video screen in pixels in the Y dimension.\r
+  @param  ColorDepth           Number of bits per pixel, currently defined to be 32.\r
+  @param  RefreshRate          The refresh rate of the monitor in Hertz.\r
 \r
   @retval EFI_SUCCESS          Mode information returned.\r
   @retval EFI_NOT_STARTED      Video display is not initialized. Call SetMode ()\r
@@ -86,43 +84,40 @@ typedef union {
   UINT32        Raw;\r
 } EFI_UGA_PIXEL_UNION;\r
 \r
+/**\r
+ Enumration value for actions of Blt operations.\r
+ **/\r
 typedef enum {\r
-  EfiUgaVideoFill,\r
-  EfiUgaVideoToBltBuffer,\r
-  EfiUgaBltBufferToVideo,\r
-  EfiUgaVideoToVideo,\r
-  EfiUgaBltMax\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
+  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
+  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
+  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
+  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
 \r
 /**\r
-  Type specifying a pointer to a function to perform an UGA Blt operation.\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
-      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
-      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
-      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
-     The BltBuffer and Delta  are not used in this mode.\r
-\r
+    Blt a rectangle of pixels on the graphics screen.\r
 \r
     @param[in] This          - Protocol instance pointer.\r
     @param[in] BltBuffer     - Buffer containing data to blit into video buffer. This\r