diff --git a/java/common/org/linphone/core/LinphoneChatMessage.java b/java/common/org/linphone/core/LinphoneChatMessage.java index fab2bab28..972a39d1d 100644 --- a/java/common/org/linphone/core/LinphoneChatMessage.java +++ b/java/common/org/linphone/core/LinphoneChatMessage.java @@ -230,7 +230,7 @@ public interface LinphoneChatMessage { /** * Fulfill a chat message char by char. Message linked to a Real Time Text Call send char in realtime following RFC 4103/T.140 * To commit a message, use #linphone_chat_room_send_message - * @param[in] character T.140 char + * @param character T.140 char * @throw LinphoneCoreExeption . */ void putChar(long character) throws LinphoneCoreException; diff --git a/java/common/org/linphone/core/LinphoneCore.java b/java/common/org/linphone/core/LinphoneCore.java index f63c017ef..08e8a47cf 100644 --- a/java/common/org/linphone/core/LinphoneCore.java +++ b/java/common/org/linphone/core/LinphoneCore.java @@ -1027,7 +1027,7 @@ public interface LinphoneCore { LinphoneFriendList[] getFriendLists(); /** - * @brief Set my presence status + * Set my presence status * @param minutes_away how long in away * @param alternative_contact sip uri used to redirect call in state LinphoneStatusMoved * @param status OnlineStatus @@ -1035,18 +1035,18 @@ public interface LinphoneCore { */ void setPresenceInfo(int minutes_away, String alternative_contact, OnlineStatus status); /** - * @brief Get my presence status + * Get my presence status * @return OnlineStatus * @deprecated Use getPresenceModel() instead */ OnlineStatus getPresenceInfo(); /** - * @brief Set my presence status + * Set my presence status * @param presence #LinphonePresenceModel */ void setPresenceModel(PresenceModel presence); /** - * @brief Get my presence status + * Get my presence status * @return A #PresenceModel object, or null if no presence model has been set. */ PresenceModel getPresenceModel(); @@ -1555,7 +1555,7 @@ public interface LinphoneCore { * which could result in an active call. * Eg: don't start a new call if one is in outgoing ringing. * Eg: don't merge to conference either as it could result - * in two active calls (conference and accepted call). + * in two active calls (conference and accepted call). * @return */ boolean soundResourcesLocked(); diff --git a/java/common/org/linphone/core/LinphoneFriend.java b/java/common/org/linphone/core/LinphoneFriend.java index d210833eb..a6f159864 100644 --- a/java/common/org/linphone/core/LinphoneFriend.java +++ b/java/common/org/linphone/core/LinphoneFriend.java @@ -109,18 +109,18 @@ public interface LinphoneFriend { */ boolean isPresenceReceived(); /** - * @brief Get the status of a friend + * Get the status of a friend * @return OnlineStatus * @deprecated Use getPresenceModel() instead */ OnlineStatus getStatus(); /** - * @brief Get the presence information of a friend + * Get the presence information of a friend * @return A #PresenceModel object, or null if the friend do not have presence information (in which case he is considered offline) */ PresenceModel getPresenceModel(); /** - * @brief Set the presence information of a friend + * Set the presence information of a friend * @param presenceModel A #PresenceModel object */ void setPresenceModel(PresenceModel presenceModel); diff --git a/java/common/org/linphone/core/PresenceActivity.java b/java/common/org/linphone/core/PresenceActivity.java index b965b526b..286184ece 100644 --- a/java/common/org/linphone/core/PresenceActivity.java +++ b/java/common/org/linphone/core/PresenceActivity.java @@ -22,39 +22,39 @@ package org.linphone.core; public interface PresenceActivity { /** - * @brief Gets the string representation of a presence activity. + * Gets the string representation of a presence activity. * @return A String representing the given activity. */ String toString(); /** - * @brief Gets the activity type of a presence activity. + * Gets the activity type of a presence activity. * @return The #PresenceActivityType of the activity. */ PresenceActivityType getType(); /** - * @brief Sets the type of activity of a presence activity. - * @param[in] acttype The activity type to set for the activity. + * Sets the type of activity of a presence activity. + * @param acttype The activity type to set for the activity. * @return 0 if successful, a value < 0 in case of error. */ int setType(PresenceActivityType type); /** - * @brief Gets the description of a presence activity. + * Gets the description of a presence activity. * @return A String containing the description of the presence activity, or null if no description is specified. */ String getDescription(); /** - * @brief Sets the description of a presence activity. - * @param[in] description An additional description of the activity. Can be null if no additional description is to be added. + * Sets the description of a presence activity. + * @param description An additional description of the activity. Can be null if no additional description is to be added. * @return 0 if successful, a value < 0 in case of error. */ int setDescription(String description); /** - * @brief Gets the native pointer for this object. + * Gets the native pointer for this object. */ long getNativePtr(); diff --git a/java/common/org/linphone/core/PresenceModel.java b/java/common/org/linphone/core/PresenceModel.java index 78bc264c2..277b4466c 100644 --- a/java/common/org/linphone/core/PresenceModel.java +++ b/java/common/org/linphone/core/PresenceModel.java @@ -22,46 +22,46 @@ package org.linphone.core; public interface PresenceModel { /** - * @brief Gets the basic status of a presence model. + * Gets the basic status of a presence model. * @return The #BasicStatus of the #PresenceModel object. */ PresenceBasicStatus getBasicStatus(); /** - * @brief Sets the basic status of a presence model. - * @param[in] basic_status The #BasicStatus to set for the #PresenceModel object. + * Sets the basic status of a presence model. + * @param basic_status The #BasicStatus to set for the #PresenceModel object. * @return 0 if successful, a value < 0 in case of error. */ int setBasicStatus(PresenceBasicStatus basic_status); /** - * @brief Gets the timestamp of a presence model. + * Gets the timestamp of a presence model. * @return The timestamp of the #LinphonePresenceModel object or -1 on error. */ long getTimestamp(); /** - * @brief Gets the contact of a presence model. + * Gets the contact of a presence model. * @return A string containing the contact, or null if no contact is found. */ String getContact(); /** - * @brief Sets the contact of a presence model. + * Sets the contact of a presence model. * @param contact The contact string to set. */ void setContact(String contact); /** - * @brief Gets the first activity of a presence model (there is usually only one). + * Gets the first activity of a presence model (there is usually only one). * @return A #PresenceActivity object if successful, null otherwise. */ PresenceActivity getActivity(); /** - * @brief Sets the activity of a presence model (limits to only one activity). - * @param[in] activity The #PresenceActivityType to set for the model. - * @param[in] description An additional description of the activity to set for the model. Can be null if no additional description is to be added. + * Sets the activity of a presence model (limits to only one activity). + * @param activity The #PresenceActivityType to set for the model. + * @param description An additional description of the activity to set for the model. Can be null if no additional description is to be added. * @return 0 if successful, a value < 0 in case of error. * * WARNING: This method will modify the basic status of the model according to the activity being set. @@ -70,42 +70,42 @@ public interface PresenceModel { int setActivity(PresenceActivityType activity, String description); /** - * @brief Gets the number of activities included in the presence model. + * Gets the number of activities included in the presence model. * @return The number of activities included in the #PresenceModel object. */ long getNbActivities(); /** - * @brief Gets the nth activity of a presence model. + * Gets the nth activity of a presence model. * @param idx The index of the activity to get (the first activity having the index 0). * @return A #PresenceActivity object if successful, null otherwise. */ PresenceActivity getNthActivity(long idx); /** - * @brief Adds an activity to a presence model. - * @param[in] activity The #PresenceActivity to add to the model. + * Adds an activity to a presence model. + * @param activity The #PresenceActivity to add to the model. * @return 0 if successful, a value < 0 in case of error. */ int addActivity(PresenceActivity activity); /** - * @brief Clears the activities of a presence model. + * Clears the activities of a presence model. * @return 0 if successful, a value < 0 in case of error. */ int clearActivities(); /** - * @brief Gets the first note of a presence model (there is usually only one). - * @param[in] lang The language of the note to get. Can be null to get a note that has no language specified or to get the first note whatever language it is written into. + * Gets the first note of a presence model (there is usually only one). + * @param lang The language of the note to get. Can be null to get a note that has no language specified or to get the first note whatever language it is written into. * @return A #PresenceNote object if successful, null otherwise. */ PresenceNote getNote(String lang); /** - * @brief Adds a note to a presence model. - * @param[in] note_content The note to be added to the presence model. - * @param[in] lang The language of the note to be added. Can be null if no language is to be specified for the note. + * Adds a note to a presence model. + * @param note_content The note to be added to the presence model. + * @param lang The language of the note to be added. Can be null if no language is to be specified for the note. * @return 0 if successful, a value < 0 in case of error. * * Only one note for each language can be set, so e.g. setting a note for the 'fr' language if there is only one will replace the existing one. @@ -113,59 +113,59 @@ public interface PresenceModel { int addNote(String note_content, String lang); /** - * @brief Clears all the notes of a presence model. + * Clears all the notes of a presence model. * @return 0 if successful, a value < 0 in case of error. */ int clearNotes(); /** - * @brief Gets the number of services included in the presence model. + * Gets the number of services included in the presence model. * @return The number of services included in the #PresenceModel object. */ long getNbServices(); /** - * @brief Gets the nth service of a presence model. - * @param[in] idx The index of the service to get (the first service having the index 0). + * Gets the nth service of a presence model. + * @param idx The index of the service to get (the first service having the index 0). * @return A #PresenceService object if successful, null otherwise. */ PresenceService getNthService(long idx); /** - * @brief Adds a service to a presence model. - * @param[in] service The #PresenceService object to add to the model. + * Adds a service to a presence model. + * @param service The #PresenceService object to add to the model. * @return 0 if successful, a value < 0 in case of error. */ int addService(PresenceService service); /** - * @brief Clears the services of a presence model. + * Clears the services of a presence model. * @return 0 if successful, a value < 0 in case of error. */ int clearServices(); /** - * @brief Gets the number of persons included in the presence model. + * Gets the number of persons included in the presence model. * @return The number of persons included in the #PresenceModel object. */ long getNbPersons(); /** - * @brief Gets the nth person of a presence model. - * @param[in] idx The index of the person to get (the first person having the index 0). + * Gets the nth person of a presence model. + * @param idx The index of the person to get (the first person having the index 0). * @return A pointer to a #PresencePerson object if successful, null otherwise. */ PresencePerson getNthPerson(long idx); /** - * @brief Adds a person to a presence model. - * @param[in] person The #PresencePerson object to add to the model. + * Adds a person to a presence model. + * @param person The #PresencePerson object to add to the model. * @return 0 if successful, a value < 0 in case of error. */ int addPerson(PresencePerson person); /** - * @brief Clears the persons of a presence model. + * Clears the persons of a presence model. * @return 0 if successful, a value < 0 in case of error. */ int clearPersons(); diff --git a/java/common/org/linphone/core/PresenceNote.java b/java/common/org/linphone/core/PresenceNote.java index 9353d9de4..fbfb36332 100644 --- a/java/common/org/linphone/core/PresenceNote.java +++ b/java/common/org/linphone/core/PresenceNote.java @@ -22,33 +22,33 @@ package org.linphone.core; public interface PresenceNote { /** - * @brief Gets the content of a presence note. + * Gets the content of a presence note. * @return A String with the content of the presence note. */ String getContent(); /** - * @brief Sets the content of a presence note. - * @param[in] content The content of the note. + * Sets the content of a presence note. + * @param content The content of the note. * @return 0 if successful, a value < 0 in case of error. */ int setContent(String content); /** - * @brief Gets the language of a presence note. + * Gets the language of a presence note. * @return A String containing the language of the presence note, or null if no language is specified. */ String getLang(); /** - * @brief Sets the language of a presence note. - * @param[in] lang The language of the note. + * Sets the language of a presence note. + * @param lang The language of the note. * @return 0 if successful, a value < 0 in case of error. */ int setLang(String lang); /** - * @brief Gets the native pointer for this object. + * Gets the native pointer for this object. */ long getNativePtr(); diff --git a/java/common/org/linphone/core/PresencePerson.java b/java/common/org/linphone/core/PresencePerson.java index 730aafe77..11eb6bfd3 100644 --- a/java/common/org/linphone/core/PresencePerson.java +++ b/java/common/org/linphone/core/PresencePerson.java @@ -22,98 +22,98 @@ package org.linphone.core; public interface PresencePerson { /** - * @brief Gets the id of a presence person. + * Gets the id of a presence person. * @return A string containing the id. */ String getId(); /** - * @brief Sets the id of a presence person. - * @param[in] id The id string to set. Can be null to generate it automatically. + * Sets the id of a presence person. + * @param id The id string to set. Can be null to generate it automatically. * @return 0 if successful, a value < 0 in case of error. */ int setId(String id); /** - * @brief Gets the number of activities included in the presence person. + * Gets the number of activities included in the presence person. * @return The number of activities included in the #PresencePerson object. */ long getNbActivities(); /** - * @brief Gets the nth activity of a presence person. - * @param[in] idx The index of the activity to get (the first activity having the index 0). + * Gets the nth activity of a presence person. + * @param idx The index of the activity to get (the first activity having the index 0). * @return A #PresenceActivity object if successful, null otherwise. */ PresenceActivity getNthActivity(long idx); /** - * @brief Adds an activity to a presence person. - * @param[in] activity The #PresenceActivity object to add to the person. + * Adds an activity to a presence person. + * @param activity The #PresenceActivity object to add to the person. * @return 0 if successful, a value < 0 in case of error. */ int addActivity(PresenceActivity activity); /** - * @brief Clears the activities of a presence person. + * Clears the activities of a presence person. * @return 0 if successful, a value < 0 in case of error. */ int clearActivities(); /** - * @brief Gets the number of notes included in the presence person. + * Gets the number of notes included in the presence person. * @return The number of notes included in the #PresencePerson object. */ long getNbNotes(); /** - * @brief Gets the nth note of a presence person. - * @param[in] idx The index of the note to get (the first note having the index 0). + * Gets the nth note of a presence person. + * @param idx The index of the note to get (the first note having the index 0). * @return A pointer to a #PresenceNote object if successful, null otherwise. */ PresenceNote getNthNote(long idx); /** - * @brief Adds a note to a presence person. - * @param[in] note The #PresenceNote object to add to the person. + * Adds a note to a presence person. + * @param note The #PresenceNote object to add to the person. * @return 0 if successful, a value < 0 in case of error. */ int addNote(PresenceNote note); /** - * @brief Clears the notes of a presence person. + * Clears the notes of a presence person. * @return 0 if successful, a value < 0 in case of error. */ int clearNotes(); /** - * @brief Gets the number of activities notes included in the presence person. + * Gets the number of activities notes included in the presence person. * @return The number of activities notes included in the #PresencePerson object. */ long getNbActivitiesNotes(); /** - * @brief Gets the nth activities note of a presence person. - * @param[in] idx The index of the activities note to get (the first note having the index 0). + * Gets the nth activities note of a presence person. + * @param idx The index of the activities note to get (the first note having the index 0). * @return A pointer to a #PresenceNote object if successful, null otherwise. */ PresenceNote getNthActivitiesNote(long idx); /** - * @brief Adds an activities note to a presence person. - * @param[in] note The #PresenceNote object to add to the person. + * Adds an activities note to a presence person. + * @param note The #PresenceNote object to add to the person. * @return 0 if successful, a value < 0 in case of error. */ int addActivitiesNote(PresenceNote note); /** - * @brief Clears the activities notes of a presence person. + * Clears the activities notes of a presence person. * @return 0 if successful, a value < 0 in case of error. */ int clearActivitesNotes(); /** - * @brief Gets the native pointer for this object. + * Gets the native pointer for this object. */ long getNativePtr(); diff --git a/java/common/org/linphone/core/PresenceService.java b/java/common/org/linphone/core/PresenceService.java index 3e06b6774..18d8004ca 100644 --- a/java/common/org/linphone/core/PresenceService.java +++ b/java/common/org/linphone/core/PresenceService.java @@ -22,72 +22,72 @@ package org.linphone.core; public interface PresenceService { /** - * @brief Gets the id of a presence service. + * Gets the id of a presence service. * @return A string containing the id. */ String getId(); /** - * @brief Sets the id of a presence service. - * @param[in] id The id string to set. Can be null to generate it automatically. + * Sets the id of a presence service. + * @param id The id string to set. Can be null to generate it automatically. * @return 0 if successful, a value < 0 in case of error. */ int setId(String id); /** - * @brief Gets the basic status of a presence service. + * Gets the basic status of a presence service. * @return The #PresenceBasicStatus of the #PresenceService object. */ PresenceBasicStatus getBasicStatus(); /** - * @brief Sets the basic status of a presence service. - * @param[in] status The #PresenceBasicStatus to set for the #PresenceService object. + * Sets the basic status of a presence service. + * @param status The #PresenceBasicStatus to set for the #PresenceService object. * @return 0 if successful, a value < 0 in case of error. */ int setBasicStatus(PresenceBasicStatus status); /** - * @brief Gets the contact of a presence service. + * Gets the contact of a presence service. * @return A string containing the contact, or null if no contact is found. */ String getContact(); /** - * @brief Sets the contact of a presence service. - * @param[in] contact The contact string to set. + * Sets the contact of a presence service. + * @param contact The contact string to set. * @return 0 if successful, a value < 0 in case of error. */ int setContact(String contact); /** - * @brief Gets the number of notes included in the presence service. + * Gets the number of notes included in the presence service. * @return The number of notes included in the #PresenceService object. */ long getNbNotes(); /** - * @brief Gets the nth note of a presence service. - * @param[in] idx The index of the note to get (the first note having the index 0). + * Gets the nth note of a presence service. + * @param idx The index of the note to get (the first note having the index 0). * @return A pointer to a #PresenceNote object if successful, null otherwise. */ PresenceNote getNthNote(long idx); /** - * @brief Adds a note to a presence service. - * @param[in] note The #PresenceNote object to add to the service. + * Adds a note to a presence service. + * @param note The #PresenceNote object to add to the service. * @return 0 if successful, a value < 0 in case of error. */ int addNote(PresenceNote note); /** - * @brief Clears the notes of a presence service. + * Clears the notes of a presence service. * @return 0 if successful, a value < 0 in case of error. */ int clearNotes(); /** - * @brief Gets the native pointer for this object. + * Gets the native pointer for this object. */ long getNativePtr();