From 217d34a16a9be3fead934f5f7c41bb0cd48e6ddb Mon Sep 17 00:00:00 2001
From: Ghislain MARY <ghislain.mary@belledonne-communications.com>
Date: Tue, 20 Dec 2016 17:48:51 +0100
Subject: [PATCH] Some documentation fixes.

---
 include/linphone/account_creator.h      | 10 +++++-----
 include/linphone/auth_info.h            |  6 +++---
 include/linphone/im_encryption_engine.h |  3 ++-
 3 files changed, 10 insertions(+), 9 deletions(-)

diff --git a/include/linphone/account_creator.h b/include/linphone/account_creator.h
index 1b678f7658..ebe8337bf9 100644
--- a/include/linphone/account_creator.h
+++ b/include/linphone/account_creator.h
@@ -156,8 +156,8 @@ LINPHONE_PUBLIC LinphoneAccountCreatorStatus linphone_account_creator_update_pas
 /**
  * Set the phone number normalized.
  * @param[in] creator LinphoneAccountCreator object
- * @param[in] phone number The phone number to set
- * @param[in] country code Country code to associate phone number with
+ * @param[in] phone_number The phone number to set
+ * @param[in] country_code Country code to associate phone number with
  * @return LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.
 **/
 LINPHONE_PUBLIC LinphoneAccountCreatorStatus linphone_account_creator_set_phone_number(LinphoneAccountCreator *creator, const char *phone_number, const char *country_code);
@@ -187,7 +187,7 @@ LINPHONE_PUBLIC const char * linphone_account_creator_get_password(const Linphon
 /**
  * Set the ha1.
  * @param[in] creator LinphoneAccountCreator object
- * @param[in] password The ha1 to set
+ * @param[in] ha1 The ha1 to set
  * @return LinphoneAccountCreatorOk if everything is OK, or a specific error otherwise.
 **/
 LINPHONE_PUBLIC LinphoneAccountCreatorStatus linphone_account_creator_set_ha1(LinphoneAccountCreator *creator, const char *ha1);
@@ -209,7 +209,7 @@ LINPHONE_PUBLIC LinphoneAccountCreatorStatus linphone_account_creator_set_activa
 /**
  * Set the language to use in email or SMS if supported.
  * @param[in] creator LinphoneAccountCreator object
- * @param[in] activation_code The language code to use
+ * @param[in] lang The language to use
 **/
 LINPHONE_PUBLIC LinphoneAccountCreatorStatus linphone_account_creator_set_language(LinphoneAccountCreator *creator, const char *lang);
 
@@ -397,7 +397,7 @@ LINPHONE_PUBLIC LinphoneAccountCreatorCbsStatusCb linphone_account_creator_cbs_g
 /**
  * Assign a user pointer to a LinphoneAccountCreatorCbs object.
  * @param[in] cbs LinphoneAccountCreatorCbs object.
- * @param[in] ud The user pointer to associate with the LinphoneAccountCreatorCbs object.
+ * @param[in] cb The update hash callback to be used.
 **/
 LINPHONE_PUBLIC void linphone_account_creator_cbs_set_update_hash(LinphoneAccountCreatorCbs *cbs, LinphoneAccountCreatorCbsStatusCb cb);
 
diff --git a/include/linphone/auth_info.h b/include/linphone/auth_info.h
index df9f12a432..b82d747e18 100644
--- a/include/linphone/auth_info.h
+++ b/include/linphone/auth_info.h
@@ -131,21 +131,21 @@ LINPHONE_PUBLIC void linphone_auth_info_set_ha1(LinphoneAuthInfo *info, const ch
 /**
  * Sets the TLS certificate.
  * @param[in] info The #LinphoneAuthInfo object
- * @param[in] ha1 The TLS certificate.
+ * @param[in] tls_cert The TLS certificate.
 **/
 LINPHONE_PUBLIC void linphone_auth_info_set_tls_cert(LinphoneAuthInfo *info, const char *tls_cert);
 
 /**
  * Sets the TLS key.
  * @param[in] info The #LinphoneAuthInfo object
- * @param[in] ha1 The TLS key.
+ * @param[in] tls_key The TLS key.
 **/
 LINPHONE_PUBLIC void linphone_auth_info_set_tls_key(LinphoneAuthInfo *info, const char *tls_key);
 
 /**
  * Sets the TLS certificate path.
  * @param[in] info The #LinphoneAuthInfo object
- * @param[in] ha1 The TLS certificate path.
+ * @param[in] tls_cert_path The TLS certificate path.
 **/
 LINPHONE_PUBLIC void linphone_auth_info_set_tls_cert_path(LinphoneAuthInfo *info, const char *tls_cert_path);
 
diff --git a/include/linphone/im_encryption_engine.h b/include/linphone/im_encryption_engine.h
index 5b6d1038f6..b41802d779 100644
--- a/include/linphone/im_encryption_engine.h
+++ b/include/linphone/im_encryption_engine.h
@@ -86,6 +86,7 @@ typedef int (*LinphoneImEncryptionEngineCbsDownloadingFileCb)(LinphoneImEncrypti
  * Callback to encrypt uploading file
  * @param engine LinphoneImEncryptionEngine object
  * @param msg LinphoneChatMessage object
+ * @param offset The current offset of the upload
  * @param buffer Encrypted data buffer
  * @param size Size of the plain data buffer and the size of the encrypted data buffer once encryption is done
  * @param encrypted_buffer Buffer in which to write the encrypted data
@@ -134,7 +135,7 @@ LINPHONE_PUBLIC LinphoneImEncryptionEngine * linphone_im_encryption_engine_ref(L
 
 /**
  * Release reference to the LinphoneImEncryptionEngine.
- * @param[in] cbs LinphoneImEncryptionEngine object.
+ * @param[in] imee LinphoneImEncryptionEngine object.
 **/
 LINPHONE_PUBLIC void linphone_im_encryption_engine_unref(LinphoneImEncryptionEngine *imee);
 
-- 
GitLab