Browse code

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>

Greg Cox authored on 2021/01/25 08:46:13
Showing 1 changed files
... ...
@@ -670,12 +670,12 @@ OPENVPN_PLUGIN_DEF int OPENVPN_PLUGIN_FUNC(openvpn_plugin_open_v3)
670 670
  * ARGUMENTS
671 671
  *
672 672
  * version : fixed value, defines the API version of the OpenVPN plug-in API.  The plug-in
673
- *           should validate that this value is matching the OPENVPN_PLUGIN_VERSION value.
673
+ *           should validate that this value is matching the OPENVPN_PLUGINv3_STRUCTVER
674
+ *           value.
674 675
  *
675
- * handle : the openvpn_plugin_handle_t value which was returned by
676
- *          openvpn_plugin_open.
676
+ * arguments : Structure with all arguments available to the plug-in.
677 677
  *
678
- * return_list : used to return data back to OpenVPN.
678
+ * retptr :    used to return data back to OpenVPN.
679 679
  *
680 680
  * RETURN VALUE
681 681
  *
... ...
@@ -736,8 +736,8 @@ OPENVPN_PLUGIN_DEF int OPENVPN_PLUGIN_FUNC(openvpn_plugin_open_v3)
736 736
  * A given client or subnet rule applies to both incoming and outgoing
737 737
  * packets.
738 738
  *
739
- * See plugin/defer/simple.c for an example on using asynchronous
740
- * authentication and client-specific packet filtering.
739
+ * See sample/sample-plugins/defer/simple.c for an example on using
740
+ * asynchronous authentication and client-specific packet filtering.
741 741
  */
742 742
 OPENVPN_PLUGIN_DEF int OPENVPN_PLUGIN_FUNC(openvpn_plugin_func_v3)
743 743
     (const int version,