From 9f14b4e9ddcf10ddfba0e82fe600c855a9f5c518 Mon Sep 17 00:00:00 2001 From: Simon Morlat Date: Mon, 17 Sep 2012 14:40:35 +0200 Subject: [PATCH] javadoc fixes --- .../org/linphone/core/LinphoneCall.java | 2 +- .../org/linphone/core/LinphoneCore.java | 8 ++--- .../linphone/core/LinphoneCoreListener.java | 34 +++++++++---------- java/common/org/linphone/core/package.html | 7 +++- 4 files changed, 28 insertions(+), 23 deletions(-) diff --git a/java/common/org/linphone/core/LinphoneCall.java b/java/common/org/linphone/core/LinphoneCall.java index c42ebb74..6fe6704d 100644 --- a/java/common/org/linphone/core/LinphoneCall.java +++ b/java/common/org/linphone/core/LinphoneCall.java @@ -21,7 +21,7 @@ package org.linphone.core; import java.util.Vector; /** - * Object representing a Call. calls are created using {@link LinphoneCore#invite(LinphoneAddress)} or passed to the application by listener {@link LinphoneCoreListener#callState(LinphoneCore, LinphoneCall, State, String)} + * Object representing a call. Calls are created using {@link LinphoneCore#invite(LinphoneAddress)} or passed to the application by listener {@link LinphoneCoreListener#callState} * */ diff --git a/java/common/org/linphone/core/LinphoneCore.java b/java/common/org/linphone/core/LinphoneCore.java index dbe5611d..9e2af91b 100644 --- a/java/common/org/linphone/core/LinphoneCore.java +++ b/java/common/org/linphone/core/LinphoneCore.java @@ -373,7 +373,7 @@ public interface LinphoneCore { * Accept an incoming call. * * Basically the application is notified of incoming calls within the - * {@link LinphoneCoreListener#inviteReceived(LinphoneCore, String)} listener. + * {@link LinphoneCoreListener#callState} listener method. * The application can later respond positively to the call using * this method. * @throws LinphoneCoreException @@ -384,7 +384,7 @@ public interface LinphoneCore { * Accept an incoming call. * * Basically the application is notified of incoming calls within the - * {@link LinphoneCoreListener#inviteReceived(LinphoneCore, String)} listener. + * {@link LinphoneCoreListener#callState} listener method. * The application can later respond positively to the call using * this method. * @throws LinphoneCoreException @@ -395,7 +395,7 @@ public interface LinphoneCore { * Accept call modifications initiated by other end. * * Basically the application is notified of incoming calls within the - * {@link LinphoneCoreListener#inviteReceived(LinphoneCore, String)} listener. + * {@link LinphoneCoreListener#callState} listener method. * The application can later respond positively to the call using * this method. * @throws LinphoneCoreException @@ -407,7 +407,7 @@ public interface LinphoneCore { * Prevent LinphoneCore from performing an automatic answer * * Basically the application is notified of incoming calls within the - * {@link LinphoneCoreListener#inviteReceived(LinphoneCore, String)} listener. + * {@link LinphoneCoreListener#callState} listener method. * The application can later respond positively to the call using * this method. * @throws LinphoneCoreException diff --git a/java/common/org/linphone/core/LinphoneCoreListener.java b/java/common/org/linphone/core/LinphoneCoreListener.java index ab9dd1ac..150141ff 100644 --- a/java/common/org/linphone/core/LinphoneCoreListener.java +++ b/java/common/org/linphone/core/LinphoneCoreListener.java @@ -24,27 +24,10 @@ package org.linphone.core; *This interface holds all callbacks that the application should implement. None is mandatory. */ public interface LinphoneCoreListener { - - /**< Notifies the application that it should show up - * @return */ - void show(LinphoneCore lc); - /**< Ask the application some authentication information * @return */ void authInfoRequested(LinphoneCore lc,String realm,String username); - /**< Callback that notifies various events with human readable text. - * @return */ - void displayStatus(LinphoneCore lc,String message); - - /**< Callback to display a message to the user - * @return */ - void displayMessage(LinphoneCore lc,String message); - - /** Callback to display a warning to the user - * @return */ - void displayWarning(LinphoneCore lc,String message); - /** General State notification * @param state LinphoneCore.State * @return @@ -121,5 +104,22 @@ public interface LinphoneCoreListener { * */ void notifyReceived(LinphoneCore lc, LinphoneCall call, LinphoneAddress from, byte[] event); + + + /**< @Deprecated Notifies the application that it should show up + * @return */ + void show(LinphoneCore lc); + /**< @Deprecated Callback that notifies various events with human readable text. + * @return */ + void displayStatus(LinphoneCore lc,String message); + + /**< @Deprecated Callback to display a message to the user + * @return */ + void displayMessage(LinphoneCore lc,String message); + + /** @Deprecated Callback to display a warning to the user + * @return */ + void displayWarning(LinphoneCore lc,String message); + } diff --git a/java/common/org/linphone/core/package.html b/java/common/org/linphone/core/package.html index d499e5d6..8371def4 100644 --- a/java/common/org/linphone/core/package.html +++ b/java/common/org/linphone/core/package.html @@ -159,7 +159,12 @@ Any subsequente modifications to {@link org.linphone.core.LinphoneFriend} must b my_friend.enableSubscribes(true); /*disable subscription for this friend*/ my_friend.done(); /*commit changes triggering an UNSUBSCRIBE message*/ - + Do not display status messages +-J Pass directly to the runtime system + +Provided by Standard doclet: +-d Destination directory for output files +-use Publishing presence status
Local presence status can be changed using function {@link org.linphone.core.LinphoneCore#setPresenceInfo }.New status is propagated to all friends {@link org.linphone.core.LinphoneCore#addFriend(LinphoneFriend lf) previously added } to LinphoneCore. -- 2.39.2