From 3e8672c598befe849fb72e4452d88cfcb11365e3 Mon Sep 17 00:00:00 2001 From: Ghislain MARY Date: Wed, 1 Oct 2014 11:32:58 +0200 Subject: [PATCH] Document the LinphoneTunnelMode enum. --- coreapi/linphone_tunnel.h | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/coreapi/linphone_tunnel.h b/coreapi/linphone_tunnel.h index e07b33d7a..8bf94fcef 100644 --- a/coreapi/linphone_tunnel.h +++ b/coreapi/linphone_tunnel.h @@ -50,10 +50,13 @@ extern "C" typedef struct _LinphoneTunnelConfig LinphoneTunnelConfig; +/** + * Enum describing the tunnel modes. +**/ typedef enum _LinphoneTunnelMode { - LinphoneTunnelModeDisable, - LinphoneTunnelModeEnable, - LinphoneTunnelModeAuto + LinphoneTunnelModeDisable, /**< The tunnel is disabled. */ + LinphoneTunnelModeEnable, /**< The tunnel is enabled. */ + LinphoneTunnelModeAuto /**< The tunnel is enabled automatically if it is required. */ } LinphoneTunnelMode; /**