From: "flichtenheld (Code Review)" Date: Tue, 20 May 2025 13:33:53 +0000 References: Reply-To: frank@...2641..., arne-openvpn@...1227..., openvpn-devel@lists.sourceforge.net Message-ID: <233cf874415adff20d3d91e0ea66eaf38a3baa8e-HTML@...2715...> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Disposition: inline Content-Type: multipart/alternative; boundary="+RWVsn32nZM="; 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 --+RWVsn32nZM= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Attention is currently required from: plaisthos. Hello plaisthos, I'd like you to do a code review. Please visit http://gerrit.openvpn.net/c/openvpn/+/1029?usp=3Demail to review the following change. 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, 10 insertions(+), 8 deletions(-) git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/29/1029/1 diff --git a/src/openvpn/crypto.h b/src/openvpn/crypto.h index 94f1f7f..9c4ee77 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 This function returns void.\n 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 91f4a26..d426dfd 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,9 @@ * @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 Does not have a return value.\n + * However, 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 +365,16 @@ * * @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 Does not have a return value.\n + * However, 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 c97ce28..24490bb 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: 1 Gerrit-Owner: flichtenheld Gerrit-Reviewer: plaisthos Gerrit-CC: openvpn-devel Gerrit-Attention: plaisthos Gerrit-MessageType: newchange --+RWVsn32nZM= Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

Attention is currently required from: plaisthos.

flichtenheld would like plaisthos to review this change.

V= iew Change

Fix new doxygen warnings about using @return in void functio=
ns

These seem to have been added in a more recent doxygen versionthan I previously tested with.

Change-Id: Ia2b3eda18bd6dbce6c470037= c7a01097e8147c29
Signed-off-by: Frank Lichtenheld <frank@...2641...&g= t;
---
M src/openvpn/crypto.h
M src/openvpn/fragment.h
M src/op= envpn/push.c
3 files changed, 10 insertions(+), 8 deletions(-)

git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/29/1029/1
<=
span>diff --git a/src/openvpn/crypto.h b/src/openvpn/crypto.h
index 94f1f7f..9c4ee77 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 - T= he %buffer containing the packet on which to
+ * @param[in,out] buf - The %buffer containing th= e packet on which to
* perform secu= rity operations.
* @param work - An initialized w= orking %buffer.
* @param opt - The security para= meter state for this VPN tunnel.
*
- * @return This function returns void.\n On= return, the \a buf argument
+ * @note This function returns void.\n On return, the \a buf argum= ent
* will point to the resulting %buffer. This %buf= fer 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 91f4a26..d426dfd 100644
--- a/src/openv= pn/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,ou= t] buf - A pointer to the buffer structure containing the
= * incoming packet. This pointer will have been

* modified on return either to point t= o a
* completely reassembled packet= , or to have length
@@ -317,7 +317,9 @@
*= @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 Does not have a return value.\n
+ * However, on return, the \a b= uf argument buffer will be modified
+ * to communicate the result of the function. * The buffer will have nonzero length if the incoming packet p= assed
* 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 +365,16 @= @
*
* @param f - The \c frag= ment_master structure for this VPN
* = tunnel.
- * @param bu= f - A pointer to the buffer structure containing the
+ * @param[in,out] buf - A pointe= r 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 o= n return.
* @param frame - The packet geometry par= ameters for this VPN
* tunnel.
*
- * @re= turn Void.\n On return, the \a buf argument will point to a buffer.<= br>+ * @note Does not have a re= turn value.\n
+ * = However, on return, the \a buf argument buffer will be modified
= + * to communicate the resu= lt of the function.
* This buffer contains either the= whole original outgoing packet if
* fragmentation wa= s not necessary, or the first part of the
* fragmente= d outgoing packet if fragmentation was necessary. In both
d= iff --git a/src/openvpn/push.c b/src/openvpn/push.c
index c= 97ce28..24490bb 100644
--- a/src/openvpn/push.c
<= span>+++ b/src/openvpn/push.c

@@ -582,8 +582,6 @@ * @param tls_multi tls multi context of VPN tunnel
<= span> * @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.<= /span>
*/
void
prepare_auth_to= ken_push_reply(struct tls_multi *tls_multi, struct gc_arena *gc,
=

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

<= /div>
Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: Ia2b3eda18bd6dbce6c470037c7a= 01097e8147c29
Gerrit-Change-Number: 1029
Gerrit-PatchSet: 1
Gerrit-Owner: flichtenheld <frank@...2723...= .>
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-MessageType: newchange
--+RWVsn32nZM=--