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 EBABC81DFA for ; Thu, 10 Nov 2016 01:09:06 -0800 (PST) Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by orsmga101.jf.intel.com with ESMTP; 10 Nov 2016 01:09:10 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.31,618,1473145200"; d="scan'208";a="1083290063" Received: from shwdeopenpsi114.ccr.corp.intel.com ([10.239.157.135]) by fmsmga002.fm.intel.com with ESMTP; 10 Nov 2016 01:09:08 -0800 From: Dandan Bi To: edk2-devel@lists.01.org Date: Thu, 10 Nov 2016 17:08:59 +0800 Message-Id: <1478768939-18040-1-git-send-email-dandan.bi@intel.com> X-Mailer: git-send-email 1.9.5.msysgit.1 Subject: [PATCH v2] CryptoPkg/BaseCryptLib: Make comments consistent with the function 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: Thu, 10 Nov 2016 09:09:07 -0000 V2: Correct the unaligned parameter name in BaseCryptLib.h. Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Dandan Bi --- CryptoPkg/Include/Library/BaseCryptLib.h | 4 ++-- CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c | 2 +- CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CryptoPkg/Include/Library/BaseCryptLib.h b/CryptoPkg/Include/Library/BaseCryptLib.h index 45dac3b..0004493 100644 --- a/CryptoPkg/Include/Library/BaseCryptLib.h +++ b/CryptoPkg/Include/Library/BaseCryptLib.h @@ -1114,11 +1114,11 @@ HmacSha1Update ( If HmacSha1Context is NULL, then return FALSE. If HashValue is NULL, then return FALSE. If this interface is not supported, then return FALSE. @param[in, out] HmacSha1Context Pointer to the HMAC-SHA1 context. - @param[out] HashValue Pointer to a buffer that receives the HMAC-SHA1 digest + @param[out] HmacValue Pointer to a buffer that receives the HMAC-SHA1 digest value (20 bytes). @retval TRUE HMAC-SHA1 digest computation succeeded. @retval FALSE HMAC-SHA1 digest computation failed. @retval FALSE This interface is not supported. @@ -1232,11 +1232,11 @@ HmacSha256Update ( If HmacSha256Context is NULL, then return FALSE. If HashValue is NULL, then return FALSE. If this interface is not supported, then return FALSE. @param[in, out] HmacSha256Context Pointer to the HMAC-SHA256 context. - @param[out] HashValue Pointer to a buffer that receives the HMAC-SHA256 digest + @param[out] HmacValue Pointer to a buffer that receives the HMAC-SHA256 digest value (32 bytes). @retval TRUE HMAC-SHA256 digest computation succeeded. @retval FALSE HMAC-SHA256 digest computation failed. @retval FALSE This interface is not supported. diff --git a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c index 5d349dc..e17ef29 100644 --- a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c +++ b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c @@ -162,11 +162,11 @@ HmacSha256Update ( If HmacSha256Context is NULL, then return FALSE. If HashValue is NULL, then return FALSE. @param[in, out] HmacSha256Context Pointer to the HMAC-SHA256 context. - @param[out] HashValue Pointer to a buffer that receives the HMAC-SHA256 digest + @param[out] HmacValue Pointer to a buffer that receives the HMAC-SHA256 digest value (32 bytes). @retval TRUE HMAC-SHA256 digest computation succeeded. @retval FALSE HMAC-SHA256 digest computation failed. diff --git a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c index 48704e1..35abdda 100644 --- a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c +++ b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c @@ -107,11 +107,11 @@ HmacSha256Update ( Completes computation of the HMAC-SHA256 digest value. Return FALSE to indicate this interface is not supported. @param[in, out] HmacSha256Context Pointer to the HMAC-SHA256 context. - @param[out] HashValue Pointer to a buffer that receives the HMAC-SHA256 digest + @param[out] HmacValue Pointer to a buffer that receives the HMAC-SHA256 digest value (32 bytes). @retval FALSE This interface is not supported. **/ -- 1.9.5.msysgit.1