From 8599aec3e5cf04afa3780885ffd78a3063abed22 Mon Sep 17 00:00:00 2001 From: Ronan Abhamon Date: Wed, 1 Mar 2017 15:18:42 +0100 Subject: [PATCH] add doc on lime functions/enums --- include/linphone/core.h | 17 ++++++++++++++++- include/linphone/types.h | 3 +++ 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/include/linphone/core.h b/include/linphone/core.h index 94988c67c..c54e3b7b9 100644 --- a/include/linphone/core.h +++ b/include/linphone/core.h @@ -1488,12 +1488,27 @@ LINPHONE_PUBLIC bool_t linphone_core_get_guess_hostname(LinphoneCore *lc); /** * Tells to LinphoneCore to use Linphone Instant Messaging encryption - * + * @param[in] lc LinphoneCore object + * @param[in] val The new lime state + * @ingroup network_parameters */ LINPHONE_PUBLIC void linphone_core_enable_lime(LinphoneCore *lc, LinphoneLimeState val); + +/** + * Returns the lime state + * @param[in] lc LinphoneCore object + * @return The current lime state + * @ingroup network_parameters +**/ LINPHONE_PUBLIC LinphoneLimeState linphone_core_lime_enabled(const LinphoneCore *lc); + +/** + * Tells if lime is available + * @param[in] lc LinphoneCore object + * @ingroup network_parameters +**/ LINPHONE_PUBLIC bool_t linphone_core_lime_available(const LinphoneCore *lc); /** diff --git a/include/linphone/types.h b/include/linphone/types.h index 74fe0152e..81194c9da 100644 --- a/include/linphone/types.h +++ b/include/linphone/types.h @@ -516,6 +516,9 @@ typedef struct _LinphoneLDAPContactProvider LinphoneLDAPContactProvider; typedef struct _LinphoneLDAPContactSearch LinphoneLDAPContactSearch; +/** + * @ingroup network_parameters + */ typedef enum _LinphoneLimeState { LinphoneLimeDisabled, /**< Lime is not used at all */ LinphoneLimeMandatory, /**< Lime is always used */