mirror of
https://gitlab.linphone.org/BC/public/linphone-iphone.git
synced 2026-02-07 14:18:25 +00:00
doxygen: update configuration and fix errors in doc
This commit is contained in:
Gautier Pelloux-Prayer
parent
9fdecfa649
commit
3532bfabfb
4 changed files with 2395 additions and 216 deletions
File diff suppressed because it is too large
Load diff
|
|
@ -140,12 +140,10 @@ enum _LinphoneStreamType {
|
|||
**/
|
||||
typedef enum _LinphoneStreamType LinphoneStreamType;
|
||||
/**
|
||||
* Function returning a humain readable value for LinphoneStreamType.
|
||||
* @param LinphoneStreamType
|
||||
* @returns
|
||||
* Function returning a human readable value for LinphoneStreamType.
|
||||
* @ingroup initializing
|
||||
**/
|
||||
|
||||
|
||||
LINPHONE_PUBLIC const char *linphone_stream_type_to_string(const LinphoneStreamType);
|
||||
/**
|
||||
* Object that represents a SIP address.
|
||||
|
|
@ -1065,7 +1063,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.
|
||||
|
|
@ -1075,7 +1073,7 @@ 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,
|
||||
|
|
@ -1084,42 +1082,42 @@ LINPHONE_PUBLIC LinphoneAuthInfo *linphone_auth_info_new(const char *username, c
|
|||
/**
|
||||
* @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.
|
||||
|
|
@ -1128,7 +1126,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);
|
||||
|
|
@ -1136,7 +1134,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);
|
||||
|
|
@ -1144,7 +1142,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);
|
||||
|
|
@ -1152,7 +1150,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);
|
||||
|
|
@ -1160,7 +1158,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);
|
||||
|
|
@ -1168,7 +1166,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);
|
||||
|
|
@ -1176,7 +1174,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);
|
||||
|
|
@ -1379,7 +1377,13 @@ LINPHONE_PUBLIC void linphone_chat_room_set_user_data(LinphoneChatRoom *cr, void
|
|||
*/
|
||||
LINPHONE_PUBLIC LinphoneChatMessage* linphone_chat_room_create_file_transfer_message(LinphoneChatRoom *cr, const LinphoneContent* initial_content);
|
||||
|
||||
/**
|
||||
* get peer address \link linphone_core_get_chat_room() associated to \endlink this #LinphoneChatRoom
|
||||
* @param cr #LinphoneChatRoom object
|
||||
* @return #LinphoneAddress peer address
|
||||
*/
|
||||
LINPHONE_PUBLIC const LinphoneAddress* linphone_chat_room_get_peer_address(LinphoneChatRoom *cr);
|
||||
|
||||
/**
|
||||
* Send a message to peer member of this chat room.
|
||||
* @deprecated Use linphone_chat_room_send_chat_message() instead.
|
||||
|
|
@ -1543,7 +1547,7 @@ LINPHONE_PUBLIC const LinphoneAddress* linphone_chat_message_get_from_address(co
|
|||
/**
|
||||
* Set destination of the message
|
||||
* @param[in] message #LinphoneChatMessage obj
|
||||
* @param[in] to #LinphoneAddress destination of this message (copied)
|
||||
* @param[in] addr #LinphoneAddress destination of this message (copied)
|
||||
*/
|
||||
LINPHONE_PUBLIC void linphone_chat_message_set_to_address(LinphoneChatMessage* message, const LinphoneAddress* addr);
|
||||
/** @deprecated Use linphone_chat_message_get_to_address() instead. */
|
||||
|
|
@ -1631,11 +1635,7 @@ LINPHONE_PUBLIC void linphone_chat_message_set_user_data(LinphoneChatMessage* me
|
|||
* Returns the chatroom this message belongs to.
|
||||
**/
|
||||
LINPHONE_PUBLIC LinphoneChatRoom* linphone_chat_message_get_chat_room(LinphoneChatMessage *msg);
|
||||
/**
|
||||
* get peer address \link linphone_core_get_chat_room() associated to \endlink this #LinphoneChatRoom
|
||||
* @param cr #LinphoneChatRoom object
|
||||
* @return #LinphoneAddress peer address
|
||||
*/
|
||||
|
||||
LINPHONE_PUBLIC const LinphoneAddress* linphone_chat_message_get_peer_address(LinphoneChatMessage *msg);
|
||||
/**
|
||||
* Returns the origin address of a message if it was a outgoing message, or the destination address if it was an incoming message.
|
||||
|
|
@ -1692,8 +1692,6 @@ LINPHONE_PUBLIC void linphone_chat_message_set_file_transfer_filepath(LinphoneCh
|
|||
*/
|
||||
LINPHONE_PUBLIC const char * linphone_chat_message_get_file_transfer_filepath(LinphoneChatMessage *msg);
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Fulfill a chat message char by char. Message linked to a Real Time Text Call send char in realtime following RFC 4103/T.140
|
||||
* To commit a message, use #linphone_chat_room_send_message
|
||||
|
|
@ -2122,7 +2120,7 @@ LINPHONE_PUBLIC LinphoneCoreVTable *linphone_core_get_current_vtable(LinphoneCor
|
|||
|
||||
/**
|
||||
* Destroy a vtable.
|
||||
* @param vtable to be destroyed
|
||||
* @param table to be destroyed
|
||||
*/
|
||||
LINPHONE_PUBLIC void linphone_core_v_table_destroy(LinphoneCoreVTable* table);
|
||||
|
||||
|
|
@ -2307,6 +2305,10 @@ LINPHONE_PUBLIC void linphone_core_serialize_logs(void);
|
|||
*
|
||||
**/
|
||||
LINPHONE_PUBLIC const char *linphone_core_get_version(void);
|
||||
|
||||
/**
|
||||
* @return liblinphone's user agent as a string.
|
||||
**/
|
||||
LINPHONE_PUBLIC const char *linphone_core_get_user_agent(LinphoneCore *lc);
|
||||
/**
|
||||
* @deprecated Use #linphone_core_get_user_agent instead.
|
||||
|
|
@ -2337,7 +2339,7 @@ LINPHONE_PUBLIC LINPHONE_DEPRECATED const char *linphone_core_get_user_agent_ver
|
|||
* @see linphone_core_new_with_config
|
||||
**/
|
||||
LINPHONE_PUBLIC LinphoneCore *linphone_core_new(const LinphoneCoreVTable *vtable,
|
||||
const char *config_path, const char *factory_config, void* userdata);
|
||||
const char *config_path, const char *factory_config_path, void* userdata);
|
||||
|
||||
/**
|
||||
* Instantiates a LinphoneCore object with a given LpConfig.
|
||||
|
|
@ -2362,16 +2364,14 @@ LINPHONE_PUBLIC void linphone_core_iterate(LinphoneCore *lc);
|
|||
* add a listener to be notified of linphone core events. Once events are received, registered vtable are invoked in order.
|
||||
* @param vtable a LinphoneCoreVTable structure holding your application callbacks. Object is owned by linphone core until linphone_core_remove_listener.
|
||||
* @param lc object
|
||||
* @param string identifying the device, can be EMEI or UDID
|
||||
*
|
||||
*/
|
||||
LINPHONE_PUBLIC void linphone_core_add_listener(LinphoneCore *lc, LinphoneCoreVTable *vtable);
|
||||
/**
|
||||
* @ingroup initializing
|
||||
* remove a listener registred by linphone_core_add_listener.
|
||||
* @param vtable a LinphoneCoreVTable structure holding your application callbacks
|
||||
* @param lc object
|
||||
* @param string identifying the device, can be EMEI or UDID
|
||||
* @param vtable a LinphoneCoreVTable structure holding your application callbacks
|
||||
*
|
||||
*/
|
||||
LINPHONE_PUBLIC void linphone_core_remove_listener(LinphoneCore *lc, const LinphoneCoreVTable *vtable);
|
||||
|
|
@ -2895,7 +2895,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);
|
||||
|
|
@ -2913,7 +2913,7 @@ LINPHONE_PUBLIC const MSList *linphone_core_get_auth_info_list(const LinphoneCor
|
|||
* @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
|
||||
* @return a #_LinphoneAuthInfo
|
||||
**/
|
||||
LINPHONE_PUBLIC const LinphoneAuthInfo *linphone_core_find_auth_info(LinphoneCore *lc, const char *realm, const char *username, const char *sip_domain);
|
||||
|
||||
|
|
@ -4066,7 +4066,7 @@ LINPHONE_PUBLIC int linphone_core_get_avpf_rr_interval(const LinphoneCore *lc);
|
|||
LINPHONE_PUBLIC int linphone_core_set_audio_multicast_addr(LinphoneCore *core, const char* ip);
|
||||
/**
|
||||
* Use to set multicast address to be used for video stream.
|
||||
* @param core #LinphoneCore
|
||||
* @param lc #LinphoneCore
|
||||
* @param ip an ipv4/6 multicast address
|
||||
* @return 0 in case of success
|
||||
* @ingroup media_parameters
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
Subproject commit 0f5f02a3beaaccfd2b927807d79bf1fe37abd09b
|
||||
Subproject commit 8922222f13ea14ecb953c3c53310b187bef78d1e
|
||||
2
oRTP
2
oRTP
|
|
@ -1 +1 @@
|
|||
Subproject commit 4a4ecae9eebdc967bbfb03360ad787e52d6ad267
|
||||
Subproject commit 984522d08835907e695773561d95eb408103d9d6
|
||||
Loading…
Add table
Reference in a new issue