From f1aca46bb644b340ae798cf55a4308cfd7c7a7ce Mon Sep 17 00:00:00 2001 From: Gautier Pelloux-Prayer Date: Tue, 21 Jul 2015 14:14:05 +0200 Subject: [PATCH] linphonecore.h: minor documentation update for sip/phone number normalization --- coreapi/linphonecore.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/coreapi/linphonecore.h b/coreapi/linphonecore.h index 55f16a173..f6ea130ef 100644 --- a/coreapi/linphonecore.h +++ b/coreapi/linphonecore.h @@ -1110,13 +1110,13 @@ LINPHONE_PUBLIC char* linphone_proxy_config_normalize_phone_number(LinphoneProxy * A sip address should look like DisplayName \ . * Basically this function performs the following tasks * - if a phone number is entered, prepend country prefix and eventually escape the '+' by 00 of the proxy config. - * - if no domain part is supplied, append the domain name of the proxy config. + * - if no domain part is supplied, append the domain name of the proxy config. Returns NULL if no proxy is provided at this point. * - if no sip: is present, prepend it. * * The result is a syntactically correct SIP address. - * @param proxy #LinphoneProxyConfig object containing country code, escape symbol and/or domain name. If NULL passed, will use default configuration. + * @param proxy #LinphoneProxyConfig object containing country code, escape symbol and/or domain name. Can be NULL if domain is already provided. * @param username the string to parse - * @return NULL if invalid phone number, normalized phone number from username input otherwise. + * @return NULL if invalid input, normalized sip address otherwise. */ LINPHONE_PUBLIC LinphoneAddress* linphone_proxy_config_normalize_sip_uri(LinphoneProxyConfig *proxy, const char *username);