From patchwork Wed Jul 2 15:04:27 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Gert Doering X-Patchwork-Id: 4296 Return-Path: Delivered-To: patchwork@openvpn.net Received: by 2002:a05:7000:3846:b0:671:5a2c:6455 with SMTP id n6csp3945495mal; Wed, 2 Jul 2025 08:04:57 -0700 (PDT) X-Forwarded-Encrypted: i=2; AJvYcCVu2w/GtHTzbeaYr08jFfzLIi7L7iqfIomNMR9sRhVapq15FbPdY8a/SL3/jPWTk8DS3MX1TzxCQOg=@openvpn.net X-Google-Smtp-Source: AGHT+IFPtT9npQSb4l/+goR25/N1QXD8+BpkBSk1YCz/ppI0PgBw/co2lWapPvGIJgjG9HJJVt+E X-Received: by 2002:a05:6870:5e09:b0:2e9:365:d0d3 with SMTP id 586e51a60fabf-2f5c7c5356cmr2239955fac.21.1751468697327; Wed, 02 Jul 2025 08:04:57 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1751468697; cv=none; d=google.com; s=arc-20240605; b=UR8+ZfdOxKcnXozC/Wc5tkl2ngAnARD1o8vPuX55GyI18rfcq0DGtcb5Xyo55wzlor 1dvQmskG6nk9DIxuBGQzkBlkg2BW/E9yFR7QnKlYo1WHYmNRHDdgJWG1BX2hSw3DuxNo Jlckv3AoQrWCnGnBkILcTcbOevJ4/VI3spjORvw8B2gMJSU3+qaT1Ge7euLlL0398L12 xg/agN7ptLWhfAG96JI0GWBkQfdMX17qOInFg2rMj6mstz2DkhiCxr2uhtyyHZlcaOIm L2qMMX1h/XvWrIdaKxi5r8xYUs56PSDoBqCN0bfmF0qnn9LAl3xUCNrRQDL35TIhRBBp sFJg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20240605; h=errors-to:content-transfer-encoding:list-subscribe:list-help :list-post:list-archive:list-unsubscribe:list-id:precedence:subject :mime-version:references:in-reply-to:message-id:date:to:from :dkim-signature:dkim-signature:dkim-signature; bh=64AuzKnnEI3vtSrmP1A7ErW5tlnsEhYYlq/NwW1ckaw=; fh=4NbAC/LsuMLI0S0hprUlLSLCiHwg6SCAifhH718Jh0Q=; b=QS7ZgAAPWBJ72bndPtyEZTeTdWWWXOWMYoWfjCLWrCa0t2IreLRK+LuTNGgj0gSckv H173xbepx2LrrluZB4fsJik7jc3kdf13fer3OwowlnJChKZogUFpHHsgqXlV/19gMZUb bFRWGFRXBmshyXpkPn2fDuiZnHfiNnhYLyK/Ic3jCu0I/m0/cRTtkm/oDz8RE/vAxIwl +C4UQ7xff7qkfrYeTNlBbS+unYQJRRJFmNItHhYyOmHntCESm3ovKppD0MZrCNUvdRwN wpnhTSNz/B9UrsUFfLF2b8294NiJYP3XnUeEI4tlFdd+vWLZHhaLTyWaHAbPCq9c3S5p OcHw==; dara=google.com ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@lists.sourceforge.net header.s=beta header.b=WrLt2baY; dkim=neutral (body hash did not verify) header.i=@sourceforge.net header.s=x header.b=WQzouSFL; dkim=neutral (body hash did not verify) header.i=@sf.net header.s=x header.b=F443Ga+1; spf=pass (google.com: domain of openvpn-devel-bounces@lists.sourceforge.net designates 216.105.38.7 as permitted sender) smtp.mailfrom=openvpn-devel-bounces@lists.sourceforge.net; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=muc.de Received: from lists.sourceforge.net (lists.sourceforge.net. [216.105.38.7]) by mx.google.com with ESMTPS id 586e51a60fabf-2efd4fd4cbfsi11222637fac.160.2025.07.02.08.04.57 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Wed, 02 Jul 2025 08:04:57 -0700 (PDT) Received-SPF: pass (google.com: domain of openvpn-devel-bounces@lists.sourceforge.net designates 216.105.38.7 as permitted sender) client-ip=216.105.38.7; Authentication-Results: mx.google.com; dkim=pass header.i=@lists.sourceforge.net header.s=beta header.b=WrLt2baY; dkim=neutral (body hash did not verify) header.i=@sourceforge.net header.s=x header.b=WQzouSFL; dkim=neutral (body hash did not verify) header.i=@sf.net header.s=x header.b=F443Ga+1; spf=pass (google.com: domain of openvpn-devel-bounces@lists.sourceforge.net designates 216.105.38.7 as permitted sender) smtp.mailfrom=openvpn-devel-bounces@lists.sourceforge.net; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=muc.de DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.sourceforge.net; s=beta; h=Content-Transfer-Encoding:Content-Type: List-Subscribe:List-Help:List-Post:List-Archive:List-Unsubscribe:List-Id: Subject:MIME-Version:References:In-Reply-To:Message-ID:Date:To:From:Sender: Reply-To:Cc:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=64AuzKnnEI3vtSrmP1A7ErW5tlnsEhYYlq/NwW1ckaw=; b=WrLt2baY8TJ3Wf1y9EriIVzqSO Mew6yJXZN2KtMpgHMEwlaJv1PBUGcFDtO3wXcl55uyhpBHltH0TYWGHdbOp3bAqeyY7+8CBuPBS3d IEk53/Q3tvsKZWfo/oRm8l4vK67zTrovtZet1QyMeWvFcXX1tOLtNBSkgWLGU8gLJ3ck=; Received: from [127.0.0.1] (helo=sfs-ml-3.v29.lw.sourceforge.com) by sfs-ml-3.v29.lw.sourceforge.com with esmtp (Exim 4.95) (envelope-from ) id 1uWz0y-0005d8-P8; Wed, 02 Jul 2025 15:04:48 +0000 Received: from [172.30.29.66] (helo=mx.sourceforge.net) by sfs-ml-3.v29.lw.sourceforge.com with esmtps (TLS1.2) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.95) (envelope-from ) id 1uWz0x-0005d0-FI for openvpn-devel@lists.sourceforge.net; Wed, 02 Jul 2025 15:04:47 +0000 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=sourceforge.net; s=x; h=Content-Transfer-Encoding:MIME-Version:References: In-Reply-To:Message-ID:Date:Subject:To:From:Sender:Reply-To:Cc:Content-Type: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=dsZrVR3jpjJUYu2HLJpFCIpmdVvyO5jFdpPz0k6TbUE=; b=WQzouSFLcDmqOraNQurXnGIkBz AW//8w6Do2YAO1eqqgatNA5t4xRuBJBH+S2YYYcL3UfbS6unXcc8SRmzOzPihiqELXU0NFSjL7/wz heOvnIvTdiWvyXQh5bXinIf3knWajSSHnTAB5/4mFnvwcs2NlJPewStdDMWDdyD+e8wA=; DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=sf.net; s=x ; h=Content-Transfer-Encoding:MIME-Version:References:In-Reply-To:Message-ID: Date:Subject:To:From:Sender:Reply-To:Cc:Content-Type:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:List-Id:List-Help:List-Unsubscribe:List-Subscribe: List-Post:List-Owner:List-Archive; bh=dsZrVR3jpjJUYu2HLJpFCIpmdVvyO5jFdpPz0k6TbUE=; b=F443Ga+1SF9m7mWaBiCf8r88na cuQe+8ns2YyaPv5Cobf6g9YIR2smeKTIvZ283+1amkGv5FlG9EJCcRb8ppZ9DhM2Ek/hxqeRJOpbu P1Vk40wtOwSHeiP4bJSwcNhxpWbItj0vYjd4jeb4xuyXrTwzRbDAkxcq1CmwnuWN9DDo=; Received: from [193.149.48.143] (helo=blue.greenie.muc.de) by sfi-mx-2.v28.lw.sourceforge.com with esmtps (TLS1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.95) id 1uWz0v-0004qN-Vo for openvpn-devel@lists.sourceforge.net; Wed, 02 Jul 2025 15:04:47 +0000 Received: from blue.greenie.muc.de (localhost [127.0.0.1]) by blue.greenie.muc.de (8.17.1.9/8.17.1.9) with ESMTP id 562F4Xn6003889 for ; Wed, 2 Jul 2025 17:04:33 +0200 Received: (from gert@localhost) by blue.greenie.muc.de (8.17.1.9/8.17.1.9/Submit) id 562F4Xre003888 for openvpn-devel@lists.sourceforge.net; Wed, 2 Jul 2025 17:04:33 +0200 From: Gert Doering To: openvpn-devel@lists.sourceforge.net Date: Wed, 2 Jul 2025 17:04:27 +0200 Message-ID: <20250702150433.3871-1-gert@greenie.muc.de> X-Mailer: git-send-email 2.49.0 In-Reply-To: References: MIME-Version: 1.0 X-Spam-Score: 1.3 (+) X-Spam-Report: Spam detection software, running on the system "sfi-spamd-1.hosts.colo.sdot.me", has NOT identified this incoming email as spam. The original message has been attached to this so you can view it or label similar future email. If you have any questions, see the administrator of that system for details. Content preview: From: Frank Lichtenheld 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 --- Content analysis details: (1.3 points, 5.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- 1.3 RDNS_NONE Delivered to internal network by a host with no rDNS X-Headers-End: 1uWz0v-0004qN-Vo Subject: [Openvpn-devel] [PATCH v2] Fix new doxygen warnings about using @return in void functions X-BeenThere: openvpn-devel@lists.sourceforge.net X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: openvpn-devel-bounces@lists.sourceforge.net X-getmail-retrieved-from-mailbox: Inbox X-GMAIL-THRID: =?utf-8?q?1836548040965589768?= X-GMAIL-MSGID: =?utf-8?q?1836548040965589768?= From: Frank Lichtenheld 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 --- 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/+/1029 This mail reflects revision 2 of this Change. Acked-by according to Gerrit (reflected above): Antonio Quartulli 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,