From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 10FF5803D2 for ; Mon, 13 Mar 2017 21:23:21 -0700 (PDT) Received: from orsmga001.jf.intel.com ([10.7.209.18]) by orsmga101.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 13 Mar 2017 21:23:20 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.36,162,1486454400"; d="scan'208";a="1108156027" Received: from fmsmsx107.amr.corp.intel.com ([10.18.124.205]) by orsmga001.jf.intel.com with ESMTP; 13 Mar 2017 21:23:20 -0700 Received: from FMSMSX110.amr.corp.intel.com (10.18.116.10) by fmsmsx107.amr.corp.intel.com (10.18.124.205) with Microsoft SMTP Server (TLS) id 14.3.248.2; Mon, 13 Mar 2017 21:23:20 -0700 Received: from shsmsx103.ccr.corp.intel.com (10.239.4.69) by fmsmsx110.amr.corp.intel.com (10.18.116.10) with Microsoft SMTP Server (TLS) id 14.3.248.2; Mon, 13 Mar 2017 21:23:20 -0700 Received: from shsmsx102.ccr.corp.intel.com ([169.254.2.88]) by SHSMSX103.ccr.corp.intel.com ([10.239.4.69]) with mapi id 14.03.0248.002; Tue, 14 Mar 2017 12:23:18 +0800 From: "Gao, Liming" To: "Bi, Dandan" , "edk2-devel@lists.01.org" CC: "Ni, Ruiyu" , "Dong, Eric" Thread-Topic: [edk2] [patch] MdePkg/HiiImageEx: Fix incorrect comments of functions Thread-Index: AQHSnGPUA2auwbrJwkyUbNhJeO8LAqGTvGiQ Date: Tue, 14 Mar 2017 04:23:17 +0000 Message-ID: <4A89E2EF3DFEDB4C8BFDE51014F606A14D6EF767@shsmsx102.ccr.corp.intel.com> References: <1489455554-94000-1-git-send-email-dandan.bi@intel.com> In-Reply-To: <1489455554-94000-1-git-send-email-dandan.bi@intel.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [10.239.127.40] MIME-Version: 1.0 Subject: Re: [patch] MdePkg/HiiImageEx: Fix incorrect comments of functions X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 14 Mar 2017 04:23:21 -0000 Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Dandan: Is this change required in HiiDataBase? HiiDataBase implements HiiImageEx= protocol.=20 > -----Original Message----- > From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of Da= ndan Bi > Sent: Tuesday, March 14, 2017 9:39 AM > To: edk2-devel@lists.01.org > Cc: Ni, Ruiyu ; Dong, Eric ; Gao= , Liming > Subject: [edk2] [patch] MdePkg/HiiImageEx: Fix incorrect comments of func= tions >=20 > Cc: Liming Gao > Cc: Ruiyu Ni > Cc: Eric Dong > Contributed-under: TianoCore Contribution Agreement 1.0 > Signed-off-by: Dandan Bi > --- > MdePkg/Include/Protocol/HiiImageEx.h | 80 +++++++++++++++++++-----------= ------ > 1 file changed, 43 insertions(+), 37 deletions(-) >=20 > diff --git a/MdePkg/Include/Protocol/HiiImageEx.h b/MdePkg/Include/Protoc= ol/HiiImageEx.h > index b92fc3a..5a48380 100644 > --- a/MdePkg/Include/Protocol/HiiImageEx.h > +++ b/MdePkg/Include/Protocol/HiiImageEx.h > @@ -26,12 +26,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EI= THER EXPRESS OR IMPLIED. >=20 > typedef struct _EFI_HII_IMAGE_EX_PROTOCOL EFI_HII_IMAGE_EX_PROTOCOL; >=20 > /** > The prototype of this extension function is the same with EFI_HII_IMAG= E_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. >=20 > @param This A pointer to the EFI_HII_IMAGE_EX_PROTO= COL instance. > @param PackageList Handle of the package list where this i= mage will > be added. > @param ImageId On return, contains the new image id, w= hich is > @@ -55,26 +54,28 @@ EFI_STATUS > ); >=20 > /** > Return the information about the image, associated with the package li= st. > The prototype of this extension function is the same with EFI_HII_IMAG= E_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 diff= erence 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 th= e > + EFI_HII_IMAGE_EX_PROTOCOL. The function will attempt to decode the ima= ge to the > + EFI_IMAGE_INPUT using the first EFI_HII_IMAGE_DECODER_PROTOCOL instanc= e that > + supports the requested image type. >=20 > @param This A pointer to the EFI_HII_IMAGE_EX_PROTO= COL instance. > - @param PackageList Handle of the package list where this i= mage 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. >=20 > @retval EFI_SUCCESS The new image was returned successfully= . > - @retval EFI_NOT_FOUND The image specified by ImageId is not i= n the > - database. The specified PackageList is = not in > - the database. > - @retval EFI_BUFFER_TOO_SMALL The buffer specified by ImageSize is to= o 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 a= vailable. 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 becau= se there > was not enough memory. >=20 > **/ > typedef > @@ -85,25 +86,26 @@ EFI_STATUS > IN EFI_IMAGE_ID ImageId, > OUT EFI_IMAGE_INPUT *Image > ); >=20 > /** > - Change the information about the image. The prototype of this extensio= n > - function is the same with EFI_HII_IMAGE_PROTOCOL.SetImage(). Same wit= h > - EFI_HII_IMAGE_PROTOCOL.DrawImageId(),this protocol invokes EFI_HII_IMA= GE_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. >=20 > @param This A pointer to the EFI_HII_IMAGE_EX_PROTO= COL 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. >=20 > - @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 i= n 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 o= r > + the Image->Bitmap was NULL. >=20 > **/ > typedef > EFI_STATUS > (EFIAPI *EFI_HII_SET_IMAGE_EX)( > @@ -112,34 +114,35 @@ EFI_STATUS > IN EFI_IMAGE_ID ImageId, > IN CONST EFI_IMAGE_INPUT *Image > ); >=20 > /** > - 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. >=20 > @param This A pointer to the EFI_HII_IMAGE_EX_PROTO= COL instance. > @param Flags Describes how the image is to be drawn. > @param Image Points to the image to be displayed. > @param Blt If this points to a non-NULL on entry, = this points > to the image, which is Width pixels wid= e and > Height pixels high. The image will be = drawn onto > this image and EFI_HII_DRAW_FLAG_CLIP = is implied. > - If this points to a NULL on entry, the= n a buffer > - will be allocated to hold the generate= d image and > + If this points to a NULL on entry, then= a buffer > + will be allocated to hold the generated= image and > the pointer updated on exit. It is the = caller's > responsibility to free this buffer. > @param BltX Specifies the offset from the left and = top edge of > - the output image of the first pixel in= the image. > + the output image of the first pixel in = the image. > @param BltY Specifies the offset from the left and = top edge of > - the output image of the first pixel in= the image. > + the output image of the first pixel in = the image. >=20 > @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. >=20 > **/ > typedef > EFI_STATUS > (EFIAPI *EFI_HII_DRAW_IMAGE_EX)( > @@ -151,21 +154,24 @@ EFI_STATUS > IN UINTN BltY > ); >=20 > /** > 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 th= e > + EFI_HII_IMAGE_EX_PROTOCOL. The function will attempt to decode the ima= ge to the > + EFI_IMAGE_INPUT using the first EFI_HII_IMAGE_DECODER_PROTOCOL instanc= e that > + supports the requested image type. >=20 > @param This A pointer to the EFI_HII_IMAGE_EX_PROTO= COL 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 wid= e and > Height pixels high. The image will be d= rawn onto > this image and EFI_HII_DRAW_FLAG_CLIP i= s implied. > If this points to a NULL on entry, then= a buffer > @@ -177,11 +183,11 @@ EFI_HII_IMAGE_PROTOCOL.DrawImageId() implicitly. > @param BltY Specifies the offset from the left and = top edge of > the output image of the first pixel in = the image. >=20 > @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 i= n the database. > The specified PackageList is not in the= database. >=20 > **/ > typedef > @@ -204,19 +210,19 @@ EFI_STATUS > system if the decoder of image type is not supported by the EFI_HII_IM= AGE_EX_PROTOCOL. >=20 > @param This A pointer to the EFI_HII_IMAGE_EX_PROTO= COL instance. > @param PackageList Handle of the package list where this i= mage 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. >=20 > @retval EFI_SUCCESS The new image was returned successfully= . > @retval EFI_NOT_FOUND The image specified by ImageId is not i= n the > database. The specified PackageList is = not in the database. > @retval EFI_BUFFER_TOO_SMALL The buffer specified by ImageSize is to= o 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 becau= se there > was not enough memory. >=20 > **/ > typedef > -- > 1.9.5.msysgit.1 >=20 > _______________________________________________ > edk2-devel mailing list > edk2-devel@lists.01.org > https://lists.01.org/mailman/listinfo/edk2-devel