From: GuoMinJ <newexplorerj@gmail.com>
Date: Thu, 5 Mar 2020 06:40:55 +0000 (+0800)
Subject: CryptoPkg/BaseCryptLibOnProtocolPpi: Add missing comments
X-Git-Tag: edk2-stable202005~204
X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=8acb61dfb3b3517826ab4df6ebde085bc479eac1

CryptoPkg/BaseCryptLibOnProtocolPpi: Add missing comments

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=2552

DxeCryptLibConstructor have no comments for it, add comments for it.

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Xiaoyu Lu <xiaoyux.lu@intel.com>
Signed-off-by: Guomin Jiang <guomin.jiang@intel.com>
Reviewed-by: Shenglei Zhang <shenglei.zhang@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
Reviewed-by: Xiaoyu Lu <xiaoyux.lu@intel.com>
---

diff --git a/CryptoPkg/Library/BaseCryptLibOnProtocolPpi/DxeCryptLib.c b/CryptoPkg/Library/BaseCryptLibOnProtocolPpi/DxeCryptLib.c
index 34d5f410b0..b503a5708b 100644
--- a/CryptoPkg/Library/BaseCryptLibOnProtocolPpi/DxeCryptLib.c
+++ b/CryptoPkg/Library/BaseCryptLibOnProtocolPpi/DxeCryptLib.c
@@ -32,6 +32,15 @@ GetCryptoServices (
   return (VOID *)mCryptoProtocol;
 }
 
+/**
+  Locate the valid Crypto Protocol.
+
+  @param  ImageHandle   The firmware allocated handle for the EFI image.
+  @param  SystemTable   A pointer to the EFI System Table.
+
+  @retval EFI_SUCCESS   The constructor executed correctly.
+  @retval EFI_NOT_FOUND Found no valid Crypto Protocol.
+**/
 EFI_STATUS
 EFIAPI
 DxeCryptLibConstructor (