[5/5] cryptodev: fix comments of modular operation parameters

Message ID 20230614142651.1456116-6-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series cleanup in library header files |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/intel-Functional success Functional PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/github-robot: build success github build: passed
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-unit-testing success Testing PASS
ci/iol-aarch-unit-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS

Commit Message

Thomas Monjalon June 14, 2023, 2:26 p.m. UTC
  The Doxygen comments are made after the struct field,
but were missing the Doxygen syntax /**<.

Fixes: 518a974bfecc ("cryptodev: reorganize asymmetric structs")
Cc: stable@dpdk.org

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 lib/cryptodev/rte_crypto_asym.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
  

Patch

diff --git a/lib/cryptodev/rte_crypto_asym.h b/lib/cryptodev/rte_crypto_asym.h
index fc3f331393..8b5794fb7c 100644
--- a/lib/cryptodev/rte_crypto_asym.h
+++ b/lib/cryptodev/rte_crypto_asym.h
@@ -395,9 +395,9 @@  struct rte_crypto_sm2_xform {
  */
 struct rte_crypto_mod_op_param {
 	rte_crypto_uint base;
-	/** Base of modular exponentiation/multiplicative inverse */
+	/**< Base of modular exponentiation/multiplicative inverse. */
 	rte_crypto_uint result;
-	/** Result of modular exponentiation/multiplicative inverse */
+	/**< Result of modular exponentiation/multiplicative inverse. */
 };
 
 /**