Update comments for Protocol definitions to match UEFI spec.

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

diff --git a/MdePkg/Include/Protocol/EdidOverride.h b/MdePkg/Include/Protocol/EdidOverride.h
index c9285941028038d8ca5b06ec9d59ae5cb69f104d..f2076b252e9e4f6d57b27dd148e24284ec5935d7 100644 (file)
--- a/MdePkg/Include/Protocol/EdidOverride.h
+++ b/MdePkg/Include/Protocol/EdidOverride.h
@@ -4,7 +4,7 @@
   Allow platform to provide EDID information to producer of the Graphics Output\r
   protocol.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. 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
@@ -15,8 +15,6 @@
 \r
 **/\r
 \r
-#include <PiDxe.h>\r
-\r
 #ifndef __EDID_OVERRIDE_H__\r
 #define __EDID_OVERRIDE_H__\r
 \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
@@ -48,15 +46,18 @@ typedef struct _EFI_EDID_OVERRIDE_PROTOCOL EFI_EDID_OVERRIDE_PROTOCOL;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_EDID_OVERRIDE_PROTOCOL_GET_EDID) (\r
+(EFIAPI *EFI_EDID_OVERRIDE_PROTOCOL_GET_EDID)(\r
   IN  EFI_EDID_OVERRIDE_PROTOCOL          *This,\r
   IN  EFI_HANDLE                          *ChildHandle,\r
   OUT UINT32                              *Attributes,\r
   IN OUT UINTN                            *EdidSize,\r
   IN OUT UINT8                            **Edid\r
-  )\r
-;\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