mirror of https://github.com/acidanthera/audk.git
MdeModulePkg/PlatformLogo.h: Correct function header comments
Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com> Reviewed-by: Star Zeng <star.zeng@intel.com>
This commit is contained in:
parent
25184ec33c
commit
de707b0866
|
@ -2,7 +2,7 @@
|
||||||
The Platform Logo Protocol defines the interface to get the Platform logo
|
The Platform Logo Protocol defines the interface to get the Platform logo
|
||||||
image with the display attribute.
|
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
|
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 terms and conditions of the BSD License that accompanies this distribution.
|
||||||
The full text of the license may be found at
|
The full text of the license may be found at
|
||||||
|
@ -39,22 +39,17 @@ typedef enum {
|
||||||
} EDKII_PLATFORM_LOGO_DISPLAY_ATTRIBUTE;
|
} EDKII_PLATFORM_LOGO_DISPLAY_ATTRIBUTE;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
||||||
Load a platform logo image and return its data and attributes.
|
Load a platform logo image and return its data and attributes.
|
||||||
|
|
||||||
@param This The pointer to this protocol instance.
|
@param This The pointer to this protocol instance.
|
||||||
@param Instance The visible image instance is found.
|
@param Instance The visible image instance is found.
|
||||||
@param Format The format of the image. Examples: BMP, JPEG.
|
@param Image Points to the image.
|
||||||
@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 Attribute The display attributes of the image returned.
|
@param Attribute The display attributes of the image returned.
|
||||||
@param OffsetX The X offset of the image regarding the Attribute.
|
@param OffsetX The X offset of the image regarding the Attribute.
|
||||||
@param OffsetY The Y 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_SUCCESS The image was fetched successfully.
|
||||||
@retval EFI_NOT_FOUND The specified image could not be found.
|
@retval EFI_NOT_FOUND The specified image could not be found.
|
||||||
|
|
||||||
**/
|
**/
|
||||||
typedef
|
typedef
|
||||||
EFI_STATUS
|
EFI_STATUS
|
||||||
|
|
Loading…
Reference in New Issue