cron2 has submitted this change. ( http://gerrit.openvpn.net/c/openvpn/+/1029?usp=email )
Change subject: Fix new doxygen warnings about using @return in void functions ...................................................................... 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 <fr...@lichtenheld.com> Acked-by: Antonio Quartulli <anto...@mandelbit.com> Message-Id: <20250702150433.3871-1-g...@greenie.muc.de> URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg32027.html Signed-off-by: Gert Doering <g...@greenie.muc.de> --- 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=email To unsubscribe, or for help writing mail filters, visit http://gerrit.openvpn.net/settings Gerrit-Project: openvpn Gerrit-Branch: master Gerrit-Change-Id: Ia2b3eda18bd6dbce6c470037c7a01097e8147c29 Gerrit-Change-Number: 1029 Gerrit-PatchSet: 3 Gerrit-Owner: flichtenheld <fr...@lichtenheld.com> Gerrit-Reviewer: ordex <anto...@mandelbit.com> Gerrit-Reviewer: plaisthos <arne-open...@rfc2549.org> Gerrit-CC: openvpn-devel <openvpn-devel@lists.sourceforge.net> Gerrit-MessageType: merged
_______________________________________________ Openvpn-devel mailing list Openvpn-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/openvpn-devel
