CryptoPkg: Correct some minor issues in function comments

Correct some minor comment issues in BaseCryptLib.h and
CryptPkcs7Verify.c, including:
  - missed "out" in parameter property for ARC4 interfaces;
  - Wrong Comment tail in Pkcs7GetAttachedContent function

Cc: Ting Ye <ting.ye@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Qin Long <qin.long@intel.com>
Reviewed-by: Ye Ting <ting.ye@intel.com>

diff --git a/CryptoPkg/Include/Library/BaseCryptLib.h b/CryptoPkg/Include/Library/BaseCryptLib.h
index 9f0f202668416434249fb665148d76d3b149dbd1..9c5ffcd9cfdc936432ebcdc7ffaccca07c748e5d 100644 (file)
--- a/CryptoPkg/Include/Library/BaseCryptLib.h
+++ b/CryptoPkg/Include/Library/BaseCryptLib.h
@@ -1790,10 +1790,10 @@ Arc4Init (
   If Output is NULL, then return FALSE.\r
   If this interface is not supported, then return FALSE.\r
 \r
   If Output is NULL, then return FALSE.\r
   If this interface is not supported, then return FALSE.\r
 \r

-  @param[in]   Arc4Context  Pointer to the ARC4 context.\r
-  @param[in]   Input        Pointer to the buffer containing the data to be encrypted.\r
-  @param[in]   InputSize    Size of the Input buffer in bytes.\r
-  @param[out]  Output       Pointer to a buffer that receives the ARC4 encryption output.\r
+  @param[in, out]  Arc4Context  Pointer to the ARC4 context.\r
+  @param[in]       Input        Pointer to the buffer containing the data to be encrypted.\r
+  @param[in]       InputSize    Size of the Input buffer in bytes.\r
+  @param[out]      Output       Pointer to a buffer that receives the ARC4 encryption output.\r

 \r
   @retval TRUE   ARC4 encryption succeeded.\r
   @retval FALSE  ARC4 encryption failed.\r
 \r
   @retval TRUE   ARC4 encryption succeeded.\r
   @retval FALSE  ARC4 encryption failed.\r


@@ -1822,10 +1822,10 @@ Arc4Encrypt (
   If Output is NULL, then return FALSE.\r
   If this interface is not supported, then return FALSE.\r
 \r
   If Output is NULL, then return FALSE.\r
   If this interface is not supported, then return FALSE.\r
 \r

-  @param[in]   Arc4Context  Pointer to the ARC4 context.\r
-  @param[in]   Input        Pointer to the buffer containing the data to be decrypted.\r
-  @param[in]   InputSize    Size of the Input buffer in bytes.\r
-  @param[out]  Output       Pointer to a buffer that receives the ARC4 decryption output.\r
+  @param[in, out]  Arc4Context  Pointer to the ARC4 context.\r
+  @param[in]       Input        Pointer to the buffer containing the data to be decrypted.\r
+  @param[in]       InputSize    Size of the Input buffer in bytes.\r
+  @param[out]      Output       Pointer to a buffer that receives the ARC4 decryption output.\r

 \r
   @retval TRUE   ARC4 decryption succeeded.\r
   @retval FALSE  ARC4 decryption failed.\r
 \r
   @retval TRUE   ARC4 decryption succeeded.\r
   @retval FALSE  ARC4 decryption failed.\r


@@ -2511,7 +2511,7 @@ Pkcs7Verify (
   @retval     TRUE          The P7Data was correctly formatted for processing.\r
   @retval     FALSE         The P7Data was not correctly formatted for processing.\r
 \r
   @retval     TRUE          The P7Data was correctly formatted for processing.\r
   @retval     FALSE         The P7Data was not correctly formatted for processing.\r
 \r

-*/\r
+**/\r

 BOOLEAN\r
 EFIAPI\r
 Pkcs7GetAttachedContent (\r
 BOOLEAN\r
 EFIAPI\r
 Pkcs7GetAttachedContent (\r

diff --git a/CryptoPkg/Library/BaseCryptLib/Pk/CryptPkcs7Verify.c b/CryptoPkg/Library/BaseCryptLib/Pk/CryptPkcs7Verify.c
index bf24e92127005681cfea3956fd07ec2b8f4dbc1a..45d5df5e118a2d03e7bc7280a82a30744b18086f 100644 (file)
--- a/CryptoPkg/Library/BaseCryptLib/Pk/CryptPkcs7Verify.c
+++ b/CryptoPkg/Library/BaseCryptLib/Pk/CryptPkcs7Verify.c
@@ -925,7 +925,7 @@ _Exit:
   @retval     TRUE          The P7Data was correctly formatted for processing.\r
   @retval     FALSE         The P7Data was not correctly formatted for processing.\r
 \r
   @retval     TRUE          The P7Data was correctly formatted for processing.\r
   @retval     FALSE         The P7Data was not correctly formatted for processing.\r
 \r

-*/\r
+**/\r

 BOOLEAN\r
 EFIAPI\r
 Pkcs7GetAttachedContent (\r
 BOOLEAN\r
 EFIAPI\r
 Pkcs7GetAttachedContent (\r