Clarify @pram b in Base.h. Accepted and edited in Qing Huang changes for @retval...

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

diff --git a/MdePkg/Include/Protocol/UgaDraw.h b/MdePkg/Include/Protocol/UgaDraw.h
index 9465c3f772e1aecb58f65f657ab38a009e76d711..1dc2a956c15781ea6564102c8d665bc2c2128bd0 100644 (file)
--- a/MdePkg/Include/Protocol/UgaDraw.h
+++ b/MdePkg/Include/Protocol/UgaDraw.h
@@ -84,9 +84,9 @@ 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
@@ -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,16 +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
-**/\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