]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/EdidOverride.h
Update comments for Protocol definitions to match UEFI spec.
[mirror_edk2.git] / MdePkg / Include / Protocol / EdidOverride.h
index 8a14e9766667b6d2f520ad9e2d24182b7ba9cc76..f2076b252e9e4f6d57b27dd148e24284ec5935d7 100644 (file)
@@ -18,8 +18,6 @@
 #ifndef __EDID_OVERRIDE_H__\r
 #define __EDID_OVERRIDE_H__\r
 \r
-#include <PiDxe.h>\r
-\r
 #define EFI_EDID_OVERRIDE_PROTOCOL_GUID \\r
   { \\r
     0x48ecb431, 0xfb72, 0x45c0, {0xa9, 0x22, 0xf4, 0x58, 0xfe, 0x4, 0xb, 0xd5 } \\r
@@ -31,9 +29,9 @@ typedef struct _EFI_EDID_OVERRIDE_PROTOCOL EFI_EDID_OVERRIDE_PROTOCOL;
 #define EFI_EDID_OVERRIDE_ENABLE_HOT_PLUG 0x02\r
 \r
 /**\r
-  Return the current video mode information.\r
+  Returns policy information and potentially a replacement EDID for the specified video output device.\r
 \r
-  @param  This              Protocol instance pointer.\r
+  @param  This              The EFI_EDID_OVERRIDE_PROTOCOL instance.\r
   @param  ChildHandle       A child handle produced by the Graphics Output EFI\r
                             driver that represents a video output device.\r
   @param  Attributes        The attributes associated with ChildHandle video output device.\r
@@ -56,15 +54,10 @@ EFI_STATUS
   IN OUT UINT8                            **Edid\r
   );\r
 \r
-/**\r
-  @par Protocol Description:\r
-  This protocol is produced by the platform to allow the platform to provide \r
-  EDID information to the producer of the Graphics Output protocol.\r
-\r
-  @param GetEdid \r
-  Returns EDID values and attributes that the Video BIOS must use. \r
-\r
-**/\r
+///\r
+/// This protocol is produced by the platform to allow the platform to provide \r
+/// EDID information to the producer of the Graphics Output protocol.\r
+///\r
 struct _EFI_EDID_OVERRIDE_PROTOCOL {\r
   EFI_EDID_OVERRIDE_PROTOCOL_GET_EDID   GetEdid;\r
 };\r