From 634ebdfde15a75a8844e5c07851f9f0c57a1eb8d Mon Sep 17 00:00:00 2001 From: Ghislain MARY Date: Thu, 12 Jun 2014 13:39:29 +0200 Subject: [PATCH] Fix some documentation generation warnings. --- coreapi/event.h | 6 +++--- coreapi/help/doxygen.dox | 8 ++++---- coreapi/linphonecore.c | 9 ++------- coreapi/linphonecore.h | 41 ++++++++++++++++++++-------------------- 4 files changed, 30 insertions(+), 34 deletions(-) diff --git a/coreapi/event.h b/coreapi/event.h index 4b3e26bd9..0cf107fd7 100644 --- a/coreapi/event.h +++ b/coreapi/event.h @@ -37,9 +37,9 @@ typedef struct _LinphoneEvent LinphoneEvent; * Enum for subscription direction (incoming or outgoing). **/ enum _LinphoneSubscriptionDir{ - LinphoneSubscriptionIncoming, - LinphoneSubscriptionOutgoing, - LinphoneSubscriptionInvalidDir + LinphoneSubscriptionIncoming, /**< Incoming subscription. */ + LinphoneSubscriptionOutgoing, /**< Outgoing subscription. */ + LinphoneSubscriptionInvalidDir /**< Invalid subscription direction. */ }; /** diff --git a/coreapi/help/doxygen.dox b/coreapi/help/doxygen.dox index 656f25e09..8831758d6 100644 --- a/coreapi/help/doxygen.dox +++ b/coreapi/help/doxygen.dox @@ -61,7 +61,7 @@ *like \link linphone_proxy_config_set_server_addr() proxy address \endlink , \link linphone_proxy_config_set_identity() user id \endlink, \link linphone_proxy_config_expires() refresh period \endlink, and so on. *
A created proxy config using linphone_proxy_config_new(), once configured, must be added to #LinphoneCore using function linphone_core_add_proxy_config(). *
It is recommended to set a default \link #LinphoneProxyConfig proxy config \endlink using function linphone_core_set_default_proxy(). Once done, if \link #LinphoneProxyConfig a proxy config \endlink has been configured with attribute \link linphone_proxy_config_enable_register() enable register \endlink , next call to linphone_core_iterate() triggers a SIP register. - *
Registration status is reported by #LinphoneRegistrationStateCb. + *
Registration status is reported by LinphoneCoreRegistrationStateChangedCb. *
*
This pseudo code demonstrates basic registration operations: *
\code @@ -96,7 +96,7 @@ } \endcode *
Authentication: - *
Most of the time, registration requires \ref authentication "authentication" to succed. #LinphoneAuthInfo info must be either added to #LinphoneCore using function linphone_core_add_auth_info() before #LinphoneProxyConfig is added to Linphone core, or on demand from call back #AuthInfoRequested . + *
Most of the time, registration requires \ref authentication "authentication" to succeed. #LinphoneAuthInfo info must be either added to #LinphoneCore using function linphone_core_add_auth_info() before #LinphoneProxyConfig is added to Linphone core, or on demand from call back #LinphoneCoreAuthInfoRequestedCb. *
*
Unregistration: *
Unregistration or any changes to #LinphoneProxyConfig must be first started by a call to function linphone_proxy_config_edit() and validated by function linphone_proxy_config_done() @@ -203,7 +203,7 @@ void text_received(LinphoneCore *lc, LinphoneChatRoom *room, const LinphoneAddre * While initiating the second call, the first one is automatically paused. * Then, once the second call is established, the application has the possibility to merge the two calls to form a conference where each participant * (the local participant, the remote destination of the first call, the remote destination of the second call) can talk together. - * This must be done by adding the two calls to the conference using \link linphone_call_add_to_conference() \endlink + * This must be done by adding the two calls to the conference using \link linphone_core_add_to_conference() \endlink * * Once merged into a conference the LinphoneCall objects representing the calls that were established remain unchanged, except that * they are tagged as part of the conference (see \link linphone_call_is_in_conference() \endlink ). The calls in a conference are in the LinphoneCallStreamsRunning state. @@ -270,7 +270,7 @@ and register a keep-alive handler for periodically refreshing the registration. }]; \endcode
  • Incoming call notification while in background mode -
    Assuming application using liblinphone is well configured for multitasking, incoming calls arriving while liblinphone is in background mode will simply wakeup liblinphone thread but not resume GUI. To wakeup GUI, it is recommended to send a Local Notification to the user from the #LinphoneCallStateCb. Here under a speudo code for this operation: +
    Assuming application using liblinphone is well configured for multitasking, incoming calls arriving while liblinphone is in background mode will simply wakeup liblinphone thread but not resume GUI. To wakeup GUI, it is recommended to send a Local Notification to the user from the #LinphoneCoreCallStateChangedCb. Here under a speudo code for this operation: \code if ([UIApplication sharedApplication].applicationState != UIApplicationStateActive) { // Create a new notification diff --git a/coreapi/linphonecore.c b/coreapi/linphonecore.c index e9c5585e3..452447232 100644 --- a/coreapi/linphonecore.c +++ b/coreapi/linphonecore.c @@ -2377,7 +2377,7 @@ void linphone_core_iterate(LinphoneCore *lc){ * * @ingroup call_control * - * A sip address should look like DisplayName . + * A sip address should look like DisplayName \ . * Basically this function performs the following tasks * - if a phone number is entered, prepend country prefix of the default proxy * configuration, eventually escape the '+' by 00. @@ -2957,7 +2957,7 @@ int linphone_core_transfer_call(LinphoneCore *lc, LinphoneCall *call, const char * * It is possible to follow the progress of the transfer provided that transferee sends notification about it. * In this case, the transfer_state_changed callback of the #LinphoneCoreVTable is invoked to notify of the state of the new call at the other party. - * The notified states are #LinphoneCallOutgoingInit , #LinphoneCallOutgoingProgress, #LinphoneCallOutgoingRinging and #LinphoneCallOutgoingConnected. + * The notified states are #LinphoneCallOutgoingInit , #LinphoneCallOutgoingProgress, #LinphoneCallOutgoingRinging and #LinphoneCallConnected. **/ int linphone_core_transfer_call_to_another(LinphoneCore *lc, LinphoneCall *call, LinphoneCall *dest){ int result = sal_call_refer_with_replaces (call->op,dest->op); @@ -6563,11 +6563,6 @@ bool_t linphone_core_sdp_200_ack_enabled(const LinphoneCore *lc) { return lc->sip_conf.sdp_200_ack!=0; } -/** - * Globaly set an http file transfer server to be used for content type application/vnd.gsma.rcs-ft-http+xml. This value can also be set for a dedicated account using #linphone_proxy_config_set_file_transfer_server - * @param #LinphoneCore to be modified - * @param const char* url of the file server like https://file.linphone.org/upload.php - **/ void linphone_core_set_file_transfer_server(LinphoneCore *core, const char * server_url) { core->file_transfer_server=ms_strdup(server_url); } diff --git a/coreapi/linphonecore.h b/coreapi/linphonecore.h index 2c02c801d..dd0ff311a 100644 --- a/coreapi/linphonecore.h +++ b/coreapi/linphonecore.h @@ -133,9 +133,9 @@ typedef struct belle_sip_dict LinphoneDictionary; struct _LinphoneContent{ char *type; /**