From 231546daccc8b69458ef666c7c7dc6bdb983c552 Mon Sep 17 00:00:00 2001 From: Andrew Hutchings Date: Wed, 10 Nov 2021 17:26:33 +0000 Subject: [PATCH] Fix more Doxygen typos --- doc/dox_comments/header_files/dh.h | 12 ++++++------ doc/dox_comments/header_files/ssl.h | 2 +- doc/dox_comments/header_files/wc_encrypt.h | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/dox_comments/header_files/dh.h b/doc/dox_comments/header_files/dh.h index ba29346d4..fb1a44844 100644 --- a/doc/dox_comments/header_files/dh.h +++ b/doc/dox_comments/header_files/dh.h @@ -240,15 +240,15 @@ WOLFSSL_API int wc_DhSetKey(DhKey* key, const byte* p, word32 pSz, const byte* g \return BUFFER_E Returned if there is inadequate space in p or g to store the parsed parameters - \parma input pointer to a buffer containing a DER formatted + \param input pointer to a buffer containing a DER formatted Diffie-Hellman certificate to parse - \parma inSz size of the input buffer - \parma p pointer to a buffer in which to store the parsed prime - \parma pInOutSz pointer to a word32 object containing the available + \param inSz size of the input buffer + \param p pointer to a buffer in which to store the parsed prime + \param pInOutSz pointer to a word32 object containing the available size in the p buffer. Will be overwritten with the number of bytes written to the buffer after completing the function call - \parma g pointer to a buffer in which to store the parsed base - \parma gInOutSz pointer to a word32 object containing the available size + \param g pointer to a buffer in which to store the parsed base + \param gInOutSz pointer to a word32 object containing the available size in the g buffer. Will be overwritten with the number of bytes written to the buffer after completing the function call diff --git a/doc/dox_comments/header_files/ssl.h b/doc/dox_comments/header_files/ssl.h index ea8d4834f..a0faf7fb0 100644 --- a/doc/dox_comments/header_files/ssl.h +++ b/doc/dox_comments/header_files/ssl.h @@ -5226,7 +5226,7 @@ WOLFSSL_API int wolfSSL_CTX_use_psk_identity_hint(WOLFSSL_CTX*, const char*); \return SSL_FAILURE returned if the WOLFSSL or Arrays structures are NULL. \param ssl a pointer to a WOLFSSL structure, created using wolfSSL_new(). - \para hint a constant character pointer that holds the hint to be saved + \param hint a constant character pointer that holds the hint to be saved in memory. _Example_ diff --git a/doc/dox_comments/header_files/wc_encrypt.h b/doc/dox_comments/header_files/wc_encrypt.h index d5937d6f5..95f263853 100644 --- a/doc/dox_comments/header_files/wc_encrypt.h +++ b/doc/dox_comments/header_files/wc_encrypt.h @@ -141,7 +141,7 @@ WOLFSSL_API int wc_Des_CbcEncryptWithKey(byte* out, a Des structure. \return <0 Returned on any error during encryption. - \parma out Final encrypted data + \param out Final encrypted data \param in Data to be encrypted, must be padded to Des block size. \param sz Size of input buffer. \param key Pointer to the key to use for encryption.