* [Patch] CryptoPkg: Correct some minor issues in function comments
@ 2017-04-14 8:35 Long Qin
2017-04-14 8:38 ` Ye, Ting
0 siblings, 1 reply; 2+ messages in thread
From: Long Qin @ 2017-04-14 8:35 UTC (permalink / raw)
To: ting.ye, edk2-devel; +Cc: Qin Long
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>
Signed-off-by: Long Qin <qin.long@intel.com>
---
CryptoPkg/Include/Library/BaseCryptLib.h | 18 +++++++++---------
CryptoPkg/Library/BaseCryptLib/Pk/CryptPkcs7Verify.c | 2 +-
2 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/CryptoPkg/Include/Library/BaseCryptLib.h b/CryptoPkg/Include/Library/BaseCryptLib.h
index 9f0f202668..9c5ffcd9cf 100644
--- 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
index bf24e92127..45d5df5e11 100644
--- 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.
@retval FALSE The P7Data was not correctly formatted for processing.
-*/
+**/
BOOLEAN
EFIAPI
Pkcs7GetAttachedContent (
--
2.12.2.windows.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [Patch] CryptoPkg: Correct some minor issues in function comments
2017-04-14 8:35 [Patch] CryptoPkg: Correct some minor issues in function comments Long Qin
@ 2017-04-14 8:38 ` Ye, Ting
0 siblings, 0 replies; 2+ messages in thread
From: Ye, Ting @ 2017-04-14 8:38 UTC (permalink / raw)
To: Long, Qin, edk2-devel@lists.01.org
Reviewed-by: Ye Ting <ting.ye@intel.com>
-----Original Message-----
From: Long, Qin
Sent: Friday, April 14, 2017 4:35 PM
To: Ye, Ting <ting.ye@intel.com>; edk2-devel@lists.01.org
Cc: Long, Qin <qin.long@intel.com>
Subject: [Patch] 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>
Signed-off-by: Long Qin <qin.long@intel.com>
---
CryptoPkg/Include/Library/BaseCryptLib.h | 18 +++++++++---------
CryptoPkg/Library/BaseCryptLib/Pk/CryptPkcs7Verify.c | 2 +-
2 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/CryptoPkg/Include/Library/BaseCryptLib.h b/CryptoPkg/Include/Library/BaseCryptLib.h
index 9f0f202668..9c5ffcd9cf 100644
--- 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
index bf24e92127..45d5df5e11 100644
--- 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.
@retval FALSE The P7Data was not correctly formatted for processing.
-*/
+**/
BOOLEAN
EFIAPI
Pkcs7GetAttachedContent (
--
2.12.2.windows.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
end of thread, other threads:[~2017-04-14 8:38 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2017-04-14 8:35 [Patch] CryptoPkg: Correct some minor issues in function comments Long Qin
2017-04-14 8:38 ` Ye, Ting
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox