MdeModulePkg/PlatformLogo.h: Correct function header comments

[edk2] [PATCH] MdeModulePkg/PlatformLogo.h: Correct function header comments

Posted by Ruiyu Ni 6 years, 1 month ago

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
Cc: Star Zeng <star.zeng@intel.com>
---
 MdeModulePkg/Include/Protocol/PlatformLogo.h | 9 ++-------
 1 file changed, 2 insertions(+), 7 deletions(-)

diff --git a/MdeModulePkg/Include/Protocol/PlatformLogo.h b/MdeModulePkg/Include/Protocol/PlatformLogo.h
index 4773173889..c25e7b04cb 100644
--- a/MdeModulePkg/Include/Protocol/PlatformLogo.h
+++ b/MdeModulePkg/Include/Protocol/PlatformLogo.h
@@ -2,7 +2,7 @@
   The Platform Logo Protocol defines the interface to get the Platform logo
   image with the display attribute.
 
-Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>
 This program and the accompanying materials are licensed and made available under 
 the terms and conditions of the BSD License that accompanies this distribution.  
 The full text of the license may be found at
@@ -39,22 +39,17 @@ typedef enum {
 } EDKII_PLATFORM_LOGO_DISPLAY_ATTRIBUTE;
 
 /**
-
   Load a platform logo image and return its data and attributes.
 
   @param This              The pointer to this protocol instance.
   @param Instance          The visible image instance is found.
-  @param Format            The format of the image. Examples: BMP, JPEG.
-  @param ImageData         The image data for the badge file. Currently only 
-                           supports the .bmp file format. 
-  @param ImageSize         The size of the image returned.
+  @param Image             Points to the image.
   @param Attribute         The display attributes of the image returned.
   @param OffsetX           The X offset of the image regarding the Attribute.
   @param OffsetY           The Y offset of the image regarding the Attribute.
 
   @retval EFI_SUCCESS      The image was fetched successfully.
   @retval EFI_NOT_FOUND    The specified image could not be found.
-
 **/
 typedef
 EFI_STATUS
-- 
2.16.1.windows.1

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel

Re: [edk2] [PATCH] MdeModulePkg/PlatformLogo.h: Correct function header comments

Posted by Zeng, Star 6 years, 1 month ago

Reviewed-by: Star Zeng <star.zeng@intel.com>

Thanks,
Star
-----Original Message-----
From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of Ruiyu Ni
Sent: Saturday, February 24, 2018 3:47 PM
To: edk2-devel@lists.01.org
Cc: Zeng, Star <star.zeng@intel.com>
Subject: [edk2] [PATCH] MdeModulePkg/PlatformLogo.h: Correct function header comments

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
Cc: Star Zeng <star.zeng@intel.com>
---
 MdeModulePkg/Include/Protocol/PlatformLogo.h | 9 ++-------
 1 file changed, 2 insertions(+), 7 deletions(-)

diff --git a/MdeModulePkg/Include/Protocol/PlatformLogo.h b/MdeModulePkg/Include/Protocol/PlatformLogo.h
index 4773173889..c25e7b04cb 100644
--- a/MdeModulePkg/Include/Protocol/PlatformLogo.h
+++ b/MdeModulePkg/Include/Protocol/PlatformLogo.h
@@ -2,7 +2,7 @@
   The Platform Logo Protocol defines the interface to get the Platform logo
   image with the display attribute.
 
-Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>
 This program and the accompanying materials are licensed and made available under  the terms and conditions of the BSD License that accompanies this distribution.  
 The full text of the license may be found at @@ -39,22 +39,17 @@ typedef enum {  } EDKII_PLATFORM_LOGO_DISPLAY_ATTRIBUTE;
 
 /**
-
   Load a platform logo image and return its data and attributes.
 
   @param This              The pointer to this protocol instance.
   @param Instance          The visible image instance is found.
-  @param Format            The format of the image. Examples: BMP, JPEG.
-  @param ImageData         The image data for the badge file. Currently only 
-                           supports the .bmp file format. 
-  @param ImageSize         The size of the image returned.
+  @param Image             Points to the image.
   @param Attribute         The display attributes of the image returned.
   @param OffsetX           The X offset of the image regarding the Attribute.
   @param OffsetY           The Y offset of the image regarding the Attribute.
 
   @retval EFI_SUCCESS      The image was fetched successfully.
   @retval EFI_NOT_FOUND    The specified image could not be found.
-
 **/
 typedef
 EFI_STATUS
--
2.16.1.windows.1

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel