From: "flichtenheld (Code Review)" Date: Wed, 2 Jul 2025 14:28:20 +0000 In-Reply-To: References: Reply-To: frank@...2641..., arne-openvpn@...1227..., openvpn-devel@lists.sourceforge.net, antonio@...2726... Message-ID: <13efcc80cb90207ec17afb5dc701c93e5d3c2281-EmailReplacePatchSet-HTML@...2715...> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Disposition: inline Content-Type: multipart/alternative; boundary="JxdQCRpTqY0="; 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: plaisthos Cc: openvpn-devel --JxdQCRpTqY0= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Attention is currently required from: flichtenheld, ordex, plaisthos. Hello ordex, plaisthos, I'd like you to reexamine a change. Please visit http://gerrit.openvpn.net/c/openvpn/+/1029?usp=3Demail to look at the new patch set (#2). The following approvals got outdated and were removed: Code-Review+2 by plaisthos, Code-Review-1 by ordex The change is no longer submittable: Code-Review and checks~ChecksSubmitRul= e are unsatisfied now. 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 --- M src/openvpn/crypto.h M src/openvpn/fragment.h M src/openvpn/push.c 3 files changed, 8 insertions(+), 8 deletions(-) git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/29/1029/2 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: 2 Gerrit-Owner: flichtenheld Gerrit-Reviewer: ordex Gerrit-Reviewer: plaisthos Gerrit-CC: openvpn-devel Gerrit-Attention: plaisthos Gerrit-Attention: flichtenheld Gerrit-Attention: ordex Gerrit-MessageType: newpatchset --JxdQCRpTqY0= Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

Attention is currently required from: flichtenheld, ordex, plaisthos. <= /p>

flichtenheld uploaded patch set #2 to this change.

<= p>View C= hange

The following approvals got outdated and were removed: Code-Review+2 by plaisthos, Code-Review-1 by ordex

The change is no l= onger submittable: Code-Review and checks~ChecksSubmitRule are unsatisfied = now.

Fix new doxygen warnings about using @return in void functions

= These seem to have been added in a more recent doxygen version
than I pr= eviously tested with.

Change-Id: Ia2b3eda18bd6dbce6c470037c7a01097e8= 147c29
Signed-off-by: Frank Lichtenheld <frank@...2641...>
---<= br>M src/openvpn/crypto.h
M src/openvpn/fragment.h
M src/openvpn/push= .c
3 files changed, 8 insertions(+), 8 deletions(-)

git pull s=
sh://gerrit.openvpn.net:29418/openvpn refs/changes/29/1029/2
diff -=
-git a/src/openvpn/crypto.h b/src/openvpn/crypto.h
index 5b= d1ad5..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 %buff= er 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 operat= ions.
* @param work - An initialized working %buf= fer.
* @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
* co= ntain the processed packet ready for sending, or be empty if an
<= span> * error occurred.
diff --git a/src/openvpn/fragm= ent.h b/src/openvpn/fragment.h
index 5003c96..cc96057 10064= 4
--- a/src/openvpn/fragment.h
+++ b/src/op= envpn/fragment.h
@@ -309,7 +309,7 @@
*
* @param f - The \c fragment_master structure fo= r this VPN
* tunnel.
- * @param buf - A pointer t= o the buffer structure containing the

+ * @param[in,out] buf - A pointer to the buffer structur= e containing the
* incoming packet.= This pointer will have been
* mod= ified on return either to point to a
* = completely reassembled packet, or to have length
@@ -31= 7,7 +317,8 @@
* @param frame - The packet geometry= parameters for this VPN
* tunnel.<= /span>
*
- *= @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 pack= et passed
* to this function was whole and unfragment= ed, or if it was the final
* part of a fragmented pac= ket thereby completing reassembly. On the
@@ -363,14 +364,= 15 @@
*
* @param f - The \c = fragment_master structure for this VPN
* = tunnel.
- * @para= m buf - A pointer to the buffer structure containing the+ * @param[in,out] buf - A po= inter to the buffer structure containing the
* = outgoing packet. This pointer will be modified
* to point to a whole unfragmented packet or to th= e

* first part of a fragmented pack= et on return.
* @param frame - The packet geometry= parameters for this VPN
* tunnel.<= /span>
*
- *= @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 f= irst part of the
* fragmented outgoing packet if frag= mentation was necessary. In both
diff --git a/src/openvpn/p= ush.c b/src/openvpn/push.c
index fe289f1..ad8fa3d7 100644
--- a/src/openvpn/push.c
+++ b/src/openvpn/p= ush.c
@@ -582,8 +582,6 @@
* @param tls_mu= lti 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 tl= s_multi *tls_multi, struct gc_arena *gc,

<= p>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: 2
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-Attention: plaisthos <arne-openvpn@...220...= ..1227...>
Gerrit-Attention: flichtenheld <frank@...2375...= 41...>
Gerrit-Attention: ordex <antonio@...2726...= >
Gerrit-MessageType: newpatchset
--JxdQCRpTqY0=--