From 4094aec87ab5a5915dc7d985d7670d360709eff2 Mon Sep 17 00:00:00 2001 From: Gautier Pelloux-Prayer Date: Thu, 5 Jun 2014 17:38:15 +0200 Subject: [PATCH] removed minor warnings generated by doxygen due to outdated functions prototype --- coreapi/chat.c | 2 +- coreapi/event.h | 9 ++++----- coreapi/linphone_tunnel.h | 12 ++++++------ coreapi/linphonecall.c | 2 +- coreapi/linphonecore.c | 8 +++++--- coreapi/linphonecore.h | 8 ++++---- coreapi/linphonepresence.h | 2 +- coreapi/proxy.c | 2 +- coreapi/quality_reporting.c | 1 - 9 files changed, 23 insertions(+), 23 deletions(-) diff --git a/coreapi/chat.c b/coreapi/chat.c index 2ea196b47..c20cfef9e 100644 --- a/coreapi/chat.c +++ b/coreapi/chat.c @@ -247,7 +247,7 @@ void linphone_chat_room_message_received(LinphoneChatRoom *cr, LinphoneCore *lc, /** * Retrieve an existing chat room whose peer is the supplied address, if exists. * @param lc the linphone core - * @param add a linphone address. + * @param addr a linphone address. * @returns the matching chatroom, or NULL if no such chatroom exists. **/ LinphoneChatRoom *linphone_core_get_chat_room(LinphoneCore *lc, const LinphoneAddress *addr){ diff --git a/coreapi/event.h b/coreapi/event.h index 2b0e2bf0d..4b3e26bd9 100644 --- a/coreapi/event.h +++ b/coreapi/event.h @@ -97,12 +97,12 @@ typedef void (*LinphoneCoreNotifyReceivedCb)(LinphoneCore *lc, LinphoneEvent *le /** * Callback prototype for notifying the application about changes of subscription states, including arrival of new subscriptions. -**/ +**/ typedef void (*LinphoneCoreSubscriptionStateChangedCb)(LinphoneCore *lc, LinphoneEvent *lev, LinphoneSubscriptionState state); /** * Callback prototype for notifying the application about changes of publish states. -**/ +**/ typedef void (*LinphoneCorePublishStateChangedCb)(LinphoneCore *lc, LinphoneEvent *lev, LinphonePublishState state); /** @@ -125,7 +125,6 @@ LINPHONE_PUBLIC LinphoneEvent *linphone_core_subscribe(LinphoneCore *lc, const L * @param resource the destination resource * @param event the event name * @param expires the whished duration of the subscription - * @param body an optional body, may be NULL. * @return a LinphoneEvent holding the context of the created subcription. **/ LINPHONE_PUBLIC LinphoneEvent *linphone_core_create_subscribe(LinphoneCore *lc, const LinphoneAddress *resource, const char *event, int expires); @@ -258,7 +257,7 @@ LINPHONE_PUBLIC const char *linphone_event_get_custom_header(LinphoneEvent *ev, /** * Terminate an incoming or outgoing subscription that was previously acccepted, or a previous publication. * This function does not unref the object. The core will unref() if it does not need this object anymore. - * + * * For subscribed event, when the subscription is terminated normally or because of an error, the core will unref. * For published events, no unref is performed. This is because it is allowed to re-publish an expired publish, as well as retry it in case of error. **/ @@ -270,7 +269,7 @@ LINPHONE_PUBLIC void linphone_event_terminate(LinphoneEvent *lev); * By default LinphoneEvents created by the core are owned by the core only. * An application that wishes to retain a reference to it must call linphone_event_ref(). * When this reference is no longer needed, linphone_event_unref() must be called. - * + * **/ LINPHONE_PUBLIC LinphoneEvent *linphone_event_ref(LinphoneEvent *lev); diff --git a/coreapi/linphone_tunnel.h b/coreapi/linphone_tunnel.h index cff8fc532..9b33e32f8 100644 --- a/coreapi/linphone_tunnel.h +++ b/coreapi/linphone_tunnel.h @@ -22,7 +22,7 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ - + #ifndef LINPHONETUNNEL_H #define LINPHONETUNNEL_H @@ -86,7 +86,7 @@ LINPHONE_PUBLIC void linphone_tunnel_config_set_port(LinphoneTunnelConfig *tunne LINPHONE_PUBLIC int linphone_tunnel_config_get_port(const LinphoneTunnelConfig *tunnel); /** - * Set the remote port on the tunnel server side used to test udp reachability. + * Set the remote port on the tunnel server side used to test udp reachability. * * @param tunnel configuration object * @param remote_udp_mirror_port remote port on the tunnel server side used to test udp reachability, set to -1 to disable the feature @@ -110,7 +110,7 @@ LINPHONE_PUBLIC void linphone_tunnel_config_set_delay(LinphoneTunnelConfig *tunn /** * Get the udp packet round trip delay in ms for a tunnel configuration. - * + * * @param tunnel configuration object */ LINPHONE_PUBLIC int linphone_tunnel_config_get_delay(const LinphoneTunnelConfig *tunnel); @@ -132,7 +132,7 @@ LINPHONE_PUBLIC void linphone_tunnel_add_server(LinphoneTunnel *tunnel, Linphone /** * Remove tunnel server configuration - * + * * @param tunnel object * @param tunnel_config object */ @@ -208,7 +208,7 @@ LINPHONE_PUBLIC bool_t linphone_tunnel_auto_detect_enabled(LinphoneTunnel *tunne * @param host Http proxy host. * @param port http proxy port. * @param username optional http proxy username if the proxy request authentication. Currently only basic authentication is supported. Use NULL if not needed. - * @param password optional http proxy password. Use NULL if not needed. + * @param passwd optional http proxy password. Use NULL if not needed. **/ LINPHONE_PUBLIC void linphone_tunnel_set_http_proxy(LinphoneTunnel *tunnel, const char *host, int port, const char* username,const char* passwd); @@ -218,7 +218,7 @@ LINPHONE_PUBLIC void linphone_tunnel_set_http_proxy(LinphoneTunnel *tunnel, cons * @param host Http proxy host. * @param port http proxy port. * @param username optional http proxy username if the proxy request authentication. Currently only basic authentication is supported. Use NULL if not needed. - * @param password optional http proxy password. Use NULL if not needed. + * @param passwd optional http proxy password. Use NULL if not needed. **/ LINPHONE_PUBLIC void linphone_tunnel_get_http_proxy(LinphoneTunnel*tunnel,const char **host, int *port, const char **username, const char **passwd); diff --git a/coreapi/linphonecall.c b/coreapi/linphonecall.c index 2c6c188b4..7fa8b5fc5 100644 --- a/coreapi/linphonecall.c +++ b/coreapi/linphonecall.c @@ -1447,7 +1447,7 @@ void _linphone_call_params_copy(LinphoneCallParams *ncp, const LinphoneCallParam * Set requested level of privacy for the call. * \xmlonly javascript \endxmlonly * @param params the call parameters to be modified - * @param LinphonePrivacy to configure privacy + * @param privacy LinphonePrivacy to configure privacy * */ void linphone_call_params_set_privacy(LinphoneCallParams *params, LinphonePrivacyMask privacy) { params->privacy=privacy; diff --git a/coreapi/linphonecore.c b/coreapi/linphonecore.c index 0183979a5..5c4e51ddf 100644 --- a/coreapi/linphonecore.c +++ b/coreapi/linphonecore.c @@ -2037,6 +2037,7 @@ int linphone_core_get_sip_transports(LinphoneCore *lc, LCSipTransports *tr){ * A zero value means that the transport is not activated. * If LC_SIP_TRANSPORT_RANDOM was passed to linphone_core_set_sip_transports(), the random port choosed by the system is returned. * @ingroup network_parameters + * @param lc the LinphoneCore * @param tr a LCSipTransports structure. **/ void linphone_core_get_sip_transports_used(LinphoneCore *lc, LCSipTransports *tr){ @@ -2914,7 +2915,7 @@ LinphoneCall * linphone_core_invite_address_with_params(LinphoneCore *lc, const * * 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(LinphoneCore *lc, LinphoneCall *call, const char *url) { @@ -3147,7 +3148,7 @@ int linphone_core_update_call(LinphoneCore *lc, LinphoneCall *call, const Linpho #if defined(VIDEO_ENABLED) && defined(BUILD_UPNP) bool_t has_video = FALSE; #endif - + switch(call->state){ case LinphoneCallIncomingEarlyMedia: case LinphoneCallIncomingReceived: @@ -3158,7 +3159,7 @@ int linphone_core_update_call(LinphoneCore *lc, LinphoneCall *call, const Linpho ms_error("linphone_core_update_call() is not allowed in [%s] state",linphone_call_state_to_string(call->state)); return -1; } - + if (params!=NULL){ linphone_call_set_state(call,LinphoneCallUpdating,"Updating call"); #if defined(VIDEO_ENABLED) && defined(BUILD_UPNP) @@ -5614,6 +5615,7 @@ void linphone_core_set_rtp_transport_factories(LinphoneCore* lc, LinphoneRtpTran /** * Retrieve RTP statistics regarding current call. + * @param lc the LinphoneCore * @param local RTP statistics computed locally. * @param remote RTP statistics computed by far end (obtained via RTCP feedback). * diff --git a/coreapi/linphonecore.h b/coreapi/linphonecore.h index bb35fc98c..debf48461 100644 --- a/coreapi/linphonecore.h +++ b/coreapi/linphonecore.h @@ -819,7 +819,7 @@ LINPHONE_PUBLIC void linphone_proxy_config_enable_publish(LinphoneProxyConfig *o /** * Set the publish expiration time in second. * @param obj proxy config - * @param exires in second + * @param expires in second * */ LINPHONE_PUBLIC void linphone_proxy_config_set_publish_expires(LinphoneProxyConfig *obj, int expires); @@ -964,7 +964,7 @@ LINPHONE_PUBLIC void * linphone_proxy_config_get_user_data(LinphoneProxyConfig * /** * Set default privacy policy for all calls routed through this proxy. * @param params to be modified - * @param LinphonePrivacy to configure privacy + * @param privacy LinphonePrivacy to configure privacy * */ LINPHONE_PUBLIC void linphone_proxy_config_set_privacy(LinphoneProxyConfig *params, LinphonePrivacyMask privacy); /** @@ -1581,7 +1581,7 @@ LINPHONE_PUBLIC int linphone_core_accept_call_update(LinphoneCore *lc, LinphoneC /** * @ingroup media_parameters * Get default call parameters reflecting current linphone core configuration - * @param LinphoneCore object + * @param lc LinphoneCore object * @return LinphoneCallParams */ LINPHONE_PUBLIC LinphoneCallParams *linphone_core_create_default_call_parameters(LinphoneCore *lc); @@ -2023,7 +2023,7 @@ LINPHONE_PUBLIC void linphone_core_mute_mic(LinphoneCore *lc, bool_t muted); /** * Get mic state. - * @deprecated Use #linphone_core_is_mic_enabled instead + * @deprecated Use #linphone_core_mic_enabled instead **/ LINPHONE_PUBLIC bool_t linphone_core_is_mic_muted(LinphoneCore *lc); diff --git a/coreapi/linphonepresence.h b/coreapi/linphonepresence.h index 851ccf63e..780ae22b6 100644 --- a/coreapi/linphonepresence.h +++ b/coreapi/linphonepresence.h @@ -426,7 +426,7 @@ LINPHONE_PUBLIC int linphone_presence_model_clear_persons(LinphonePresenceModel * * The created presence service has the basic status 'closed'. */ -LINPHONE_PUBLIC LinphonePresenceService * linphone_presence_service_new(const char *id, LinphonePresenceBasicStatus, const char *contact); +LINPHONE_PUBLIC LinphonePresenceService * linphone_presence_service_new(const char *id, LinphonePresenceBasicStatus basic_status, const char *contact); /** * Gets the id of a presence service. diff --git a/coreapi/proxy.c b/coreapi/proxy.c index 3772bc744..6b23eebdd 100644 --- a/coreapi/proxy.c +++ b/coreapi/proxy.c @@ -1029,7 +1029,7 @@ void linphone_proxy_config_set_contact_parameters(LinphoneProxyConfig *obj, cons /** * Set optional contact parameters that will be added to the contact information sent in the registration, inside the URI. * @param obj the proxy config object - * @param contact_params a string contaning the additional parameters in text form, like "myparam=something;myparam2=something_else" + * @param contact_uri_params a string containing the additional parameters in text form, like "myparam=something;myparam2=something_else" * * The main use case for this function is provide the proxy additional information regarding the user agent, like for example unique identifier or apple push id. * As an example, the contact address in the SIP register sent will look like . diff --git a/coreapi/quality_reporting.c b/coreapi/quality_reporting.c index 81241efd1..4d1108077 100644 --- a/coreapi/quality_reporting.c +++ b/coreapi/quality_reporting.c @@ -36,7 +36,6 @@ moslq == moscq valgrind video: what happens if doing stop/resume? one single report <- merge audio/video? -unit test interval report rlq value: need algo to compute it 3.4 overload avoidance?