diff --git a/coreapi/address.c b/coreapi/address.c index 13fc15d3a..8f4cb9df4 100644 --- a/coreapi/address.c +++ b/coreapi/address.c @@ -197,7 +197,8 @@ bool_t linphone_address_get_secure(const LinphoneAddress *uri){ /** * Make the address refer to a secure location (sips scheme) - * @param enabled TRUE if address is requested to be secure. + * @param[in] addr A #LinphoneAddress object + * @param[in] enabled TRUE if address is requested to be secure. **/ void linphone_address_set_secure(LinphoneAddress *addr, bool_t enabled){ sal_address_set_secure(addr, enabled); diff --git a/coreapi/call_params.h b/coreapi/call_params.h index e536280a4..b39f1d59d 100644 --- a/coreapi/call_params.h +++ b/coreapi/call_params.h @@ -251,7 +251,7 @@ LINPHONE_PUBLIC void linphone_call_params_set_media_encryption(LinphoneCallParam * @param[in] cp LinphoneCallParams object * @param[in] privacy The privacy mode to used for the call. **/ -LINPHONE_PUBLIC void linphone_call_params_set_privacy(LinphoneCallParams *params, LinphonePrivacyMask privacy); +LINPHONE_PUBLIC void linphone_call_params_set_privacy(LinphoneCallParams *cp, LinphonePrivacyMask privacy); /** * Enable recording of the call. @@ -288,29 +288,29 @@ LINPHONE_PUBLIC bool_t linphone_call_params_video_enabled(const LinphoneCallPara /** * Get the audio stream direction. - * @param[in] cl LinphoneCallParams object + * @param[in] cp LinphoneCallParams object * @return The audio stream direction associated with the call params. **/ LINPHONE_PUBLIC LinphoneMediaDirection linphone_call_params_get_audio_direction(const LinphoneCallParams *cp); /** * Get the video stream direction. - * @param[in] cl LinphoneCallParams object + * @param[in] cp LinphoneCallParams object * @return The video stream direction associated with the call params. **/ LINPHONE_PUBLIC LinphoneMediaDirection linphone_call_params_get_video_direction(const LinphoneCallParams *cp); /** * Set the audio stream direction. - * @param[in] cl LinphoneCallParams object - * @param[in] The audio stream direction associated with this call params. + * @param[in] cp LinphoneCallParams object + * @param[in] dir The audio stream direction associated with this call params. **/ LINPHONE_PUBLIC void linphone_call_params_set_audio_direction(LinphoneCallParams *cp, LinphoneMediaDirection dir); /** * Set the video stream direction. - * @param[in] cl LinphoneCallParams object - * @param[in] The video stream direction associated with this call params. + * @param[in] cp LinphoneCallParams object + * @param[in] dir The video stream direction associated with this call params. **/ LINPHONE_PUBLIC void linphone_call_params_set_video_direction(LinphoneCallParams *cp, LinphoneMediaDirection dir); @@ -321,28 +321,28 @@ LINPHONE_PUBLIC void linphone_call_params_set_video_direction(LinphoneCallParams /** * Get the user data associated with the call params. - * @param[in] cl LinphoneCallParams object + * @param[in] cp LinphoneCallParams object * @return The user data associated with the call params. **/ LINPHONE_PUBLIC void *linphone_call_params_get_user_data(const LinphoneCallParams *cp); /** * Assign a user data to the call params. - * @param[in] cl LinphoneCallParams object + * @param[in] cp LinphoneCallParams object * @param[in] ud The user data to associate with the call params. **/ LINPHONE_PUBLIC void linphone_call_params_set_user_data(LinphoneCallParams *cp, void *ud); /** * Acquire a reference to the call params. - * @param[in] cl LinphoneCallParams object + * @param[in] cp LinphoneCallParams object * @return The same LinphoneCallParams object **/ LINPHONE_PUBLIC LinphoneCallParams * linphone_call_params_ref(LinphoneCallParams *cp); /** * Release a reference to the call params. - * @param[in] cl LinphoneCallParams object + * @param[in] cp LinphoneCallParams object **/ LINPHONE_PUBLIC void linphone_call_params_unref(LinphoneCallParams *cp); @@ -351,29 +351,30 @@ LINPHONE_PUBLIC void linphone_call_params_unref(LinphoneCallParams *cp); * Use to enable multicast rtp for audio stream. * * If enabled, outgoing calls put a multicast address from #linphone_core_get_video_multicast_addr into audio cline. In case of outgoing call audio stream is sent to this multicast address. *
For incoming calls behavior is unchanged. - * @param core #LinphoneCallParams + * @param params #LinphoneCallParams * @param yesno if yes, subsequent calls will propose multicast ip set by #linphone_core_set_audio_multicast_addr * @ingroup media_parameters **/ -LINPHONE_PUBLIC void linphone_call_params_enable_audio_multicast(LinphoneCallParams *param, bool_t yesno); +LINPHONE_PUBLIC void linphone_call_params_enable_audio_multicast(LinphoneCallParams *params, bool_t yesno); /** * Use to get multicast state of audio stream. - * @param core #LinphoneCallParams + * @param params #LinphoneCallParams * @return true if subsequent calls will propose multicast ip set by #linphone_core_set_audio_multicast_addr * @ingroup media_parameters **/ -LINPHONE_PUBLIC bool_t linphone_call_params_audio_multicast_enabled(const LinphoneCallParams *param); +LINPHONE_PUBLIC bool_t linphone_call_params_audio_multicast_enabled(const LinphoneCallParams *params); /** * Use to enable multicast rtp for video stream. * If enabled, outgoing calls put a multicast address from #linphone_core_get_video_multicast_addr into video cline. In case of outgoing call video stream is sent to this multicast address. *
For incoming calls behavior is unchanged. - * @param core #LinphoneCallParams + * @param params #LinphoneCallParams * @param yesno if yes, subsequent outgoing calls will propose multicast ip set by #linphone_core_set_video_multicast_addr * @ingroup media_parameters **/ LINPHONE_PUBLIC void linphone_call_params_enable_video_multicast(LinphoneCallParams *params, bool_t yesno); + /** * Use to get multicast state of video stream. * @param params #LinphoneCallParams diff --git a/coreapi/conference.h b/coreapi/conference.h index d14ff2f9d..0de492b7e 100644 --- a/coreapi/conference.h +++ b/coreapi/conference.h @@ -55,23 +55,27 @@ typedef struct _LinphoneCorferenceParams LinphoneConferenceParams; * @return A freshly allocated #LinphoneConferenceParams */ LINPHONE_PUBLIC LinphoneConferenceParams *linphone_conference_params_new(const LinphoneCore *core); + /** * Free a #LinphoneConferenceParams * @param params #LinphoneConferenceParams to free */ LINPHONE_PUBLIC void linphone_conference_params_free(LinphoneConferenceParams *params); + /** * Clone a #LinphoneConferenceParams - * @param params The #LinphoneConfrenceParams to clone + * @param params The #LinphoneConferenceParams to clone * @return An allocated #LinphoneConferenceParams with the same parameters than params */ LINPHONE_PUBLIC LinphoneConferenceParams *linphone_conference_params_clone(const LinphoneConferenceParams *params); + /** * Enable video when starting a conference - * @param params A #LinphoneConnferenceParams + * @param params A #LinphoneConferenceParams * @param enable If true, video will be enabled during conference */ LINPHONE_PUBLIC void linphone_conference_params_enable_video(LinphoneConferenceParams *params, bool_t enable); + /** * Check whether video will be enable at conference starting * @return if true, the video will be enable at conference starting @@ -90,6 +94,7 @@ LINPHONE_PUBLIC bool_t linphone_conference_params_video_requested(const Linphone * @return 0 if succeeded, -1 if failed */ LINPHONE_PUBLIC int linphone_conference_remove_participant(LinphoneConference *obj, const LinphoneAddress *uri); + /** * Get URIs of all participants of one conference * The returned MSList contains URIs of all participant. That list must be diff --git a/coreapi/event.h b/coreapi/event.h index 0c8c16215..478108c5c 100644 --- a/coreapi/event.h +++ b/coreapi/event.h @@ -228,11 +228,11 @@ LINPHONE_PUBLIC int linphone_event_update_publish(LinphoneEvent *lev, const Linp LINPHONE_PUBLIC int linphone_event_refresh_publish(LinphoneEvent *lev); /** - * Prevent an event from refreshing its publish. + * Prevent an event from refreshing its publish. * This is useful to let registrations to expire naturally (or) when the application wants to keep control on when * refreshes are sent. * The refreshing operations can be resumed with linphone_proxy_config_refresh_register(). - * @param[in] cfg #LinphoneEvent object. + * @param[in] lev #LinphoneEvent object. **/ LINPHONE_PUBLIC void linphone_event_pause_publish(LinphoneEvent *lev); diff --git a/coreapi/friendlist.h b/coreapi/friendlist.h index 567e389e5..46bc711cd 100644 --- a/coreapi/friendlist.h +++ b/coreapi/friendlist.h @@ -156,7 +156,7 @@ LINPHONE_PUBLIC void linphone_friend_list_set_rls_uri(LinphoneFriendList *list, /** * Add a friend to a friend list. If or when a remote CardDAV server will be attached to the list, the friend will be sent to the server. * @param[in] list LinphoneFriendList object. - * @param[in] friend LinphoneFriend object to add to the friend list. + * @param[in] lf LinphoneFriend object to add to the friend list. * @return LinphoneFriendListOK if successfully added, LinphoneFriendListInvalidFriend if the friend is not valid. **/ LINPHONE_PUBLIC LinphoneFriendListStatus linphone_friend_list_add_friend(LinphoneFriendList *list, LinphoneFriend *lf); @@ -165,7 +165,7 @@ LINPHONE_PUBLIC LinphoneFriendListStatus linphone_friend_list_add_friend(Linphon * Add a friend to a friend list. The friend will never be sent to a remote CardDAV server. * Warning! LinphoneFriends added this way will be removed on the next synchronization, and the callback contact_deleted will be called. * @param[in] list LinphoneFriendList object. - * @param[in] friend LinphoneFriend object to add to the friend list. + * @param[in] lf LinphoneFriend object to add to the friend list. * @return LinphoneFriendListOK if successfully added, LinphoneFriendListInvalidFriend if the friend is not valid. **/ LINPHONE_PUBLIC LinphoneFriendListStatus linphone_friend_list_add_local_friend(LinphoneFriendList *list, LinphoneFriend *lf); @@ -173,10 +173,10 @@ LINPHONE_PUBLIC LinphoneFriendListStatus linphone_friend_list_add_local_friend(L /** * Remove a friend from a friend list. * @param[in] list LinphoneFriendList object. - * @param[in] friend LinphoneFriend object to remove from the friend list. + * @param[in] lf LinphoneFriend object to remove from the friend list. * @return LinphoneFriendListOK if removed successfully, LinphoneFriendListNonExistentFriend if the friend is not in the list. **/ -LINPHONE_PUBLIC LinphoneFriendListStatus linphone_friend_list_remove_friend(LinphoneFriendList *list, LinphoneFriend *afriend); +LINPHONE_PUBLIC LinphoneFriendListStatus linphone_friend_list_remove_friend(LinphoneFriendList *list, LinphoneFriend *lf); /** * Retrieves the list of LinphoneFriend from this LinphoneFriendList. @@ -228,7 +228,7 @@ LINPHONE_PUBLIC const char * linphone_friend_list_get_uri(const LinphoneFriendLi /** * Set the URI associated with the friend list. * @param[in] list LinphoneFriendList object. - * @param[in] rls_uri The URI to associate with the friend list. + * @param[in] uri The URI to associate with the friend list. **/ LINPHONE_PUBLIC void linphone_friend_list_set_uri(LinphoneFriendList *list, const char *uri); @@ -276,7 +276,7 @@ typedef void (*LinphoneFriendListCbsSyncStateChangedCb)(LinphoneFriendList *list /** * Get the LinphoneFriendListCbs object associated with a LinphoneFriendList. - * @param[in] request LinphoneXmlRpcRequest object + * @param[in] list LinphoneFriendList object * @return The LinphoneFriendListCbs object associated with the LinphoneFriendList. **/ LINPHONE_PUBLIC LinphoneFriendListCbs * linphone_friend_list_get_callbacks(const LinphoneFriendList *list); diff --git a/coreapi/help/doxygen.dox b/coreapi/help/doxygen.dox index 41d55cabd..69d5dc896 100644 --- a/coreapi/help/doxygen.dox +++ b/coreapi/help/doxygen.dox @@ -55,9 +55,10 @@ * @defgroup media_parameters Controlling media parameters * Multicast *
Call using rtp multicast addresses are supported for both audio and video with some limitations. Limitations are, no stun, no ice, no encryption. - *
  • Incoming call with multicast address are automatically accepted. The called party switches in a media receive only mode. + *
    **/ /** @@ -171,13 +172,13 @@ linphone_friend_done(my_friend); /*commit changes triggering an UNSUBSCRIBE mess /** * @defgroup chatroom Chat room and Messaging Exchanging text messages -
    Messages are sent using #LinphoneChatRoom object. First step is to create a \link linphone_core_create_chat_room() chat room \endlink +
    Messages are sent using #LinphoneChatRoom object. First step is to create a \link linphone_core_get_chat_room() chat room \endlink from a peer sip uri. \code -LinphoneChatRoom* chat_room = linphone_core_create_chat_room(lc,"sip:joe@sip.linphone.org"); +LinphoneChatRoom* chat_room = linphone_core_get_chat_room(lc,"sip:joe@sip.linphone.org"); \endcode -
    Once created, messages are sent using function linphone_chat_room_send_message() . +
    Once created, messages are sent using function linphone_chat_room_send_message(). \code linphone_chat_room_send_message(chat_room,"Hello world"); /*sending message*/ \endcode diff --git a/coreapi/lime.h b/coreapi/lime.h index 1b5101018..a8a918c65 100644 --- a/coreapi/lime.h +++ b/coreapi/lime.h @@ -48,7 +48,7 @@ typedef struct limeURIKeys_struct { * Structure content must then be freed using lime_freeKeys function * * @param[in] cacheBuffer The xmlDoc containing current cache - * @param[in/out] associatedKeys Structure containing the peerURI. After this call contains all key material associated to the given URI. Must be then freed through lime_freeKeys function + * @param[in,out] associatedKeys Structure containing the peerURI. After this call contains all key material associated to the given URI. Must be then freed through lime_freeKeys function * * @return 0 on success, error code otherwise */ @@ -58,7 +58,7 @@ LINPHONE_PUBLIC int lime_getCachedSndKeysByURI(xmlDocPtr cacheBuffer, limeURIKey * @brief Get the receiver key associated to the ZID given in the associatedKey parameter * * @param[in] cacheBuffer The xmlDoc containing current cache - * @param[in/out] associatedKey Structure containing the peerZID and will store the retrieved key + * @param[in,out] associatedKey Structure containing the peerZID and will store the retrieved key * * @return 0 on success, error code otherwise */ @@ -68,7 +68,7 @@ LINPHONE_PUBLIC int lime_getCachedRcvKeyByZid(xmlDocPtr cacheBuffer, limeKey_t * * @brief Set in cache the given key material, association is made by ZID contained in the associatedKey parameter * * @param[out] cacheBuffer The xmlDoc containing current cache to be updated - * @param[in/out] associatedKey Structure containing the key and ZID to identify the peer node to be updated + * @param[in,out] associatedKey Structure containing the key and ZID to identify the peer node to be updated * @param[in] role Can be LIME_SENDER or LIME_RECEIVER, specify which key we want to update * * @return 0 on success, error code otherwise @@ -80,7 +80,7 @@ LINPHONE_PUBLIC int lime_setCachedKey(xmlDocPtr cacheBuffer, limeKey_t *associat * @brief Free all allocated data in the associated keys structure * Note, this will also free the peerURI string which then must have been allocated * - * @param[in/out] associatedKeys The structure to be cleaned + * @param[in,out] associatedKeys The structure to be cleaned * */ LINPHONE_PUBLIC void lime_freeKeys(limeURIKeys_t associatedKeys); @@ -89,7 +89,7 @@ LINPHONE_PUBLIC void lime_freeKeys(limeURIKeys_t associatedKeys); * @brief encrypt a message with the given key * * @param[in] key Key to use: first 192 bits are used as key, last 64 bits as init vector - * @param[in] message The string to be encrypted + * @param[in] plainMessage The string to be encrypted * @param[in] messageLength The length in bytes of the message to be encrypted * @param[in] selfZID The self ZID is use in authentication tag computation * @param[out] encryptedMessage A buffer to hold the output, ouput length is input's one + 16 for the authentication tag @@ -103,7 +103,7 @@ LINPHONE_PUBLIC int lime_encryptMessage(limeKey_t *key, uint8_t *plainMessage, u /** * @brief Encrypt a file before transfering it to the server, encryption is done in several call, first one will be done with cryptoContext null, last one with length = 0 * - * @param[in/out] cryptoContext The context used to encrypt the file using AES-GCM. Is created at first call(if null) + * @param[in,out] cryptoContext The context used to encrypt the file using AES-GCM. Is created at first call(if null) * @param[in] key 256 bits : 192 bits of key || 64 bits of Initial Vector * @param[in] length Length of data to be encrypted, if 0 it will conclude the encryption * @param[in] plain Plain data to be encrypted (length bytes) @@ -117,7 +117,7 @@ LINPHONE_PUBLIC int lime_encryptFile(void **cryptoContext, unsigned char *key, s /** * @brief Decrypt a file retrieved from server, decryption is done in several call, first one will be done with cryptoContext null, last one with length = 0 * - * @param[in/out] cryptoContext The context used to decrypt the file using AES-GCM. Is created at first call(if null) + * @param[in,out] cryptoContext The context used to decrypt the file using AES-GCM. Is created at first call(if null) * @param[in] key 256 bits : 192 bits of key || 64 bits of Initial Vector * @param[in] length Length of data to be decrypted, if 0 it will conclude the decryption * @param[out] plain Output to a buffer allocated by caller, at least length bytes available @@ -132,7 +132,7 @@ LINPHONE_PUBLIC int lime_decryptFile(void **cryptoContext, unsigned char *key, s * @brief decrypt and authentify a message with the given key * * @param[in] key Key to use: first 192 bits are used as key, last 64 bits as init vector - * @param[in] message The string to be decrypted + * @param[in] encryptedMessage The string to be decrypted * @param[in] messageLength The length in bytes of the message to be decrypted (this include the 16 bytes tag at the begining of the message) * @param[in] selfZID The self ZID is use in authentication tag computation * @param[out] plainMessage A buffer to hold the output, ouput length is input's one - 16 for the authentication tag + 1 for null termination char @@ -148,7 +148,7 @@ LINPHONE_PUBLIC int lime_decryptMessage(limeKey_t *key, uint8_t *encryptedMessag * @brief create the encrypted multipart xml message from plain text and destination URI * Retrieve in cache the needed keys which are then updated. Output buffer is allocated and must be freed by caller * - * @param[in/out] cacheBuffer The xmlDoc containing current cache, get the keys and selfZID from it, updated by this function with derivated keys + * @param[in,out] cacheBuffer The xmlDoc containing current cache, get the keys and selfZID from it, updated by this function with derivated keys * @param[in] message The plain text message to be encrypted * @param[in] peerURI The destination URI, associated keys will be found in cache * @param[out] output The output buffer, allocated and set with the encrypted message xml body(null terminated string). Must be freed by caller @@ -161,7 +161,7 @@ LINPHONE_PUBLIC int lime_createMultipartMessage(xmlDocPtr cacheBuffer, uint8_t * * @brief decrypt a multipart xml message * Retrieve in cache the needed key which is then updated. Output buffer is allocated and must be freed by caller * - * @param[in/out] cacheBuffer The xmlDoc containing current cache, get the key and selfZID from it, updated by this function with derivated keys + * @param[in,out] cacheBuffer The xmlDoc containing current cache, get the key and selfZID from it, updated by this function with derivated keys * @param[in] message The multipart message, contain one or several part identified by destination ZID, one shall match the self ZID retrieved from cache * @param[out] output The output buffer, allocated and set with the decrypted message(null terminated string). Must be freed by caller * diff --git a/coreapi/linphone_proxy_config.h b/coreapi/linphone_proxy_config.h index 2fb5bda9f..9484589df 100644 --- a/coreapi/linphone_proxy_config.h +++ b/coreapi/linphone_proxy_config.h @@ -87,7 +87,7 @@ LINPHONE_PUBLIC int linphone_proxy_config_set_identity_address(LinphoneProxyConf * Sets a SIP route. * When a route is set, all outgoing calls will go to the route's destination if this proxy * is the default one (see linphone_core_set_default_proxy() ). - * @Return -1 if route is invalid, 0 otherwise. + * @return -1 if route is invalid, 0 otherwise. **/ LINPHONE_PUBLIC int linphone_proxy_config_set_route(LinphoneProxyConfig *cfg, const char *route); diff --git a/coreapi/linphonecall.c b/coreapi/linphonecall.c index b90445d40..1cc34c2a6 100644 --- a/coreapi/linphonecall.c +++ b/coreapi/linphonecall.c @@ -1984,24 +1984,11 @@ const LinphoneErrorInfo *linphone_call_get_error_info(const LinphoneCall *call){ }else return linphone_error_info_from_sal_op(call->op); } -/** - * Get the user pointer associated with the LinphoneCall - * - * @ingroup call_control - * @return an opaque user pointer that can be retrieved at any time -**/ void *linphone_call_get_user_data(const LinphoneCall *call) { return call->user_data; } -/** - * Set the user pointer associated with the LinphoneCall - * - * @ingroup call_control - * - * the user pointer is an opaque user pointer that can be retrieved at any time in the LinphoneCall -**/ void linphone_call_set_user_data(LinphoneCall *call, void *user_pointer) { call->user_data = user_pointer; diff --git a/coreapi/linphonecore.h b/coreapi/linphonecore.h index 6c4f1dd6e..9661b5d92 100644 --- a/coreapi/linphonecore.h +++ b/coreapi/linphonecore.h @@ -710,7 +710,7 @@ LINPHONE_PUBLIC void *linphone_call_get_user_data(const LinphoneCall *call); /** * Assign a user pointer to the call. - * @param[in] cfg The call. + * @param[in] call The call. * @param[in] ud The user pointer to associate with the call. * @ingroup call_control **/ @@ -848,7 +848,7 @@ LINPHONE_PUBLIC bool_t linphone_call_media_in_progress(LinphoneCall *call); * @return 0 if successful, -1 on error. * @ingroup call_control **/ -LINPHONE_PUBLIC int linphone_call_send_dtmf(LinphoneCall *lc,char dtmf); +LINPHONE_PUBLIC int linphone_call_send_dtmf(LinphoneCall *call,char dtmf); /** * Send a list of dtmf. @@ -1049,6 +1049,9 @@ LINPHONE_PUBLIC const char *linphone_registration_state_to_string(LinphoneRegist /** * @addtogroup authentication * @{ + */ + +/** * Object holding authentication information. * * @note The object's fields should not be accessed directly. Prefer using @@ -1074,7 +1077,7 @@ LINPHONE_PUBLIC const char *linphone_registration_state_to_string(LinphoneRegist typedef struct _LinphoneAuthInfo LinphoneAuthInfo; /** - * Creates a #_LinphoneAuthInfo object with supplied information. + * Creates a #LinphoneAuthInfo object with supplied information. * The object can be created empty, that is with all arguments set to NULL. * Username, userid, password, realm and domain can be set later using specific methods. * At the end, username and passwd (or ha1) are required. @@ -1084,51 +1087,50 @@ typedef struct _LinphoneAuthInfo LinphoneAuthInfo; * @param ha1 The ha1-encrypted password if password is not given in clear text. * @param realm The authentication domain (which can be larger than the sip domain. Unfortunately many SIP servers don't use this parameter. * @param domain The SIP domain for which this authentication information is valid, if it has to be restricted for a single SIP domain. - * @return A #_LinphoneAuthInfo object. linphone_auth_info_destroy() must be used to destroy it when no longer needed. The LinphoneCore makes a copy of LinphoneAuthInfo + * @return A #LinphoneAuthInfo object. linphone_auth_info_destroy() must be used to destroy it when no longer needed. The LinphoneCore makes a copy of LinphoneAuthInfo * passed through linphone_core_add_auth_info(). **/ LINPHONE_PUBLIC LinphoneAuthInfo *linphone_auth_info_new(const char *username, const char *userid, const char *passwd, const char *ha1,const char *realm, const char *domain); /** - * @addtogroup authentication * Instantiates a new auth info with values from source. - * @param[in] source The #_LinphoneAuthInfo object to be cloned - * @return The newly created #_LinphoneAuthInfo object. + * @param[in] source The #LinphoneAuthInfo object to be cloned + * @return The newly created #LinphoneAuthInfo object. */ LINPHONE_PUBLIC LinphoneAuthInfo *linphone_auth_info_clone(const LinphoneAuthInfo* source); /** * Sets the password. - * @param[in] info The #_LinphoneAuthInfo object + * @param[in] info The #LinphoneAuthInfo object * @param[in] passwd The password. **/ LINPHONE_PUBLIC void linphone_auth_info_set_passwd(LinphoneAuthInfo *info, const char *passwd); /** * Sets the username. - * @param[in] info The #_LinphoneAuthInfo object + * @param[in] info The #LinphoneAuthInfo object * @param[in] username The username. **/ LINPHONE_PUBLIC void linphone_auth_info_set_username(LinphoneAuthInfo *info, const char *username); /** * Sets the userid. - * @param[in] info The #_LinphoneAuthInfo object + * @param[in] info The #LinphoneAuthInfo object * @param[in] userid The userid. **/ LINPHONE_PUBLIC void linphone_auth_info_set_userid(LinphoneAuthInfo *info, const char *userid); /** * Sets the realm. - * @param[in] info The #_LinphoneAuthInfo object + * @param[in] info The #LinphoneAuthInfo object * @param[in] realm The realm. **/ LINPHONE_PUBLIC void linphone_auth_info_set_realm(LinphoneAuthInfo *info, const char *realm); /** * Sets the domain for which this authentication is valid. - * @param[in] info The #_LinphoneAuthInfo object + * @param[in] info The #LinphoneAuthInfo object * @param[in] domain The domain. * This should not be necessary because realm is supposed to be unique and sufficient. * However, many SIP servers don't set realm correctly, then domain has to be used to distinguish between several SIP account bearing the same username. @@ -1137,7 +1139,7 @@ LINPHONE_PUBLIC void linphone_auth_info_set_domain(LinphoneAuthInfo *info, const /** * Sets the ha1. - * @param[in] info The #_LinphoneAuthInfo object + * @param[in] info The #LinphoneAuthInfo object * @param[in] ha1 The ha1. **/ LINPHONE_PUBLIC void linphone_auth_info_set_ha1(LinphoneAuthInfo *info, const char *ha1); @@ -1145,7 +1147,7 @@ LINPHONE_PUBLIC void linphone_auth_info_set_ha1(LinphoneAuthInfo *info, const ch /** * Gets the username. * - * @param[in] info The #_LinphoneAuthInfo object + * @param[in] info The #LinphoneAuthInfo object * @return The username. */ LINPHONE_PUBLIC const char *linphone_auth_info_get_username(const LinphoneAuthInfo *info); @@ -1153,7 +1155,7 @@ LINPHONE_PUBLIC const char *linphone_auth_info_get_username(const LinphoneAuthIn /** * Gets the password. * - * @param[in] info The #_LinphoneAuthInfo object + * @param[in] info The #LinphoneAuthInfo object * @return The password. */ LINPHONE_PUBLIC const char *linphone_auth_info_get_passwd(const LinphoneAuthInfo *info); @@ -1161,7 +1163,7 @@ LINPHONE_PUBLIC const char *linphone_auth_info_get_passwd(const LinphoneAuthInfo /** * Gets the userid. * - * @param[in] info The #_LinphoneAuthInfo object + * @param[in] info The #LinphoneAuthInfo object * @return The userid. */ LINPHONE_PUBLIC const char *linphone_auth_info_get_userid(const LinphoneAuthInfo *info); @@ -1169,7 +1171,7 @@ LINPHONE_PUBLIC const char *linphone_auth_info_get_userid(const LinphoneAuthInfo /** * Gets the realm. * - * @param[in] info The #_LinphoneAuthInfo object + * @param[in] info The #LinphoneAuthInfo object * @return The realm. */ LINPHONE_PUBLIC const char *linphone_auth_info_get_realm(const LinphoneAuthInfo *info); @@ -1177,7 +1179,7 @@ LINPHONE_PUBLIC const char *linphone_auth_info_get_realm(const LinphoneAuthInfo /** * Gets the domain. * - * @param[in] info The #_LinphoneAuthInfo object + * @param[in] info The #LinphoneAuthInfo object * @return The domain. */ LINPHONE_PUBLIC const char *linphone_auth_info_get_domain(const LinphoneAuthInfo *info); @@ -1185,7 +1187,7 @@ LINPHONE_PUBLIC const char *linphone_auth_info_get_domain(const LinphoneAuthInfo /** * Gets the ha1. * - * @param[in] info The #_LinphoneAuthInfo object + * @param[in] info The #LinphoneAuthInfo object * @return The ha1. */ LINPHONE_PUBLIC const char *linphone_auth_info_get_ha1(const LinphoneAuthInfo *info); @@ -1309,7 +1311,7 @@ LINPHONE_PUBLIC LinphoneChatRoom *linphone_core_get_chat_room(LinphoneCore *lc, /** * Get a chat room for messaging from a sip uri like sip:joe@sip.linphone.org. If it does not exist yet, it will be created. * No reference is transfered to the application. The LinphoneCore keeps a reference on the chat room. - * @param lc The linphone core + * @param lc A #LinphoneCore object * @param to The destination address for messages. * @return #LinphoneChatRoom where messaging can take place. **/ @@ -1317,25 +1319,26 @@ LINPHONE_PUBLIC LinphoneChatRoom *linphone_core_get_chat_room_from_uri(LinphoneC /** * Removes a chatroom including all message history from the LinphoneCore. - * @param lc The linphone core - * @param to The chatroom. + * @param lc A #LinphoneCore object + * @param cr A #LinphoneChatRoom object **/ LINPHONE_PUBLIC void linphone_core_delete_chat_room(LinphoneCore *lc, LinphoneChatRoom *cr); /** * Inconditionnaly disable incoming chat messages. - * @param lc the core + * @param lc A #LinphoneCore object * @param deny_reason the deny reason (#LinphoneReasonNone has no effect). **/ LINPHONE_PUBLIC void linphone_core_disable_chat(LinphoneCore *lc, LinphoneReason deny_reason); /** * Enable reception of incoming chat messages. * By default it is enabled but it can be disabled with linphone_core_disable_chat(). - * @param lc the core + * @param lc A #LinphoneCore object **/ LINPHONE_PUBLIC void linphone_core_enable_chat(LinphoneCore *lc); /** * Returns whether chat is enabled. + * @param lc A #LinphoneCore object **/ LINPHONE_PUBLIC bool_t linphone_core_chat_enabled(const LinphoneCore *lc); /** @@ -1484,31 +1487,31 @@ LINPHONE_PUBLIC void linphone_chat_room_compose(LinphoneChatRoom *cr); /** * Tells whether the remote is currently composing a message. - * @param[in] cr The "LinphoneChatRoom object corresponding to the conversation. + * @param[in] cr The #LinphoneChatRoom object corresponding to the conversation. * @return TRUE if the remote is currently composing a message, FALSE otherwise. */ LINPHONE_PUBLIC bool_t linphone_chat_room_is_remote_composing(const LinphoneChatRoom *cr); /** * Gets the number of unread messages in the chatroom. - * @param[in] cr The "LinphoneChatRoom object corresponding to the conversation. + * @param[in] cr The #LinphoneChatRoom object corresponding to the conversation. * @return the number of unread messages. */ LINPHONE_PUBLIC int linphone_chat_room_get_unread_messages_count(LinphoneChatRoom *cr); /** - * Returns back pointer to LinphoneCore object. + * Returns back pointer to #LinphoneCore object. * @deprecated use linphone_chat_room_get_core() **/ LINPHONE_PUBLIC LINPHONE_DEPRECATED LinphoneCore* linphone_chat_room_get_lc(LinphoneChatRoom *cr); /** - * Returns back pointer to LinphoneCore object. + * Returns back pointer to #LinphoneCore object. **/ LINPHONE_PUBLIC LinphoneCore* linphone_chat_room_get_core(LinphoneChatRoom *cr); /** * When realtime text is enabled #linphone_call_params_realtime_text_enabled, #LinphoneCoreIsComposingReceivedCb is call everytime a char is received from peer. * At the end of remote typing a regular #LinphoneChatMessage is received with committed data from #LinphoneCoreMessageReceivedCb. - * @param[in] msg LinphoneChatMessage + * @param[in] cr #LinphoneChatRoom object * @returns RFC 4103/T.140 char */ LINPHONE_PUBLIC uint32_t linphone_chat_room_get_char(const LinphoneChatRoom *cr); @@ -1564,7 +1567,7 @@ LINPHONE_PUBLIC void linphone_chat_message_destroy(LinphoneChatMessage* msg); * @param[in] message #LinphoneChatMessage obj * @param[in] from #LinphoneAddress origin of this message (copied) */ -LINPHONE_PUBLIC void linphone_chat_message_set_from_address(LinphoneChatMessage* message, const LinphoneAddress* addr); +LINPHONE_PUBLIC void linphone_chat_message_set_from_address(LinphoneChatMessage* message, const LinphoneAddress* from); /** @deprecated Use linphone_chat_message_get_from_address() instead. */ #define linphone_chat_message_get_from(msg) linphone_chat_message_get_from_address(msg) /** @@ -1613,6 +1616,7 @@ LINPHONE_PUBLIC const LinphoneContent* linphone_chat_message_get_file_transfer_i * * @param message #LinphoneChatMessage * @param status_cb LinphoneChatMessageStateChangeCb status callback invoked when file is downloaded or could not be downloaded + * @param ud user data * @deprecated Use linphone_chat_message_download_file() instead. */ LINPHONE_PUBLIC LINPHONE_DEPRECATED void linphone_chat_message_start_file_download(LinphoneChatMessage* message, LinphoneChatMessageStateChangedCb status_cb, void* ud); @@ -1729,7 +1733,7 @@ LINPHONE_PUBLIC const char * linphone_chat_message_get_file_transfer_filepath(Li * @param[in] character T.140 char * @returns 0 if succeed. */ -LINPHONE_PUBLIC int linphone_chat_message_put_char(LinphoneChatMessage *msg,uint32_t charater); +LINPHONE_PUBLIC int linphone_chat_message_put_char(LinphoneChatMessage *msg,uint32_t character); /** * get Curent Call associated to this chatroom if any @@ -2203,6 +2207,11 @@ typedef void * (*LinphoneCoreWaitingCallback)(LinphoneCore *lc, void *context, L /* THE main API */ +/** + * @addtogroup initializing + * @{ +**/ + typedef enum _LinphoneLogCollectionState { LinphoneLogCollectionDisabled, LinphoneLogCollectionEnabled, @@ -2211,49 +2220,42 @@ typedef enum _LinphoneLogCollectionState { /** * Tells whether the linphone core log collection is enabled. - * @ingroup misc * @return The state of the linphone core log collection. */ LINPHONE_PUBLIC LinphoneLogCollectionState linphone_core_log_collection_enabled(void); /** * Enable the linphone core log collection to upload logs on a server. - * @ingroup misc * @param[in] state LinphoneLogCollectionState value telling whether to enable log collection or not. */ LINPHONE_PUBLIC void linphone_core_enable_log_collection(LinphoneLogCollectionState state); /** * Get the path where the log files will be written for log collection. - * @ingroup misc * @return The path where the log files will be written. */ LINPHONE_PUBLIC const char * linphone_core_get_log_collection_path(void); /** * Set the path where the log files will be written for log collection. - * @ingroup misc * @param[in] path The path where the log files will be written. */ LINPHONE_PUBLIC void linphone_core_set_log_collection_path(const char *path); /** * Get the prefix of the filenames that will be used for log collection. - * @ingroup misc * @return The prefix of the filenames used for log collection. */ LINPHONE_PUBLIC const char * linphone_core_get_log_collection_prefix(void); /** * Set the prefix of the filenames that will be used for log collection. - * @ingroup misc * @param[in] prefix The prefix to use for the filenames for log collection. */ LINPHONE_PUBLIC void linphone_core_set_log_collection_prefix(const char *prefix); /** * Get the max file size in bytes of the files used for log collection. - * @ingroup misc * @return The max file size in bytes of the files used for log collection. */ LINPHONE_PUBLIC int linphone_core_get_log_collection_max_file_size(void); @@ -2264,14 +2266,12 @@ LINPHONE_PUBLIC int linphone_core_get_log_collection_max_file_size(void); * dynamically but instead only before calling @see * linphone_core_enable_log_collection. If you increase max size * on runtime, logs chronological order COULD be broken. - * @ingroup misc * @param[in] size The max file size in bytes of the files used for log collection. */ LINPHONE_PUBLIC void linphone_core_set_log_collection_max_file_size(int size); /** * Set the url of the server where to upload the collected log files. - * @ingroup misc * @param[in] core LinphoneCore object * @param[in] server_url The url of the server where to upload the collected log files. */ @@ -2279,37 +2279,31 @@ LINPHONE_PUBLIC void linphone_core_set_log_collection_upload_server_url(Linphone /** * Upload the log collection to the configured server url. - * @ingroup misc * @param[in] core LinphoneCore object */ LINPHONE_PUBLIC void linphone_core_upload_log_collection(LinphoneCore *core); /** * Compress the log collection in a single file. - * @ingroup misc * @return The path of the compressed log collection file (to be freed calling ms_free()). */ LINPHONE_PUBLIC char * linphone_core_compress_log_collection(void); /** * Reset the log collection by removing the log files. - * @ingroup misc */ LINPHONE_PUBLIC void linphone_core_reset_log_collection(void); /** * Define a log handler. * - * @ingroup misc - * * @param logfunc The function pointer of the log handler. */ LINPHONE_PUBLIC void linphone_core_set_log_handler(OrtpLogFunc logfunc); + /** * Define a log file. * - * @ingroup misc - * * If the file pointer passed as an argument is NULL, stdout is used instead. * * @param file A pointer to the FILE structure of the file to write to. @@ -2322,11 +2316,10 @@ LINPHONE_PUBLIC void linphone_core_set_log_file(FILE *file); * @param loglevel Minimum level for logging messages. **/ LINPHONE_PUBLIC void linphone_core_set_log_level(OrtpLogLevel loglevel); + /** * Define the log level using mask. * - * @ingroup misc - * * The loglevel parameter is a bitmask parameter. Therefore to enable only warning and error * messages, use ORTP_WARNING | ORTP_ERROR. To disable logs, simply set loglevel to 0. * @@ -2337,7 +2330,6 @@ LINPHONE_PUBLIC void linphone_core_set_log_level_mask(OrtpLogLevel loglevel); /** * Enable logs in supplied FILE*. * - * @ingroup misc * @deprecated Use #linphone_core_set_log_file and #linphone_core_set_log_level instead. * * @param file a C FILE* where to fprintf logs. If null stdout is used. @@ -2348,7 +2340,6 @@ LINPHONE_PUBLIC void linphone_core_enable_logs(FILE *file); /** * Enable logs through the user's supplied log callback. * - * @ingroup misc * @deprecated Use #linphone_core_set_log_handler and #linphone_core_set_log_level instead. * * @param logfunc The address of a OrtpLogFunc callback whose protoype is @@ -2360,7 +2351,6 @@ LINPHONE_PUBLIC void linphone_core_enable_logs_with_cb(OrtpLogFunc logfunc); /** * Entirely disable logging. * - * @ingroup misc * @deprecated Use #linphone_core_set_log_level instead. **/ LINPHONE_PUBLIC void linphone_core_disable_logs(void); @@ -2368,15 +2358,11 @@ LINPHONE_PUBLIC void linphone_core_disable_logs(void); /** * Enable logs serialization (output logs from either the thread that creates the linphone core or the thread that calls linphone_core_iterate()). * Must be called before creating the linphone core. - * @ingroup misc */ LINPHONE_PUBLIC void linphone_core_serialize_logs(void); /** * Returns liblinphone's version as a string. - * - * @ingroup misc - * **/ LINPHONE_PUBLIC const char *linphone_core_get_version(void); @@ -2393,6 +2379,10 @@ LINPHONE_PUBLIC LINPHONE_DEPRECATED const char *linphone_core_get_user_agent_nam **/ LINPHONE_PUBLIC LINPHONE_DEPRECATED const char *linphone_core_get_user_agent_version(void); +/** + * @} +**/ + /** * Instanciates a LinphoneCore object. * @ingroup initializing @@ -2758,7 +2748,7 @@ LINPHONE_PUBLIC bool_t linphone_core_dns_srv_enabled(const LinphoneCore *lc); /** * Forces liblinphone to use the supplied list of dns servers, instead of system's ones. * @param[in] lc #LinphoneCore object. - * @param[in] a #MSList of strings containing the IP addresses of DNS servers to be used. + * @param[in] servers A #MSList of strings containing the IP addresses of DNS servers to be used. * Setting to NULL restores default behaviour, which is to use the DNS server list provided by the system. * The list is copied internally. * @ingroup media_parameters @@ -2980,7 +2970,7 @@ LINPHONE_PUBLIC void linphone_core_set_default_proxy_config(LinphoneCore *lc, Li * @param[in] ha1 String containing a ha1 hash of the password (optional, either passwd or ha1 must be set) * @param[in] realm String used to discriminate different SIP authentication domains (optional) * @param[in] domain String containing the SIP domain for which this authentication information is valid, if it has to be restricted for a single SIP domain. - * @return #_LinphoneAuthInfo with default values set + * @return #LinphoneAuthInfo with default values set * @ingroup authentication */ 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); @@ -2997,8 +2987,8 @@ LINPHONE_PUBLIC const MSList *linphone_core_get_auth_info_list(const LinphoneCor * @param lc the LinphoneCore * @param realm the authentication 'realm' (optional) * @param username the SIP username to be authenticated (mandatory) - * @param domain the SIP domain name (optional) - * @return a #_LinphoneAuthInfo + * @param sip_domain the SIP domain name (optional) + * @return a #LinphoneAuthInfo **/ LINPHONE_PUBLIC const LinphoneAuthInfo *linphone_core_find_auth_info(LinphoneCore *lc, const char *realm, const char *username, const char *sip_domain); @@ -3375,6 +3365,7 @@ LINPHONE_PUBLIC const MSList * linphone_core_get_call_logs(LinphoneCore *lc); * Get the list of call logs (past calls) that matches the given #LinphoneAddress. * At the contrary of linphone_core_get_call_logs, it is your responsability to unref the logs and free this list once you are done using it. * @param[in] lc LinphoneCore object + * @param[in] addr LinphoneAddress object * @return \mslist{LinphoneCallLog} **/ LINPHONE_PUBLIC MSList * linphone_core_get_call_history_for_address(LinphoneCore *lc, const LinphoneAddress *addr); @@ -3933,7 +3924,7 @@ LINPHONE_PUBLIC const char *linphone_core_get_user_certificates_path(LinphoneCor /** * Reload mediastreamer2 plugins from specified directory. * @param[in] lc #LinphoneCore object. - * @param[in] directory the path from where plugins are to be loaded, pass NULL to use default (compile-time determined) plugin directory. + * @param[in] path the path from where plugins are to be loaded, pass NULL to use default (compile-time determined) plugin directory. * @ingroup initializing */ LINPHONE_PUBLIC void linphone_core_reload_ms_plugins(LinphoneCore *lc, const char *path); @@ -3955,7 +3946,7 @@ LINPHONE_PUBLIC LinphoneCall* linphone_core_find_call_from_uri(const LinphoneCor /** * Create a conference * @param lc The #LinphoneCore instance where the conference will be created inside. - * @param params Parameters of the conference. See #LinphoneConferenceParms. + * @param params Parameters of the conference. See #LinphoneConferenceParams. * @return A pointer on the freshly created conference. That object will be automatically * freed by the core after calling linphone_core_terminate_conference(). */ @@ -4045,7 +4036,7 @@ LINPHONE_PUBLIC int linphone_core_get_conference_size(LinphoneCore *lc); LINPHONE_PUBLIC int linphone_core_start_conference_recording(LinphoneCore *lc, const char *path); /** * Stop recording the running conference - * @param #LinphoneCore + * @param lc #LinphoneCore * @return 0 if succeeded. Negative number if failed */ LINPHONE_PUBLIC int linphone_core_stop_conference_recording(LinphoneCore *lc); @@ -4264,8 +4255,8 @@ LINPHONE_PUBLIC const char ** linphone_core_get_supported_file_formats(LinphoneC /** * Returns whether a specific file format is supported. * @see linphone_core_get_supported_file_formats - * @param lc the core - * @param the format extension (wav, mkv). + * @param lc A #LinphoneCore object + * @param fmt The format extension (wav, mkv). * @ingroup media_paramaters **/ LINPHONE_PUBLIC bool_t linphone_core_file_format_supported(LinphoneCore *lc, const char *fmt); @@ -4323,9 +4314,10 @@ LINPHONE_PUBLIC const char* linphone_core_get_video_multicast_addr(const Linphon * @ingroup media_parameters **/ LINPHONE_PUBLIC int linphone_core_set_audio_multicast_ttl(LinphoneCore *core, int ttl); + /** * Use to set multicast ttl to be used for video stream. - * @param core #LinphoneCore + * @param lc #LinphoneCore * @param ttl value or -1 if not used. [0..255] default value is 1 * @return 0 in case of success * @ingroup media_parameters @@ -4434,7 +4426,7 @@ LINPHONE_PUBLIC bool_t linphone_core_realtime_text_enabled(LinphoneCore *lc); /** * Set http proxy address to be used for signaling during next channel connection. Use #linphone_core_set_network_reachable FASLE/TRUE to force channel restart. * @param[in] lc LinphoneCore object - * @param[in] hostname of IP adress of the http proxy (can be NULL to disable). + * @param[in] host Hostname of IP adress of the http proxy (can be NULL to disable). * @ingroup network_parameters */ LINPHONE_PUBLIC void linphone_core_set_http_proxy_host(LinphoneCore *lc, const char *host) ; diff --git a/coreapi/presence.c b/coreapi/presence.c index 22887cfd1..5986a988d 100644 --- a/coreapi/presence.c +++ b/coreapi/presence.c @@ -82,9 +82,11 @@ static const char *person_prefix = "/pidf:presence/dm:person"; /***************************************************************************** * PRIVATE FUNCTIONS * ****************************************************************************/ -/*defined in http://www.w3.org/TR/REC-xml/*/ + +/* Defined in http://www.w3.org/TR/REC-xml/ */ static char presence_id_valid_characters[] = "0123456789abcdefghijklmnopqrstuvwxyz-."; -/*NameStartChar (NameChar)**/ + +/* NameStartChar (NameChar)* */ static char presence_id_valid_start_characters[] = ":_abcdefghijklmnopqrstuvwxyz"; static char * generate_presence_id(void) { diff --git a/coreapi/private.h b/coreapi/private.h index d67c26341..c073baab6 100644 --- a/coreapi/private.h +++ b/coreapi/private.h @@ -1473,10 +1473,12 @@ const char *linphone_content_get_key(const LinphoneContent *content); * @return The key size in bytes */ size_t linphone_content_get_key_size(const LinphoneContent *content); + /** * Set the key associated with a RCS file transfer message if encrypted * @param[in] content LinphoneContent object. * @param[in] key The key to be used to encrypt/decrypt file associated to this content. + * @param[in] keyLength The lengh of the key. */ void linphone_content_set_key(LinphoneContent *content, const char *key, const size_t keyLength); diff --git a/coreapi/ringtoneplayer.h b/coreapi/ringtoneplayer.h index b632b1f55..86d1066c4 100644 --- a/coreapi/ringtoneplayer.h +++ b/coreapi/ringtoneplayer.h @@ -27,10 +27,13 @@ LINPHONE_PUBLIC void linphone_ringtoneplayer_destroy(LinphoneRingtonePlayer* rp) LINPHONE_PUBLIC int linphone_ringtoneplayer_start(MSFactory *factory, LinphoneRingtonePlayer* rp, MSSndCard* card, const char* ringtone, int loop_pause_ms); /** * Start a ringtone player + * @param factory A MSFactory object * @param rp LinphoneRingtonePlayer object * @param card unused argument * @param ringtone path to the ringtone to play * @param loop_pause_ms pause interval in milliseconds to be observed between end of play and resuming at start. A value of -1 disables loop mode + * @param end_of_ringtone A callback function called when the ringtone ends + * @param user_data A user data passed to the callback function called when the ringtone ends * @return 0 if the player successfully started, positive error code otherwise */ LINPHONE_PUBLIC int linphone_ringtoneplayer_start_with_cb(MSFactory *factory, LinphoneRingtonePlayer* rp, MSSndCard* card, diff --git a/coreapi/vcard.h b/coreapi/vcard.h index 7948fbd11..eb15ead51 100644 --- a/coreapi/vcard.h +++ b/coreapi/vcard.h @@ -125,14 +125,14 @@ LINPHONE_PUBLIC MSList* linphone_vcard_get_sip_addresses(const LinphoneVcard *vC /** * Adds a phone number in the vCard, using the TEL property * @param[in] vCard the LinphoneVcard - * @param[in] sip_address the phone number to add + * @param[in] phone the phone number to add */ void linphone_vcard_add_phone_number(LinphoneVcard *vCard, const char *phone); /** * Removes a phone number in the vCard (if it exists), using the TEL property * @param[in] vCard the LinphoneVcard - * @param[in] sip_address the phone number to remove + * @param[in] phone the phone number to remove */ void linphone_vcard_remove_phone_number(LinphoneVcard *vCard, const char *phone); @@ -153,7 +153,7 @@ LINPHONE_PUBLIC MSList* linphone_vcard_get_sip_addresses(const LinphoneVcard *vC /** * Fills the Organization field of the vCard * @param[in] vCard the LinphoneVcard - * @param[in] url the Organization + * @param[in] organization the Organization */ LINPHONE_PUBLIC void linphone_vcard_set_organization(LinphoneVcard *vCard, const char *organization);