MdePkg: Clean up source files

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

diff --git a/MdePkg/Include/Protocol/EdidDiscovered.h b/MdePkg/Include/Protocol/EdidDiscovered.h
index 6790666b67df0e2871da279d28bcf15e3d7c9685..9e2695f8a7f6d1c3bbf0e402a77b44cc17bab4f6 100644 (file)
--- a/MdePkg/Include/Protocol/EdidDiscovered.h
+++ b/MdePkg/Include/Protocol/EdidDiscovered.h
@@ -1,19 +1,17 @@
 /** @file\r
   EDID Discovered Protocol from the UEFI 2.0 specification.\r
 \r
-  This protocol is placed on the video output device child handle and it represents\r
-  the EDID information being used for output device represented by the child handle.\r
+  This protocol is placed on the video output device child handle. It represents\r
+  the EDID information being used for the output device represented by the child handle.\r
 \r
-  Copyright (c) 2006, 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
-  http://opensource.org/licenses/bsd-license.php                                            \r
+  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  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
+  http://opensource.org/licenses/bsd-license.php\r
 \r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
-\r
-  Module Name:  EdidDiscovered.h\r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r
 \r
@@ -25,8 +23,25 @@
     0x1c0c34f6, 0xd380, 0x41fa, {0xa0, 0x49, 0x8a, 0xd0, 0x6c, 0x1a, 0x66, 0xaa } \\r
   }\r
 \r
+///\r
+/// This protocol contains the EDID information retrieved from a video output device.\r
+///\r
 typedef struct {\r
+  ///\r
+  /// The size, in bytes, of the Edid buffer. 0 if no EDID information\r
+  /// is available from the video output device. Otherwise, it must be a\r
+  /// minimum of 128 bytes.\r
+  ///\r
   UINT32   SizeOfEdid;\r
+\r
+  ///\r
+  /// A pointer to a read-only array of bytes that contains the EDID\r
+  /// information for an active video output device. This pointer is\r
+  /// NULL if no EDID information is available for the video output\r
+  /// device. The minimum size of a valid Edid buffer is 128 bytes.\r
+  /// EDID information is defined in the E-EDID EEPROM\r
+  /// specification published by VESA (www.vesa.org).\r
+  ///\r
   UINT8    *Edid;\r
 } EFI_EDID_DISCOVERED_PROTOCOL;\r
 \r