From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) (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 33569802AE for ; Tue, 14 Mar 2017 18:48:24 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=intel.com; i=@intel.com; q=dns/txt; s=intel; t=1489542504; x=1521078504; h=from:to:cc:subject:date:message-id:references: in-reply-to:content-transfer-encoding:mime-version; bh=LZSbDNN9UHg/BaV9mbkDKviKxv9Fll66Y5c5v+6T56E=; b=h/0kprF7sjl3gWBqwEf5WKXhV2Eggg+HyEDTUXy7jNIM5UkG5gsAyKHo poqcU3i0WYD3Df1HV0o7xcP5aUIcUA==; Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga103.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 14 Mar 2017 18:48:23 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.36,166,1486454400"; d="scan'208";a="76904669" Received: from fmsmsx106.amr.corp.intel.com ([10.18.124.204]) by fmsmga006.fm.intel.com with ESMTP; 14 Mar 2017 18:48:23 -0700 Received: from fmsmsx120.amr.corp.intel.com (10.18.124.208) by FMSMSX106.amr.corp.intel.com (10.18.124.204) with Microsoft SMTP Server (TLS) id 14.3.248.2; Tue, 14 Mar 2017 18:48:23 -0700 Received: from shsmsx101.ccr.corp.intel.com (10.239.4.153) by fmsmsx120.amr.corp.intel.com (10.18.124.208) with Microsoft SMTP Server (TLS) id 14.3.248.2; Tue, 14 Mar 2017 18:48:23 -0700 Received: from shsmsx104.ccr.corp.intel.com ([169.254.5.59]) by SHSMSX101.ccr.corp.intel.com ([169.254.1.177]) with mapi id 14.03.0248.002; Wed, 15 Mar 2017 09:48:21 +0800 From: "Ni, Ruiyu" To: "Gao, Liming" , "Bi, Dandan" , "edk2-devel@lists.01.org" CC: "Dong, Eric" Thread-Topic: [edk2] [patch] MdePkg/HiiImageEx: Fix incorrect comments of functions Thread-Index: AQHSnGPShNuTYJdcq0qFjU0C7dsTtaGTNoSAgAHsyzA= Date: Wed, 15 Mar 2017 01:48:20 +0000 Deferred-Delivery: Wed, 15 Mar 2017 01:48:00 +0000 Message-ID: <734D49CCEBEEF84792F5B80ED585239D5B8C9EB4@SHSMSX104.ccr.corp.intel.com> References: <1489455554-94000-1-git-send-email-dandan.bi@intel.com> <4A89E2EF3DFEDB4C8BFDE51014F606A14D6EF767@shsmsx102.ccr.corp.intel.com> In-Reply-To: <4A89E2EF3DFEDB4C8BFDE51014F606A14D6EF767@shsmsx102.ccr.corp.intel.com> Accept-Language: en-US, zh-CN 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: Wed, 15 Mar 2017 01:48:24 -0000 Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Reviewed-by: Ruiyu Ni Thanks/Ray > -----Original Message----- > From: Gao, Liming > Sent: Tuesday, March 14, 2017 12:23 PM > To: Bi, Dandan ; edk2-devel@lists.01.org > Cc: Ni, Ruiyu ; Dong, Eric > Subject: RE: [edk2] [patch] MdePkg/HiiImageEx: Fix incorrect comments of > functions >=20 > Dandan: > Is this change required in HiiDataBase? HiiDataBase implements HiiImage= Ex > protocol. >=20 > > -----Original Message----- > > From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of > > Dandan 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 > > functions > > > > 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(-) > > > > diff --git a/MdePkg/Include/Protocol/HiiImageEx.h > > b/MdePkg/Include/Protocol/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, EITHER EXPRESS OR IMPLIED. > > > > 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_PRO= TOCOL > instance. > > @param PackageList Handle of the package list where this= image > will > > be added. > > @param ImageId On return, contains the new image id,= which is > > @@ -55,26 +54,28 @@ 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_PRO= TOCOL > instance. > > - @param PackageList Handle of the package list where this= image > will > > - be searched. > > - @param ImageId The image's id,, which is unique with= in > > - 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 withi= n > PackageList. > > @param Image Points to the image. > > > > @retval EFI_SUCCESS The new image was returned successful= ly. > > - @retval EFI_NOT_FOUND The image specified by ImageId is not= in > the > > - database. The specified PackageList i= s 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. > > > > **/ > > typedef > > @@ -85,25 +86,26 @@ EFI_STATUS > > IN EFI_IMAGE_ID ImageId, > > OUT EFI_IMAGE_INPUT *Image > > ); > > > > /** > > - 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_PRO= TOCOL > instance. > > @param PackageList The package list containing the image= s. > > - @param ImageId The image's id,, which is unique with= in > > - PackageList. > > + @param ImageId The image's id, which is unique withi= n > PackageList. > > @param Image Points to the image. > > > > - @retval EFI_SUCCESS The new image was updated successfull= y. > > + @retval EFI_SUCCESS The new image was successfully update= d. > > @retval EFI_NOT_FOUND The image specified by ImageId is not= in > the > > database. The specified PackageList i= s 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 > > 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 > > ); > > > > /** > > - 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_PRO= TOCOL > instance. > > @param Flags Describes how the image is to be draw= n. > > @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 w= ide and > > Height pixels high. The image will b= e drawn onto > > this image and EFI_HII_DRAW_FLAG_CLI= P is implied. > > - If this points to a NULL on entry, t= hen a buffer > > - will be allocated to hold the genera= ted image and > > + If this points to a NULL on entry, th= en a buffer > > + will be allocated to hold the > > + generated image and > > the pointer updated on exit. It is th= e caller's > > responsibility to free this buffer. > > @param BltX Specifies the offset from the left an= d top edge of > > - the output image of the first pixel = in the image. > > + the output image of the first pixel i= n the image. > > @param BltY Specifies the offset from the left an= d top edge of > > - the output image of the first pixel = in the image. > > + the output image of the first pixel i= n the image. > > > > @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 > > EFI_STATUS > > (EFIAPI *EFI_HII_DRAW_IMAGE_EX)( > > @@ -151,21 +154,24 @@ EFI_STATUS > > IN UINTN BltY > > ); > > > > /** > > 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_PRO= TOCOL > instance. > > @param Flags Describes how the image is to be draw= n. > > @param PackageList The package list in the HII database = to search > for > > the specified image. > > - @param ImageId The image's id, which is unique withi= n > > - PackageList. > > + @param ImageId The image's id, which is unique withi= n > PackageList. > > @param Blt If this points to a non-NULL on entry= , this points > > to the image, which is Width pixels w= ide 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, > > then a buffer @@ -177,11 +183,11 @@ > EFI_HII_IMAGE_PROTOCOL.DrawImageId() implicitly. > > @param BltY Specifies the offset from the left an= d top edge of > > the output image of the first pixel i= n the image. > > > > @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 t= he database. > > > > **/ > > typedef > > @@ -204,19 +210,19 @@ EFI_STATUS > > system if the decoder of image type is not supported by the > EFI_HII_IMAGE_EX_PROTOCOL. > > > > @param This A pointer to the EFI_HII_IMAGE_EX_PRO= TOCOL > instance. > > @param PackageList Handle of the package list where this= image > will > > be searched. > > - @param ImageId The image's id,, which is unique with= in > PackageList. > > + @param ImageId The image's id, which is unique withi= n > PackageList. > > @param Image Points to the image. > > > > @retval EFI_SUCCESS The new image was returned successful= ly. > > @retval EFI_NOT_FOUND The image specified by ImageId is not= in > the > > database. The specified PackageList i= s 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. > > > > **/ > > typedef > > -- > > 1.9.5.msysgit.1 > > > > _______________________________________________ > > edk2-devel mailing list > > edk2-devel@lists.01.org > > https://lists.01.org/mailman/listinfo/edk2-devel