From 823f20b21beec2ee41b369542c17c59c91cf2b87 Mon Sep 17 00:00:00 2001 From: Simon Morlat Date: Tue, 1 Jul 2014 23:10:18 +0200 Subject: [PATCH] add documentation to createLinphoneCore() --- .../org/linphone/core/LinphoneCoreFactory.java | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/java/common/org/linphone/core/LinphoneCoreFactory.java b/java/common/org/linphone/core/LinphoneCoreFactory.java index 0a6efc305..5838594dc 100644 --- a/java/common/org/linphone/core/LinphoneCoreFactory.java +++ b/java/common/org/linphone/core/LinphoneCoreFactory.java @@ -66,7 +66,24 @@ abstract public class LinphoneCoreFactory { * */ abstract public LinphoneAuthInfo createAuthInfo(String username, String userid, String passwd, String ha1, String realm, String domain); + /** + * Create a LinphoneCore object. The LinphoneCore is the root for all liblinphone operations. You need only one per application. + * @param listener listener to receive notifications from the core + * @param userConfig path where to read/write configuration (optional) + * @param factoryConfig path where to read factory configuration (optional) + * @param userdata any kind of application specific data + * @param context an application context, on android this MUST be the android.content.Context object used by the application. + * @return a LinphoneCore object. + * @throws LinphoneCoreException + */ abstract public LinphoneCore createLinphoneCore(LinphoneCoreListener listener, String userConfig,String factoryConfig,Object userdata, Object context) throws LinphoneCoreException; + /** + * Create a LinphoneCore object. The LinphoneCore is the root for all liblinphone operations. You need only one per application. + * @param listener listener to receive notifications from the core. + * @param context an application context, on android this MUST be the android.content.Context object used by the application. + * @return the LinphoneCore object. + * @throws LinphoneCoreException + */ abstract public LinphoneCore createLinphoneCore(LinphoneCoreListener listener, Object context) throws LinphoneCoreException;