From 64c7e55c1faaf03e391d44b10bc26a7587532c14 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fran=C3=A7ois=20Grisez?=
<francois.grisez@belledonne-communications.com>
Date: Tue, 29 Nov 2016 10:37:42 +0100
Subject: [PATCH] Move some documentations from source files to headers
---
coreapi/authentication.c | 13 -------------
include/linphone/core.h | 19 +++++++++++++++++++
2 files changed, 19 insertions(+), 13 deletions(-)
diff --git a/coreapi/authentication.c b/coreapi/authentication.c
index b998c941cf..9cf6a7a6d7 100644
--- a/coreapi/authentication.c
+++ b/coreapi/authentication.c
@@ -389,11 +389,6 @@ LinphoneAuthInfo * linphone_core_create_auth_info(LinphoneCore *lc, const char *
return linphone_auth_info_new(username, userid, passwd, ha1, realm, domain);
}
-/**
- * Adds authentication information to the LinphoneCore.
- *
- * This information will be used during all SIP transactions that require authentication.
-**/
void linphone_core_add_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info){
LinphoneAuthInfo *ai;
bctbx_list_t *elem;
@@ -468,9 +463,6 @@ void linphone_core_add_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info)
void linphone_core_abort_authentication(LinphoneCore *lc, LinphoneAuthInfo *info){
}
-/**
- * Removes an authentication information object.
-**/
void linphone_core_remove_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info){
LinphoneAuthInfo *r;
r=(LinphoneAuthInfo*)linphone_core_find_auth_info(lc,info->realm,info->username,info->domain);
@@ -481,11 +473,6 @@ void linphone_core_remove_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *in
}
}
-/**
- * Returns an unmodifiable list of currently entered LinphoneAuthInfo.
- * @param[in] lc The LinphoneCore object
- * @return \bctbx_list{LinphoneAuthInfo}
-**/
const bctbx_list_t *linphone_core_get_auth_info_list(const LinphoneCore *lc){
return lc->auth_info;
}
diff --git a/include/linphone/core.h b/include/linphone/core.h
index a9fa880bd7..b18637d6c1 100644
--- a/include/linphone/core.h
+++ b/include/linphone/core.h
@@ -3012,10 +3012,29 @@ LINPHONE_PUBLIC void linphone_core_set_default_proxy_config(LinphoneCore *lc, Li
*/
LINPHONE_PUBLIC LinphoneAuthInfo * linphone_core_create_auth_info(LinphoneCore *lc, const char *username, const char *userid, const char *passwd, const char *ha1, const char *realm, const char *domain);
+/**
+ * Adds authentication information to the #LinphoneCore.
+ * That piece of information will be used during all SIP transactions that require authentication.
+ * @param[in] lc The #LinphoneCore.
+ * @param[in] info The #LinphoneAuthInfo to add.
+ * @ingroup authentication
+ */
LINPHONE_PUBLIC void linphone_core_add_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
+/**
+ * Removes an authentication information object.
+ * @param[in] lc The #LinphoneCore from which the #LinphoneAuthInfo will be removed.
+ * @param[in] info The #LinphoneAuthInfo to remove.
+ * @ingroup authentication
+ */
LINPHONE_PUBLIC void linphone_core_remove_auth_info(LinphoneCore *lc, const LinphoneAuthInfo *info);
+/**
+ * Returns an unmodifiable list of currently entered #LinphoneAuthInfo.
+ * @param[in] lc The LinphoneCore object.
+ * @return \bctbx_list{LinphoneAuthInfo}
+ * @ingroup authentication
+ */
LINPHONE_PUBLIC const bctbx_list_t *linphone_core_get_auth_info_list(const LinphoneCore *lc);
/**
--
GitLab