tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-07-31 01:24:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

MdePkg/HiiImageEx: Fix incorrect comments of functions

Browse Source 
https://bugzilla.tianocore.org/show_bug.cgi?id=383

Cc: Liming Gao <liming.gao@intel.com>
Cc: Ruiyu Ni <ruiyu.ni@intel.com>
Cc: Eric Dong <eric.dong@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
Reviewed-by: Ruiyu Ni <ruiyu.ni@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
This commit is contained in:
Dandan Bi 2017-03-10 09:25:10 +08:00 committed by Hao Wu
parent 8057622527
commit b16dd6c86e
1 changed files with 43 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
MdePkg/Include/Protocol/HiiImageEx.h
View File

@ -28,8 +28,7 @@ typedef struct _EFI_HII_IMAGE_EX_PROTOCOL EFI_HII_IMAGE_EX_PROTOCOL;
/**
The prototype of this extension function is the same with EFI_HII_IMAGE_PROTOCOL.NewImage().
Same with EFI_HII_IMAGE_PROTOCOL.NewImage().This protocol invokes
EFI_HII_IMAGE_PROTOCOL.NewImage() implicitly.
This protocol invokes EFI_HII_IMAGE_PROTOCOL.NewImage() implicitly.
@param This A pointer to the EFI_HII_IMAGE_EX_PROTOCOL instance.
@param PackageList Handle of the package list where this image will
@ -57,22 +56,24 @@ EFI_STATUS
/**
Return the information about the image, associated with the package list.
The prototype of this extension function is the same with EFI_HII_IMAGE_PROTOCOL.GetImage().
Same with EFI_HII_IMAGE_PROTOCOL.SetImage(),this protocol invokes EFI_HII_IMAGE_PROTOCOL.SetImage() implicitly.
This function is similar to EFI_HII_IMAGE_PROTOCOL.GetImage().The difference is that
this function will locate all EFI_HII_IMAGE_DECODER_PROTOCOL instances installed in the
system if the decoder of the certain image type is not supported by the
EFI_HII_IMAGE_EX_PROTOCOL. The function will attempt to decode the image to the
EFI_IMAGE_INPUT using the first EFI_HII_IMAGE_DECODER_PROTOCOL instance that
supports the requested image type.
@param This A pointer to the EFI_HII_IMAGE_EX_PROTOCOL instance.
@param PackageList Handle of the package list where this image will
be searched.
@param ImageId The image's id,, which is unique within
PackageList.
@param PackageList The package list in the HII database to search for the
specified image.
@param ImageId The image's id, which is unique within PackageList.
@param Image Points to the image.
@retval EFI_SUCCESS The new image was returned successfully.
@retval EFI_NOT_FOUND The image specified by ImageId is not in the
database. The specified PackageList is not in
the database.
@retval EFI_BUFFER_TOO_SMALL The buffer specified by ImageSize is too small to
hold the image.
@retval EFI_INVALID_PARAMETER The Image or ImageSize was NULL.
@retval EFI_NOT_FOUND The image specified by ImageId is not available. The specified
PackageList is not in the Database.
@retval EFI_INVALID_PARAMETER Image was NULL or ImageId was 0.
@retval EFI_OUT_OF_RESOURCES The bitmap could not be retrieved because there
was not enough memory.
@ -87,21 +88,22 @@ EFI_STATUS
);
/**
Change the information about the image. The prototype of this extension
function is the same with EFI_HII_IMAGE_PROTOCOL.SetImage(). Same with
EFI_HII_IMAGE_PROTOCOL.DrawImageId(),this protocol invokes EFI_HII_IMAGE_PROTOCOL.DrawImageId() implicitly.
Change the information about the image.
Same with EFI_HII_IMAGE_PROTOCOL.SetImage(),this protocol invokes
EFI_HII_IMAGE_PROTOCOL.SetImage()implicitly.
@param This A pointer to the EFI_HII_IMAGE_EX_PROTOCOL instance.
@param PackageList The package list containing the images.
@param ImageId The image's id,, which is unique within
PackageList.
@param ImageId The image's id, which is unique within PackageList.
@param Image Points to the image.
@retval EFI_SUCCESS The new image was updated successfully.
@retval EFI_SUCCESS The new image was successfully updated.
@retval EFI_NOT_FOUND The image specified by ImageId is not in the
database. The specified PackageList is not in
the database.
@retval EFI_INVALID_PARAMETER The Image was NULL.
@retval EFI_INVALID_PARAMETER The Image was NULL, the ImageId was 0 or
the Image->Bitmap was NULL.
**/
typedef
@ -114,9 +116,11 @@ EFI_STATUS
);
/**
Renders an image to a bitmap or to the display. The prototype of this extension
function is the same with EFI_HII_IMAGE_PROTOCOL.DrawImage().
Same with EFI_HII_IMAGE_PROTOCOL.SetImage(),this protocol invokes EFI_HII_IMAGE_PROTOCOL.SetImage() implicitly.
Renders an image to a bitmap or to the display.
The prototype of this extension function is the same with
EFI_HII_IMAGE_PROTOCOL.DrawImage(). This protocol invokes
EFI_HII_IMAGE_PROTOCOL.DrawImage() implicitly.
@param This A pointer to the EFI_HII_IMAGE_EX_PROTOCOL instance.
@param Flags Describes how the image is to be drawn.
@ -137,7 +141,6 @@ EFI_STATUS
@retval EFI_SUCCESS The image was successfully drawn.
@retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for Blt.
@retval EFI_INVALID_PARAMETER The Image or Blt was NULL.
Any combination of Flags is invalid.
**/
typedef
@ -153,17 +156,20 @@ EFI_STATUS
/**
Renders an image to a bitmap or the screen containing the contents of the specified
image. The prototype of this extension function is the same with E
FI_HII_IMAGE_PROTOCOL.DrawImageId().
Same with EFI_HII_IMAGE_PROTOCOL.DrawImageId(),this protocol invokes
EFI_HII_IMAGE_PROTOCOL.DrawImageId() implicitly.
image.
This function is similar to EFI_HII_IMAGE_PROTOCOL.DrawImageId(). The difference is that
this function will locate all EFI_HII_IMAGE_DECODER_PROTOCOL instances installed in the
system if the decoder of the certain image type is not supported by the
EFI_HII_IMAGE_EX_PROTOCOL. The function will attempt to decode the image to the
EFI_IMAGE_INPUT using the first EFI_HII_IMAGE_DECODER_PROTOCOL instance that
supports the requested image type.
@param This A pointer to the EFI_HII_IMAGE_EX_PROTOCOL instance.
@param Flags Describes how the image is to be drawn.
@param PackageList The package list in the HII database to search for
the specified image.
@param ImageId The image's id, which is unique within
PackageList.
@param ImageId The image's id, which is unique within PackageList.
@param Blt If this points to a non-NULL on entry, this points
to the image, which is Width pixels wide and
Height pixels high. The image will be drawn onto
@ -179,7 +185,7 @@ EFI_HII_IMAGE_PROTOCOL.DrawImageId() implicitly.
@retval EFI_SUCCESS The image was successfully drawn.
@retval EFI_OUT_OF_RESOURCES Unable to allocate an output buffer for Blt.
@retval EFI_INVALID_PARAMETER The Blt was NULL.
@retval EFI_INVALID_PARAMETER The Blt was NULL or ImageId was 0.
@retval EFI_NOT_FOUND The image specified by ImageId is not in the database.
The specified PackageList is not in the database.
@ -206,7 +212,7 @@ EFI_STATUS
@param This A pointer to the EFI_HII_IMAGE_EX_PROTOCOL instance.
@param PackageList Handle of the package list where this image will
be searched.
@param ImageId The image's id,, which is unique within PackageList.
@param ImageId The image's id, which is unique within PackageList.
@param Image Points to the image.
@retval EFI_SUCCESS The new image was returned successfully.
@ -214,7 +220,7 @@ EFI_STATUS
database. The specified PackageList is not in the database.
@retval EFI_BUFFER_TOO_SMALL The buffer specified by ImageSize is too small to
hold the image.
@retval EFI_INVALID_PARAMETER The Image or ImageSize was NULL.
@retval EFI_INVALID_PARAMETER The Image was NULL or the ImageId was 0.
@retval EFI_OUT_OF_RESOURCES The bitmap could not be retrieved because there
was not enough memory.