Documentation fixes around openvpn_plugin_func_v3 in openvpn-plugin.h.in

The comments refered to parameters found in openvpn_plugin_func_v2 but not
in v3
Acked-by: David Sommerseth <davids@openvpn.net>
Message-Id: <1611531973-443-1-git-send-email-gcox@mozilla.com>
URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg21481.html

Signed-off-by: Gert Doering <gert@greenie.muc.de>
(cherry picked from commit 595be121b60f8cee9d4816172a7f9a4987560641)
This commit is contained in:
Greg Cox 2021-01-24 23:46:13 +00:00 committed by Gert Doering
parent 75a7d795ac
commit 21f60d052e

View File

@ -666,12 +666,12 @@ OPENVPN_PLUGIN_DEF int OPENVPN_PLUGIN_FUNC(openvpn_plugin_open_v3)
* ARGUMENTS * ARGUMENTS
* *
* version : fixed value, defines the API version of the OpenVPN plug-in API. The plug-in * version : fixed value, defines the API version of the OpenVPN plug-in API. The plug-in
* should validate that this value is matching the OPENVPN_PLUGIN_VERSION value. * should validate that this value is matching the OPENVPN_PLUGINv3_STRUCTVER
* value.
* *
* handle : the openvpn_plugin_handle_t value which was returned by * arguments : Structure with all arguments available to the plug-in.
* openvpn_plugin_open.
* *
* return_list : used to return data back to OpenVPN. * retptr : used to return data back to OpenVPN.
* *
* RETURN VALUE * RETURN VALUE
* *
@ -732,8 +732,8 @@ OPENVPN_PLUGIN_DEF int OPENVPN_PLUGIN_FUNC(openvpn_plugin_open_v3)
* A given client or subnet rule applies to both incoming and outgoing * A given client or subnet rule applies to both incoming and outgoing
* packets. * packets.
* *
* See plugin/defer/simple.c for an example on using asynchronous * See sample/sample-plugins/defer/simple.c for an example on using
* authentication and client-specific packet filtering. * asynchronous authentication and client-specific packet filtering.
*/ */
OPENVPN_PLUGIN_DEF int OPENVPN_PLUGIN_FUNC(openvpn_plugin_func_v3) OPENVPN_PLUGIN_DEF int OPENVPN_PLUGIN_FUNC(openvpn_plugin_func_v3)
(const int version, (const int version,