From 5ce6d7410895a65f1c0458ab7234eb5dc3350efe Mon Sep 17 00:00:00 2001
From: Simon Morlat <simon.morlat@linphone.org>
Date: Thu, 8 Apr 2010 21:26:22 +0200
Subject: [PATCH] add documentation of linphone_core_interpret_url().

---
 coreapi/linphonecore.c | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/coreapi/linphonecore.c b/coreapi/linphonecore.c
index 90e43797c..54b418c21 100644
--- a/coreapi/linphonecore.c
+++ b/coreapi/linphonecore.c
@@ -1691,6 +1691,19 @@ void linphone_core_iterate(LinphoneCore *lc){
 	}
 }
 
+/**
+ * Interpret a call destination as supplied by the user, and returns a fully qualified
+ * LinphoneAddress.
+ *
+ * A sip address should look like DisplayName <sip:username@domain:port> .
+ * 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.
+ * - if no domain part is supplied, append the domain name of the default proxy
+ * - if no sip: is present, prepend it
+ * 
+ * The result is a syntaxically correct SIP address.
+**/
 
 LinphoneAddress * linphone_core_interpret_url(LinphoneCore *lc, const char *url){
 	enum_lookup_res_t *enumres=NULL;