1. openvpn
  2. Commit 26e3427cfa128c5d8ac7e212769ba29afac4f3d9
Browse code

plugin: Fix documentation typo for type_mask

The v3 plug-in API was slightly misleading, as that interface does not
need to use an int pointer to setting the type_mask from the plug-in.

Signed-off-by: David Sommerseth <davids@openvpn.net>
Acked-by: Selva Nair <selva.nair@gmail.com>
Message-Id: <20170508141939.31224-1-davids@openvpn.net>
URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg14576.html
Signed-off-by: David Sommerseth <davids@openvpn.net>

David Sommerseth authored on 2017/05/08 23:19:39
Showing 1 changed files
include/openvpn-plugin.h.in
History View file @ 26e3427
... ... 
@@ -328,12 +328,12 @@ struct openvpn_plugin_args_open_in
328 328 
  *
329 329 
  * STRUCT MEMBERS
330 330 
  *
331 
- * *type_mask : The plug-in should set this value to the logical OR of all script
331 
+ * type_mask  : The plug-in should set this value to the logical OR of all script
332 332 
  *              types which the plug-in wants to intercept.  For example, if the
333 333 
  *              script wants to intercept the client-connect and client-disconnect
334 334 
  *              script types:
335 335 
  *
336 
- *              *type_mask = OPENVPN_PLUGIN_MASK(OPENVPN_PLUGIN_CLIENT_CONNECT)
336 
+ *              type_mask = OPENVPN_PLUGIN_MASK(OPENVPN_PLUGIN_CLIENT_CONNECT)
337 337 
  *                         | OPENVPN_PLUGIN_MASK(OPENVPN_PLUGIN_CLIENT_DISCONNECT)
338 338 
  *
339 339 
  * *handle :    Pointer to a global plug-in context, created by the plug-in.  This pointer