From: "cron2 (Code Review)" Date: Wed, 2 Jul 2025 15:09:22 +0000 In-Reply-To: References: Reply-To: gert@...1296..., arne-openvpn@...1227..., openvpn-devel@lists.sourceforge.net, frank@...2641..., antonio@...2726... Message-ID: <8249d226f7f2fb61afb8e95e3371e8ee674d5019-HTML@...2715...> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Disposition: inline Content-Type: multipart/alternative; boundary="RMlpzd65pDs="; charset=UTF-8 Subject: [Openvpn-devel] [S] Change in openvpn[master]: Fix new doxygen warnings about using @return in void functions List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: flichtenheld Cc: plaisthos , openvpn-devel --RMlpzd65pDs= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable cron2 has submitted this change. ( http://gerrit.openvpn.net/c/openvpn/+/10= 29?usp=3Demail ) Change subject: Fix new doxygen warnings about using @return in void functi= ons ...................................................................... Fix new doxygen warnings about using @return in void functions These seem to have been added in a more recent doxygen version than I previously tested with. Change-Id: Ia2b3eda18bd6dbce6c470037c7a01097e8147c29 Signed-off-by: Frank Lichtenheld Acked-by: Antonio Quartulli Message-Id: <20250702150433.3871-1-gert@...1296...> URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg32= 027.html Signed-off-by: Gert Doering --- M src/openvpn/crypto.h M src/openvpn/fragment.h M src/openvpn/push.c 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/openvpn/crypto.h b/src/openvpn/crypto.h index 5bd1ad5..68ad901 100644 --- a/src/openvpn/crypto.h +++ b/src/openvpn/crypto.h @@ -467,12 +467,12 @@ * If an error occurs during processing, then the \a buf %buffer is set to * empty. * - * @param buf - The %buffer containing the packet on which to + * @param[in,out] buf - The %buffer containing the packet on which to * perform security operations. * @param work - An initialized working %buffer. * @param opt - The security parameter state for this VPN tunnel. * - * @return This function returns void.\n On return, the \a buf argument + * @note On return, the \a buf argument * will point to the resulting %buffer. This %buffer will either * contain the processed packet ready for sending, or be empty if an * error occurred. diff --git a/src/openvpn/fragment.h b/src/openvpn/fragment.h index 5003c96..cc96057 100644 --- a/src/openvpn/fragment.h +++ b/src/openvpn/fragment.h @@ -309,7 +309,7 @@ * * @param f - The \c fragment_master structure for this VPN * tunnel. - * @param buf - A pointer to the buffer structure containing the + * @param[in,out] buf - A pointer to the buffer structure containing the * incoming packet. This pointer will have been * modified on return either to point to a * completely reassembled packet, or to have length @@ -317,7 +317,8 @@ * @param frame - The packet geometry parameters for this VPN * tunnel. * - * @return Void.\n On return, the \a buf argument will point to a buffer. + * @note On return the \a buf argument buffer will be modified + * to communicate the result of the function. * The buffer will have nonzero length if the incoming packet passed * to this function was whole and unfragmented, or if it was the final * part of a fragmented packet thereby completing reassembly. On the @@ -363,14 +364,15 @@ * * @param f - The \c fragment_master structure for this VPN * tunnel. - * @param buf - A pointer to the buffer structure containing the + * @param[in,out] buf - A pointer to the buffer structure containing the * outgoing packet. This pointer will be modified * to point to a whole unfragmented packet or to the * first part of a fragmented packet on return. * @param frame - The packet geometry parameters for this VPN * tunnel. * - * @return Void.\n On return, the \a buf argument will point to a buffer. + * @note On return the \a buf argument buffer will be modified + * to communicate the result of the function. * This buffer contains either the whole original outgoing packet if * fragmentation was not necessary, or the first part of the * fragmented outgoing packet if fragmentation was necessary. In both diff --git a/src/openvpn/push.c b/src/openvpn/push.c index fe289f1..ad8fa3d7 100644 --- a/src/openvpn/push.c +++ b/src/openvpn/push.c @@ -582,8 +582,6 @@ * @param tls_multi tls multi context of VPN tunnel * @param gc gc arena for allocating push options * @param push_list push list to where options are added - * - * @return true on success, false on failure. */ void prepare_auth_token_push_reply(struct tls_multi *tls_multi, struct gc_arena= *gc, -- To view, visit http://gerrit.openvpn.net/c/openvpn/+/1029?usp=3Demail To unsubscribe, or for help writing mail filters, visit http://gerrit.openv= pn.net/settings Gerrit-Project: openvpn Gerrit-Branch: master Gerrit-Change-Id: Ia2b3eda18bd6dbce6c470037c7a01097e8147c29 Gerrit-Change-Number: 1029 Gerrit-PatchSet: 3 Gerrit-Owner: flichtenheld Gerrit-Reviewer: ordex Gerrit-Reviewer: plaisthos Gerrit-CC: openvpn-devel Gerrit-MessageType: merged --RMlpzd65pDs= Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

cron2 submitted this change.

View Change

Fix new doxygen warnings about using @return =
in void functions

These seem to have been added in a more recent dox= ygen version
than I previously tested with.

Change-Id: Ia2b3eda18= bd6dbce6c470037c7a01097e8147c29
Signed-off-by: Frank Lichtenheld <fra= nk@...2641...>
Acked-by: Antonio Quartulli <antonio@...2726...>=
Message-Id: <20250702150433.3871-1-gert@...1296...>
URL: https= ://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg32027.htmlSigned-off-by: Gert Doering <gert@...1296...>
---
M src/openv= pn/crypto.h
M src/openvpn/fragment.h
M src/openvpn/push.c
3 files = changed, 8 insertions(+), 8 deletions(-)

diff --git a/src/openvpn/crypto.h b/src/openvpn/crypto.h
index 5bd1ad5..68ad901 100644
--- a/src/openvpn/crypto.h
+++ b/src/openvpn/crypto.h
@@ -467,12 +467,1= 2 @@
* If an error occurs during processing, then the \a = buf %buffer is set to
* empty.
*=
- * @param buf - The= %buffer containing the packet on which to
+ * @param[in,out] buf - The %buffer containing the = packet on which to
* perform securi= ty operations.
* @param work - An initialized wor= king %buffer.
* @param opt - The security parame= ter state for this VPN tunnel.
*
- * @return This function returns void.\n On re= turn, the \a buf argument
+ * @note On return, the \a buf argument
* will = point to the resulting %buffer. This %buffer will either
= * contain the processed packet ready for sending, or be empty if an
* error occurred.
diff --git a/src/open= vpn/fragment.h b/src/openvpn/fragment.h
index 5003c96..cc96= 057 100644
--- a/src/openvpn/fragment.h
+++= b/src/openvpn/fragment.h
@@ -309,7 +309,7 @@
*

* @param f - The \c fragment_master str= ucture for this VPN
* tunnel.

- * @param buf - A = pointer to the buffer structure containing the
+ * @param[in,out] buf - A pointer to the buffer= structure containing the
* incomin= g packet. This pointer will have been
* = modified on return either to point to a
* = completely reassembled packet, or to have length
@@ -317,7 +317,8 @@
* @param frame - The packet= geometry parameters for this VPN
* = tunnel.
*
- * @return Void.\n On return, the \a buf argument will point to a bu= ffer.
+ * @note On re= turn the \a buf argument buffer will be modified
+ * to communicate the result of the functi= on.
* The buffer will have nonzero length if the inco= ming packet passed
* to this function was whole and u= nfragmented, or if it was the final
* part of a fragm= ented packet thereby completing reassembly. On the
@@ -363= ,14 +364,15 @@
*
* @param f = - The \c fragment_master structure for this VPN
* = tunnel.
= - * @param buf - A pointer to the buffer structure containing the<= /span>
+ * @param[in,out] bu= f - A pointer to the buffer structure containing the
* = outgoing packet. This pointer will be modified=
* to point to a whole unfragmented packet= or to the
* first part of a fragme= nted packet on return.
* @param frame - The packet= geometry parameters for this VPN
* = tunnel.
*
- * @return Void.\n On return, the \a buf argument will point to a bu= ffer.
+ * @note On re= turn the \a buf argument buffer will be modified
+ * to communicate the result of the functi= on.
* This buffer contains either the whole original = outgoing packet if
* fragmentation was not necessary,= or the first part of the
* fragmented outgoing packe= t if fragmentation was necessary. In both
diff --git a/src/= openvpn/push.c b/src/openvpn/push.c
index fe289f1..ad8fa3d7= 100644
--- a/src/openvpn/push.c
+++ b/src/= openvpn/push.c
@@ -582,8 +582,6 @@
* @par= am tls_multi tls multi context of VPN tunnel
* @param= gc gc arena for allocating push options
* @pa= ram push_list push list to where options are added
- *
- * @return true on success, false on failure.
*/

void
prepare_auth_token_push_reply(= struct tls_multi *tls_multi, struct gc_arena *gc,

To view, visit change 1029. To unsubscribe, or for help writing mail= filters, visit settings= .

Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: Ia2b3eda18bd6dbce6c470037c7a= 01097e8147c29
Gerrit-Change-Number: 1029
Gerrit-PatchSet: 3
Gerrit-Owner: flichtenheld <frank@...2723...= .>
Gerrit-Reviewer: ordex <antonio@...2726...&= gt;
Gerrit-Reviewer: plaisthos <arne-openvpn@...1186...= .1227...>
Gerrit-CC: openvpn-devel <openvpn-devel@...1484...= ts.sourceforge.net>
Gerrit-MessageType: merged
--RMlpzd65pDs=--