CryptoPkg/BaseCryptLib: Make comments consistent with the function
authorDandan Bi <dandan.bi@intel.com>
Fri, 11 Nov 2016 05:46:04 +0000 (13:46 +0800)
committerQin Long <qin.long@intel.com>
Fri, 11 Nov 2016 05:46:04 +0000 (13:46 +0800)
Correct the unaligned parameter names in comments (BaseCryptLib.h and
HMAC-SHA256 wrapper implementation)

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
Reviewed-by: Qin Long <qin.long@intel.com>
CryptoPkg/Include/Library/BaseCryptLib.h
CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c
CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c

index 45dac3b..9cc4776 100644 (file)
@@ -994,11 +994,11 @@ HmacMd5Update (
   finalized by HmacMd5Final(). Behavior with invalid HMAC-MD5 context is undefined.\r
 \r
   If HmacMd5Context is NULL, then return FALSE.\r
-  If HashValue is NULL, then return FALSE.\r
+  If HmacValue is NULL, then return FALSE.\r
   If this interface is not supported, then return FALSE.\r
 \r
   @param[in, out]  HmacMd5Context  Pointer to the HMAC-MD5 context.\r
-  @param[out]      HashValue       Pointer to a buffer that receives the HMAC-MD5 digest\r
+  @param[out]      HmacValue       Pointer to a buffer that receives the HMAC-MD5 digest\r
                                    value (16 bytes).\r
 \r
   @retval TRUE   HMAC-MD5 digest computation succeeded.\r
@@ -1112,11 +1112,11 @@ HmacSha1Update (
   not be finalized by HmacSha1Final(). Behavior with invalid HMAC-SHA1 context is undefined.\r
 \r
   If HmacSha1Context is NULL, then return FALSE.\r
-  If HashValue is NULL, then return FALSE.\r
+  If HmacValue is NULL, then return FALSE.\r
   If this interface is not supported, then return FALSE.\r
 \r
   @param[in, out]  HmacSha1Context  Pointer to the HMAC-SHA1 context.\r
-  @param[out]      HashValue        Pointer to a buffer that receives the HMAC-SHA1 digest\r
+  @param[out]      HmacValue        Pointer to a buffer that receives the HMAC-SHA1 digest\r
                                     value (20 bytes).\r
 \r
   @retval TRUE   HMAC-SHA1 digest computation succeeded.\r
@@ -1230,11 +1230,11 @@ HmacSha256Update (
   not be finalized by HmacSha256Final(). Behavior with invalid HMAC-SHA256 context is undefined.\r
 \r
   If HmacSha256Context is NULL, then return FALSE.\r
-  If HashValue is NULL, then return FALSE.\r
+  If HmacValue is NULL, then return FALSE.\r
   If this interface is not supported, then return FALSE.\r
 \r
   @param[in, out]  HmacSha256Context  Pointer to the HMAC-SHA256 context.\r
-  @param[out]      HashValue          Pointer to a buffer that receives the HMAC-SHA256 digest\r
+  @param[out]      HmacValue          Pointer to a buffer that receives the HMAC-SHA256 digest\r
                                       value (32 bytes).\r
 \r
   @retval TRUE   HMAC-SHA256 digest computation succeeded.\r
index 5d349dc..7726e40 100644 (file)
@@ -161,10 +161,10 @@ HmacSha256Update (
   not be finalized by HmacSha256Final(). Behavior with invalid HMAC-SHA256 context is undefined.\r
 \r
   If HmacSha256Context is NULL, then return FALSE.\r
-  If HashValue is NULL, then return FALSE.\r
+  If HmacValue is NULL, then return FALSE.\r
 \r
   @param[in, out]  HmacSha256Context  Pointer to the HMAC-SHA256 context.\r
-  @param[out]      HashValue          Pointer to a buffer that receives the HMAC-SHA256 digest\r
+  @param[out]      HmacValue          Pointer to a buffer that receives the HMAC-SHA256 digest\r
                                       value (32 bytes).\r
 \r
   @retval TRUE   HMAC-SHA256 digest computation succeeded.\r
index 48704e1..35abdda 100644 (file)
@@ -109,7 +109,7 @@ HmacSha256Update (
   Return FALSE to indicate this interface is not supported.\r
 \r
   @param[in, out]  HmacSha256Context  Pointer to the HMAC-SHA256 context.\r
-  @param[out]      HashValue          Pointer to a buffer that receives the HMAC-SHA256 digest\r
+  @param[out]      HmacValue          Pointer to a buffer that receives the HMAC-SHA256 digest\r
                                       value (32 bytes).\r
 \r
   @retval FALSE  This interface is not supported.\r