From 41fb12153326626774e872d80a8bad42e014773c Mon Sep 17 00:00:00 2001 From: Simon Morlat Date: Tue, 18 Jun 2013 12:25:55 +0200 Subject: [PATCH] fix function name. fix indentation problems and doc --- coreapi/event.c | 2 +- coreapi/event.h | 2 +- coreapi/linphonecore.h | 46 +++++++++++++++++++--------------------- tester/eventapi_tester.c | 2 +- 4 files changed, 25 insertions(+), 27 deletions(-) diff --git a/coreapi/event.c b/coreapi/event.c index 12bccdf29..12e98b400 100644 --- a/coreapi/event.c +++ b/coreapi/event.c @@ -194,7 +194,7 @@ void linphone_event_unref(LinphoneEvent *lev){ if (lev->refcnt==0) linphone_event_destroy(lev); } -LinphoneSubscriptionDir linphone_event_get_dir(LinphoneEvent *lev){ +LinphoneSubscriptionDir linphone_event_get_subscription_dir(LinphoneEvent *lev){ return lev->dir; } diff --git a/coreapi/event.h b/coreapi/event.h index d4a2c9de7..d535a4c8a 100644 --- a/coreapi/event.h +++ b/coreapi/event.h @@ -138,7 +138,7 @@ LinphoneSubscriptionState linphone_event_get_subscription_state(const LinphoneEv * Get subscription direction. * If the object wasn't created by a subscription mechanism, #LinphoneSubscriptionInvalidDir is returned. **/ -LinphoneSubscriptionDir linphone_event_get_dir(LinphoneEvent *lev); +LinphoneSubscriptionDir linphone_event_get_subscription_dir(LinphoneEvent *lev); /** * Set a user (application) pointer. diff --git a/coreapi/linphonecore.h b/coreapi/linphonecore.h index 0a16d779e..35a683bc6 100644 --- a/coreapi/linphonecore.h +++ b/coreapi/linphonecore.h @@ -280,10 +280,10 @@ LINPHONE_PUBLIC void linphone_call_params_set_record_file(LinphoneCallParams *cp LINPHONE_PUBLIC const char *linphone_call_params_get_record_file(const LinphoneCallParams *cp); LINPHONE_PUBLIC void linphone_call_params_add_custom_header(LinphoneCallParams *params, const char *header_name, const char *header_value); LINPHONE_PUBLIC const char *linphone_call_params_get_custom_header(const LinphoneCallParams *params, const char *header_name); -/*** +/** * @ingroup call_control * Defines privacy policy to apply as described by rfc3323 - * */ +**/ typedef enum _LinphonePrivacy { /** * Default privacy as defined either globally or by proxy using #linphone_proxy_config_set_privacy @@ -291,28 +291,28 @@ typedef enum _LinphonePrivacy { LinphonePrivacyDefault=0x0, /** * Request that privacy services provide a user-level privacy - * function. - * With this mode, "from" header is hidden, usually replaced by From: "Anonymous" + * function. + * With this mode, "from" header is hidden, usually replaced by From: "Anonymous" */ LinphonePrivacyUser=0x1, /** * Request that privacy services modify headers that cannot - * be set arbitrarily by the user (Contact/Via). + * be set arbitrarily by the user (Contact/Via). */ LinphonePrivacyHeader=0x2, - /* + /** * Request that privacy services provide privacy for session - * media - */ + * media + */ LinphonePrivacySession=0x4, /** * rfc3325 * The presence of this privacy type in - * a Privacy header field indicates that the user would like the Network - * Asserted Identity to be kept private with respect to SIP entities - * outside the Trust Domain with which the user authenticated. Note - * that a user requesting multiple types of privacy MUST include all of - * the requested privacy types in its Privacy header field value + * a Privacy header field indicates that the user would like the Network + * Asserted Identity to be kept private with respect to SIP entities + * outside the Trust Domain with which the user authenticated. Note + * that a user requesting multiple types of privacy MUST include all of + * the requested privacy types in its Privacy header field value * */ LinphonePrivacyId=0x8, @@ -322,11 +322,10 @@ typedef enum _LinphonePrivacy { LinphonePrivacyNone=0x10, /** * Privacy service must perform the specified services or - * fail the request + * fail the request * **/ LinphonePrivacyCritical=0x20 - } LinphonePrivacy; /* * a mask of #LinphonePrivacy values @@ -340,15 +339,15 @@ typedef unsigned int LinphonePrivacyMask; const char* linphone_privacy_to_string(LinphonePrivacy privacy); /** * @ingroup call_control - * Indicates if "from" must be replaced by anonymous value as described by rfc3325. - * @param params to be modified + * Set requested level of privacy for the call. + * @param params the call parameters to be modified * @param LinphonePrivacy to configure privacy * */ -LINPHONE_PUBLIC void linphone_call_params_set_privacy(LinphoneCallParams *params, LinphonePrivacyMask privacy); +LINPHONE_PUBLIC void linphone_call_params_set_privacy(LinphoneCallParams *params, LinphonePrivacyMask privacy); /** * @ingroup call_control - * indicates if "from" must be replaced by anonymous value as described by rfc3325. - * @param params object + * Get requested level of privacy for the call. + * @param params the call parameters * @return Privacy mode * */ LINPHONE_PUBLIC LinphonePrivacyMask linphone_call_params_get_privacy(const LinphoneCallParams *params); @@ -704,14 +703,13 @@ LINPHONE_PUBLIC void linphone_proxy_config_set_user_data(LinphoneProxyConfig *cr LINPHONE_PUBLIC void * linphone_proxy_config_get_user_data(LinphoneProxyConfig *cr); /** - * - * Indicates if "from" must be replaced by anonymous value as described by rfc3325. + * Set default privacy policy for all calls routed through this proxy. * @param params to be modified * @param LinphonePrivacy to configure privacy * */ -LINPHONE_PUBLIC void linphone_proxy_config_set_privacy(LinphoneProxyConfig *params, LinphonePrivacyMask privacy); +LINPHONE_PUBLIC void linphone_proxy_config_set_privacy(LinphoneProxyConfig *params, LinphonePrivacyMask privacy); /** - * indicates if "from" must be replaced by anonymous value as described by rfc3325. + * Get default privacy policy for all calls routed through this proxy. * @param params object * @return Privacy mode * */ diff --git a/tester/eventapi_tester.c b/tester/eventapi_tester.c index 23f0158ab..c7815f671 100644 --- a/tester/eventapi_tester.c +++ b/tester/eventapi_tester.c @@ -58,7 +58,7 @@ void linphone_subscription_state_change(LinphoneCore *lc, LinphoneEvent *lev, Li break; case LinphoneSubscriptionActive: counters->number_of_LinphoneSubscriptionActive++; - if (linphone_event_get_dir(lev)==LinphoneSubscriptionIncoming){ + if (linphone_event_get_subscription_dir(lev)==LinphoneSubscriptionIncoming){ mgr->lev=lev; linphone_event_notify(lev,&content); }