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 <[email protected]> Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Qin Long <[email protected]> Reviewed-by: Ye Ting <[email protected]>
saislam · Apr 14, 2017 · 0c9fc4b · 0c9fc4b
1 parent 8b17683
commit 0c9fc4b
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 10 deletions.
diff --git a/CryptoPkg/Include/Library/BaseCryptLib.h b/CryptoPkg/Include/Library/BaseCryptLib.h
@@ -1790,10 +1790,10 @@ Arc4Init (
   If Output is NULL, then return FALSE.
   If this interface is not supported, then return FALSE.
 
-  @param[in]   Arc4Context  Pointer to the ARC4 context.
-  @param[in]   Input        Pointer to the buffer containing the data to be encrypted.
-  @param[in]   InputSize    Size of the Input buffer in bytes.
-  @param[out]  Output       Pointer to a buffer that receives the ARC4 encryption output.
+  @param[in, out]  Arc4Context  Pointer to the ARC4 context.
+  @param[in]       Input        Pointer to the buffer containing the data to be encrypted.
+  @param[in]       InputSize    Size of the Input buffer in bytes.
+  @param[out]      Output       Pointer to a buffer that receives the ARC4 encryption output.
 
   @retval TRUE   ARC4 encryption succeeded.
   @retval FALSE  ARC4 encryption failed.
@@ -1822,10 +1822,10 @@ Arc4Encrypt (
   If Output is NULL, then return FALSE.
   If this interface is not supported, then return FALSE.
 
-  @param[in]   Arc4Context  Pointer to the ARC4 context.
-  @param[in]   Input        Pointer to the buffer containing the data to be decrypted.
-  @param[in]   InputSize    Size of the Input buffer in bytes.
-  @param[out]  Output       Pointer to a buffer that receives the ARC4 decryption output.
+  @param[in, out]  Arc4Context  Pointer to the ARC4 context.
+  @param[in]       Input        Pointer to the buffer containing the data to be decrypted.
+  @param[in]       InputSize    Size of the Input buffer in bytes.
+  @param[out]      Output       Pointer to a buffer that receives the ARC4 decryption output.
 
   @retval TRUE   ARC4 decryption succeeded.
   @retval FALSE  ARC4 decryption failed.
@@ -2511,7 +2511,7 @@ Pkcs7Verify (
   @retval     TRUE          The P7Data was correctly formatted for processing.
   @retval     FALSE         The P7Data was not correctly formatted for processing.
 
-*/
+**/
 BOOLEAN
 EFIAPI
 Pkcs7GetAttachedContent (

diff --git a/CryptoPkg/Library/BaseCryptLib/Pk/CryptPkcs7Verify.c b/CryptoPkg/Library/BaseCryptLib/Pk/CryptPkcs7Verify.c
@@ -925,7 +925,7 @@ Pkcs7Verify (
   @retval     TRUE          The P7Data was correctly formatted for processing.
   @retval     FALSE         The P7Data was not correctly formatted for processing.
 
-*/
+**/
 BOOLEAN
 EFIAPI
 Pkcs7GetAttachedContent (
-Original file line number
+Diff line change
@@ Expand Up / @@ -925,7 +925,7 @@ Pkcs7Verify ( @@
       @retval     TRUE          The P7Data was correctly formatted for processing.
       @retval     FALSE         The P7Data was not correctly formatted for processing.
-    */
+    **/
     BOOLEAN
     EFIAPI
     Pkcs7GetAttachedContent (
@@ Expand Down @@