Code scrube for MdeModule Definitions.

[mirror_edk2.git] / MdeModulePkg / Include / Protocol / OEMBadging.h

diff --git a/MdeModulePkg/Include/Protocol/OEMBadging.h b/MdeModulePkg/Include/Protocol/OEMBadging.h
index 3154c1465aa85b955116ac14c8981b366bbb88f2..0d701a84230db40ce62ef9d857fdbf76d1dbbc2e 100644 (file)
--- a/MdeModulePkg/Include/Protocol/OEMBadging.h
+++ b/MdeModulePkg/Include/Protocol/OEMBadging.h
@@ -1,5 +1,6 @@
 /** @file\r
-  EFI OEM Badging Protocol definition header file\r
+  EFI OEM Badging Protocol defines the interface to get the OEM badging \r
+  image with the dispaly attribute. This protocol can be produced based on OEM images.\r
 \r
 Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r
@@ -45,7 +46,23 @@ typedef enum {
   EfiBadgingDisplayAttributeCustomized\r
 } EFI_BADGING_DISPLAY_ATTRIBUTE;\r
 \r
+/**\r
 \r
+  Load an OEM image and return its data as well as attributes.\r
+\r
+  @param This              Pointer to this protocol instance.\r
+  @param Instance          The visiable image instance is founded and returned from the input instance.\r
+  @param Format            Format of the image such as BMP,JPEG,etc.\r
+  @param ImageData         Image data returned.\r
+  @param ImageSize         Size of the image returned.\r
+  @param Attribute         Display attributes of the image returned.\r
+  @param CoordinateX       X coordinate of the image.\r
+  @param CoordinateY       Y coordinate of the image.\r
+\r
+  @retval EFI_SUCCESS      Image has been fetched successfully.\r
+  @retval EFI_NOT_FOUND    The specified image could not be found.\r
+\r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_BADGING_GET_IMAGE) (\r