[Openvpn-devel,v1] Fix doxygen warnings in crypto_epoch.h

Message ID 20250129182818.3041-1-gert@greenie.muc.de
State Accepted
Headers show
Series [Openvpn-devel,v1] Fix doxygen warnings in crypto_epoch.h | expand

Commit Message

Gert Doering Jan. 29, 2025, 6:28 p.m. UTC
From: Frank Lichtenheld <frank@lichtenheld.com>

Introduced by commit 92adbc88b1b37095cebde2a1c5b6ae242f382678.

Change-Id: I0133085ac68f7b0db574b88276f6d5e1d3ad62d5
Signed-off-by: Frank Lichtenheld <frank@lichtenheld.com>
Acked-by: Arne Schwabe <arne-openvpn@rfc2549.org>
---

This change was reviewed on Gerrit and approved by at least one
developer. I request to merge it to master.

Gerrit URL: https://gerrit.openvpn.net/c/openvpn/+/877
This mail reflects revision 1 of this Change.

Acked-by according to Gerrit (reflected above):
Arne Schwabe <arne-openvpn@rfc2549.org>

Comments

Gert Doering Jan. 29, 2025, 7:22 p.m. UTC | #1
Well spotted ;-)

Your patch has been applied to the master branch.

commit b6a2533a3fb29eafe78a2432eaf9adaa0e707420
Author: Frank Lichtenheld
Date:   Wed Jan 29 19:28:18 2025 +0100

     Fix doxygen warnings in crypto_epoch.h

     Signed-off-by: Frank Lichtenheld <frank@lichtenheld.com>
     Acked-by: Arne Schwabe <arne-openvpn@rfc2549.org>
     Message-Id: <20250129182818.3041-1-gert@greenie.muc.de>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg30731.html
     Signed-off-by: Gert Doering <gert@greenie.muc.de>


--
kind regards,

Gert Doering

Patch

diff --git a/src/openvpn/crypto_epoch.h b/src/openvpn/crypto_epoch.h
index b2f3d86..9290482 100644
--- a/src/openvpn/crypto_epoch.h
+++ b/src/openvpn/crypto_epoch.h
@@ -71,7 +71,7 @@ 
  * Generate a data channel key pair from the epoch key
  * @param key           Destination for the generated data key
  * @param epoch_key     Epoch key to be used
- * @parm kt             Cipher information to generate the data channel key for
+ * @param kt            Cipher information to generate the data channel key for
  */
 void
 epoch_data_key_derive(struct key_parameters *key,
@@ -100,6 +100,7 @@ 
  * - recv key matches the epoch index provided
  * - send key epoch is equal or higher than recv_key epoch
  *
+ * @param co        crypto_options to update
  * @param new_epoch the new epoch to use for the receive key
  */
 void