forked from mirrors/linphone-iphone
Doxygen: replace invalid @returns with @return
This commit is contained in:
Gautier Pelloux-Prayer
parent
7afeede178
commit
9e6fa8ceb6
11 changed files with 40 additions and 40 deletions
|
|
@ -30,4 +30,4 @@ namespace linphone_tester_native
|
|||
Platform::String^ testName(Platform::String^ suiteName, int testIndex);
|
||||
void run(Platform::String^ suiteName, Platform::String^ caseName, Platform::Boolean verbose);
|
||||
};
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -484,7 +484,7 @@ LinphoneChatRoom * linphone_core_create_chat_room(LinphoneCore *lc, const char *
|
|||
* Get a chat room whose peer is the supplied address. If it does not exist yet, it will be created.
|
||||
* @param lc the linphone core
|
||||
* @param addr a linphone address.
|
||||
* @returns #LinphoneChatRoom where messaging can take place.
|
||||
* @return #LinphoneChatRoom where messaging can take place.
|
||||
**/
|
||||
LinphoneChatRoom *linphone_core_get_chat_room(LinphoneCore *lc, const LinphoneAddress *addr){
|
||||
LinphoneChatRoom *ret = _linphone_core_get_chat_room(lc, addr);
|
||||
|
|
@ -498,7 +498,7 @@ LinphoneChatRoom *linphone_core_get_chat_room(LinphoneCore *lc, const LinphoneAd
|
|||
* Get a chat room for messaging from a sip uri like sip:joe@sip.linphone.org. If it does not exist yet, it will be created.
|
||||
* @param lc The linphone core
|
||||
* @param to The destination address for messages.
|
||||
* @returns #LinphoneChatRoom where messaging can take place.
|
||||
* @return #LinphoneChatRoom where messaging can take place.
|
||||
**/
|
||||
LinphoneChatRoom * linphone_core_get_chat_room_from_uri(LinphoneCore *lc, const char *to) {
|
||||
return _linphone_core_get_or_create_chat_room(lc, to);
|
||||
|
|
|
|||
|
|
@ -157,7 +157,7 @@ static void add_local_endpoint(LinphoneConference *conf,LinphoneCore *lc){
|
|||
/**
|
||||
* Returns the sound volume (mic input) of the local participant of the conference.
|
||||
* @param lc the linphone core
|
||||
* @returns the measured input volume expressed in dbm0.
|
||||
* @return the measured input volume expressed in dbm0.
|
||||
**/
|
||||
float linphone_core_get_conference_local_input_volume(LinphoneCore *lc){
|
||||
LinphoneConference *conf=&lc->conf_ctx;
|
||||
|
|
@ -180,7 +180,7 @@ float linphone_core_get_conference_local_input_volume(LinphoneCore *lc){
|
|||
* If the local user was actively part of the call (ie not in paused state), then the local user is automatically entered into the conference.
|
||||
* If the call was in paused state, then it is automatically resumed when entering into the conference.
|
||||
*
|
||||
* @returns 0 if successful, -1 otherwise.
|
||||
* @return 0 if successful, -1 otherwise.
|
||||
**/
|
||||
int linphone_core_add_to_conference(LinphoneCore *lc, LinphoneCall *call){
|
||||
LinphoneConference *conf=&lc->conf_ctx;
|
||||
|
|
@ -289,7 +289,7 @@ static int convert_conference_to_call(LinphoneCore *lc){
|
|||
* In other words, unless linphone_core_leave_conference() is explicitely called, the last remote participant of a conference is automatically
|
||||
* put in a simple call in running state.
|
||||
*
|
||||
* @returns 0 if successful, -1 otherwise.
|
||||
* @return 0 if successful, -1 otherwise.
|
||||
**/
|
||||
int linphone_core_remove_from_conference(LinphoneCore *lc, LinphoneCall *call){
|
||||
int err;
|
||||
|
|
@ -314,7 +314,7 @@ int linphone_core_remove_from_conference(LinphoneCore *lc, LinphoneCall *call){
|
|||
/**
|
||||
* Indicates whether the local participant is part of the conference.
|
||||
* @param lc the linphone core
|
||||
* @returns TRUE if the local participant is in the conference, FALSE otherwise.
|
||||
* @return TRUE if the local participant is in the conference, FALSE otherwise.
|
||||
**/
|
||||
bool_t linphone_core_is_in_conference(const LinphoneCore *lc){
|
||||
return lc->conf_ctx.local_participant!=NULL;
|
||||
|
|
@ -324,7 +324,7 @@ bool_t linphone_core_is_in_conference(const LinphoneCore *lc){
|
|||
* Moves the local participant out of the conference.
|
||||
* @param lc the linphone core
|
||||
* When the local participant is out of the conference, the remote participants can continue to talk normally.
|
||||
* @returns 0 if successful, -1 otherwise.
|
||||
* @return 0 if successful, -1 otherwise.
|
||||
**/
|
||||
int linphone_core_leave_conference(LinphoneCore *lc){
|
||||
LinphoneConference *conf=&lc->conf_ctx;
|
||||
|
|
@ -342,7 +342,7 @@ int linphone_core_leave_conference(LinphoneCore *lc){
|
|||
* However, by calling linphone_core_leave_conference() and linphone_core_enter_conference() the application can decide to temporarily
|
||||
* move out and in the local participant from the conference.
|
||||
*
|
||||
* @returns 0 if successful, -1 otherwise
|
||||
* @return 0 if successful, -1 otherwise
|
||||
**/
|
||||
int linphone_core_enter_conference(LinphoneCore *lc){
|
||||
LinphoneConference *conf;
|
||||
|
|
@ -363,7 +363,7 @@ int linphone_core_enter_conference(LinphoneCore *lc){
|
|||
*
|
||||
* Merge all established calls (either in LinphoneCallStreamsRunning or LinphoneCallPaused) into a conference.
|
||||
*
|
||||
* @returns 0 if successful, -1 otherwise
|
||||
* @return 0 if successful, -1 otherwise
|
||||
**/
|
||||
int linphone_core_add_all_to_conference(LinphoneCore *lc) {
|
||||
MSList *calls=lc->calls;
|
||||
|
|
@ -384,7 +384,7 @@ int linphone_core_add_all_to_conference(LinphoneCore *lc) {
|
|||
*
|
||||
* All the calls that were merged to the conference are terminated, and the conference resources are destroyed.
|
||||
*
|
||||
* @returns 0 if successful, -1 otherwise
|
||||
* @return 0 if successful, -1 otherwise
|
||||
**/
|
||||
int linphone_core_terminate_conference(LinphoneCore *lc) {
|
||||
MSList *calls=lc->calls;
|
||||
|
|
@ -408,7 +408,7 @@ int linphone_core_terminate_conference(LinphoneCore *lc) {
|
|||
* Typically, after merging two calls into the conference, there is total of 3 participants:
|
||||
* the local participant (or local user), and two remote participants that were the destinations of the two previously establised calls.
|
||||
*
|
||||
* @returns the number of participants to the conference
|
||||
* @return the number of participants to the conference
|
||||
**/
|
||||
int linphone_core_get_conference_size(LinphoneCore *lc) {
|
||||
LinphoneConference *conf=&lc->conf_ctx;
|
||||
|
|
|
|||
|
|
@ -2511,7 +2511,7 @@ float linphone_call_get_record_volume(LinphoneCall *call){
|
|||
* 1-2 = very poor quality <br>
|
||||
* 0-1 = can't be worse, mostly unusable <br>
|
||||
*
|
||||
* @returns The function returns -1 if no quality measurement is available, for example if no
|
||||
* @return The function returns -1 if no quality measurement is available, for example if no
|
||||
* active audio stream exist. Otherwise it returns the quality rating.
|
||||
**/
|
||||
float linphone_call_get_current_quality(LinphoneCall *call){
|
||||
|
|
|
|||
|
|
@ -6011,7 +6011,7 @@ void linphone_core_set_rtp_transport_factories(LinphoneCore* lc, LinphoneRtpTran
|
|||
*
|
||||
* @note Remote RTP statistics is not implemented yet.
|
||||
*
|
||||
* @returns 0 or -1 if no call is running.
|
||||
* @return 0 or -1 if no call is running.
|
||||
**/
|
||||
|
||||
int linphone_core_get_current_call_stats(LinphoneCore *lc, rtp_stats_t *local, rtp_stats_t *remote){
|
||||
|
|
|
|||
|
|
@ -729,7 +729,7 @@ LINPHONE_PUBLIC bool_t linphone_call_media_in_progress(LinphoneCall *call);
|
|||
* The dtmf is automatically played to the user.
|
||||
* @param call The LinphoneCall object
|
||||
* @param dtmf The dtmf name specified as a char, such as '0', '#' etc...
|
||||
* @returns 0 if successful, -1 on error.
|
||||
* @return 0 if successful, -1 on error.
|
||||
**/
|
||||
LINPHONE_PUBLIC int linphone_call_send_dtmf(LinphoneCall *lc,char dtmf);
|
||||
|
||||
|
|
@ -740,7 +740,7 @@ LINPHONE_PUBLIC int linphone_call_send_dtmf(LinphoneCall *lc,char dtmf);
|
|||
* Sending is canceled if the call state changes to something not LinphoneCallStreamsRunning.
|
||||
* @param call The LinphoneCall object
|
||||
* @param dtmfs A dtmf sequence such as '123#123123'
|
||||
* @returns -2 if there is already a DTMF sequence, -1 if call is not ready, 0 otherwise.
|
||||
* @return -2 if there is already a DTMF sequence, -1 if call is not ready, 0 otherwise.
|
||||
**/
|
||||
LINPHONE_PUBLIC int linphone_call_send_dtmfs(LinphoneCall *call,char *dtmfs);
|
||||
|
||||
|
|
@ -1870,7 +1870,7 @@ LINPHONE_PUBLIC void linphone_core_v_table_set_user_data(LinphoneCoreVTable *tab
|
|||
/**
|
||||
* Gets a user data pointer in the vtable.
|
||||
* @param table the vtable
|
||||
* @returns the data attached to the vtable
|
||||
* @return the data attached to the vtable
|
||||
*/
|
||||
LINPHONE_PUBLIC void* linphone_core_v_table_get_user_data(LinphoneCoreVTable *table);
|
||||
|
||||
|
|
@ -1878,7 +1878,7 @@ LINPHONE_PUBLIC void* linphone_core_v_table_get_user_data(LinphoneCoreVTable *ta
|
|||
* Gets the current VTable.
|
||||
* This is meant only to be called from a callback to be able to get the user_data associated with the vtable that called the callback.
|
||||
* @param lc the linphonecore
|
||||
* @returns the vtable that called the last callback
|
||||
* @return the vtable that called the last callback
|
||||
*/
|
||||
LINPHONE_PUBLIC LinphoneCoreVTable *linphone_core_get_current_vtable(LinphoneCore *lc);
|
||||
|
||||
|
|
|
|||
|
|
@ -261,14 +261,14 @@ LINPHONE_PUBLIC void linphone_friend_set_ref_key(LinphoneFriend *lf, const char
|
|||
/**
|
||||
* Get the reference key of a friend.
|
||||
* @param[in] lf #LinphoneFriend object.
|
||||
* @returns The reference key of the friend.
|
||||
* @return The reference key of the friend.
|
||||
**/
|
||||
LINPHONE_PUBLIC const char *linphone_friend_get_ref_key(const LinphoneFriend *lf);
|
||||
|
||||
/**
|
||||
* Check that the given friend is in a friend list.
|
||||
* @param[in] lf #LinphoneFriend object.
|
||||
* @returns TRUE if the friend is in a friend list, FALSE otherwise.
|
||||
* @return TRUE if the friend is in a friend list, FALSE otherwise.
|
||||
**/
|
||||
LINPHONE_PUBLIC bool_t linphone_friend_in_list(const LinphoneFriend *lf);
|
||||
|
||||
|
|
@ -372,7 +372,7 @@ LINPHONE_PUBLIC void linphone_core_notify_all_friends(LinphoneCore *lc, Linphone
|
|||
* Search a LinphoneFriend by its address.
|
||||
* @param[in] lc #LinphoneCore object.
|
||||
* @param[in] addr The address to use to search the friend.
|
||||
* @returns The #LinphoneFriend object corresponding to the given address.
|
||||
* @return The #LinphoneFriend object corresponding to the given address.
|
||||
* @deprecated use linphone_core_find_friend() instead.
|
||||
*/
|
||||
LINPHONE_PUBLIC LinphoneFriend *linphone_core_get_friend_by_address(const LinphoneCore *lc, const char *addr);
|
||||
|
|
@ -381,7 +381,7 @@ LINPHONE_PUBLIC LinphoneFriend *linphone_core_get_friend_by_address(const Linpho
|
|||
* Search a LinphoneFriend by its address.
|
||||
* @param[in] lc #LinphoneCore object.
|
||||
* @param[in] addr The address to use to search the friend.
|
||||
* @returns The #LinphoneFriend object corresponding to the given address.
|
||||
* @return The #LinphoneFriend object corresponding to the given address.
|
||||
*/
|
||||
LINPHONE_PUBLIC LinphoneFriend *linphone_core_find_friend(const LinphoneCore *lc, const LinphoneAddress *addr);
|
||||
|
||||
|
|
@ -389,7 +389,7 @@ LINPHONE_PUBLIC LinphoneFriend *linphone_core_find_friend(const LinphoneCore *lc
|
|||
* Search a LinphoneFriend by its reference key.
|
||||
* @param[in] lc #LinphoneCore object.
|
||||
* @param[in] key The reference key to use to search the friend.
|
||||
* @returns The #LinphoneFriend object corresponding to the given reference key.
|
||||
* @return The #LinphoneFriend object corresponding to the given reference key.
|
||||
*/
|
||||
LINPHONE_PUBLIC LinphoneFriend *linphone_core_get_friend_by_ref_key(const LinphoneCore *lc, const char *key);
|
||||
|
||||
|
|
|
|||
|
|
@ -200,7 +200,7 @@ typedef struct _LinphonePresenceNote LinphonePresenceNote;
|
|||
* Creates a presence model specifying an activity.
|
||||
* @param[in] activity The activity to set for the created presence model.
|
||||
* @param[in] description An additional description of the activity (mainly useful for the 'other' activity). Set it to NULL to not add a description.
|
||||
* @returns The created presence model, or NULL if an error occured.
|
||||
* @return The created presence model, or NULL if an error occured.
|
||||
* @see linphone_presence_model_new
|
||||
* @see linphone_presence_model_new_with_activity_and_note
|
||||
*
|
||||
|
|
@ -214,7 +214,7 @@ LINPHONE_PUBLIC LinphonePresenceModel * linphone_presence_model_new_with_activit
|
|||
* @param[in] description An additional description of the activity (mainly useful for the 'other' activity). Set it to NULL to not add a description.
|
||||
* @param[in] note An additional note giving additional information about the contact presence.
|
||||
* @param[in] lang The language the note is written in. It can be set to NULL in order to not specify the language of the note.
|
||||
* @returns The created presence model, or NULL if an error occured.
|
||||
* @return The created presence model, or NULL if an error occured.
|
||||
* @see linphone_presence_model_new_with_activity
|
||||
* @see linphone_presence_model_new_with_activity_and_note
|
||||
*
|
||||
|
|
@ -344,7 +344,7 @@ LINPHONE_PUBLIC int linphone_presence_model_clear_notes(LinphonePresenceModel *m
|
|||
|
||||
/**
|
||||
* Creates a default presence model.
|
||||
* @returns The created presence model, NULL on error.
|
||||
* @return The created presence model, NULL on error.
|
||||
* @see linphone_presence_model_new_with_activity
|
||||
* @see linphone_presence_model_new_with_activity_and_note
|
||||
*
|
||||
|
|
@ -422,7 +422,7 @@ LINPHONE_PUBLIC int linphone_presence_model_clear_persons(LinphonePresenceModel
|
|||
* @param[in] id The id of the presence service to be created. Can be NULL to generate it automatically.
|
||||
* @param[in] basic_status The #LinphonePresenceBasicStatus to set for the #LinphonePresenceService object.
|
||||
* @param[in] contact The contact string to set.
|
||||
* @returns The created presence service, NULL on error.
|
||||
* @return The created presence service, NULL on error.
|
||||
*
|
||||
* The created presence service has the basic status 'closed'.
|
||||
*/
|
||||
|
|
@ -515,7 +515,7 @@ LINPHONE_PUBLIC int linphone_presence_service_clear_notes(LinphonePresenceServic
|
|||
/**
|
||||
* Creates a presence person.
|
||||
* @param[in] id The id of the presence person to be created. Can be NULL to generate it automatically.
|
||||
* @returns The created presence person, NULL on error.
|
||||
* @return The created presence person, NULL on error.
|
||||
*/
|
||||
LINPHONE_PUBLIC LinphonePresencePerson * linphone_presence_person_new(const char *id);
|
||||
|
||||
|
|
@ -635,7 +635,7 @@ LINPHONE_PUBLIC int linphone_presence_person_clear_activities_notes(LinphonePres
|
|||
* Creates a presence activity.
|
||||
* @param[in] acttype The #LinphonePresenceActivityType to set for the activity.
|
||||
* @param[in] description An additional description of the activity to set for the activity. Can be NULL if no additional description is to be added.
|
||||
* @returns The created presence activity, NULL on error.
|
||||
* @return The created presence activity, NULL on error.
|
||||
*/
|
||||
LINPHONE_PUBLIC LinphonePresenceActivity * linphone_presence_activity_new(LinphonePresenceActivityType acttype, const char *description);
|
||||
|
||||
|
|
@ -687,7 +687,7 @@ LINPHONE_PUBLIC int linphone_presence_activity_set_description(LinphonePresenceA
|
|||
* Creates a presence note.
|
||||
* @param[in] content The content of the note to be created.
|
||||
* @param[in] lang The language of the note to be created. Can be NULL if no language is to be specified for the note.
|
||||
* @returns The created presence note, NULL on error.
|
||||
* @return The created presence note, NULL on error.
|
||||
*/
|
||||
LINPHONE_PUBLIC LinphonePresenceNote * linphone_presence_note_new(const char *content, const char *lang);
|
||||
|
||||
|
|
@ -876,14 +876,14 @@ LINPHONE_PUBLIC void * linphone_presence_note_get_user_data(const LinphonePresen
|
|||
* @param[in] lc #LinphoneCore object.
|
||||
* @param[in] acttype The #LinphonePresenceActivityType to set for the activity.
|
||||
* @param[in] description An additional description of the activity to set for the activity. Can be NULL if no additional description is to be added.
|
||||
* @returns The created #LinphonePresenceActivity object.
|
||||
* @return The created #LinphonePresenceActivity object.
|
||||
*/
|
||||
LINPHONE_PUBLIC LinphonePresenceActivity * linphone_core_create_presence_activity(LinphoneCore *lc, LinphonePresenceActivityType acttype, const char *description);
|
||||
|
||||
/**
|
||||
* Create a default LinphonePresenceModel.
|
||||
* @param[in] lc #LinphoneCore object.
|
||||
* @returns The created #LinphonePresenceModel object.
|
||||
* @return The created #LinphonePresenceModel object.
|
||||
*/
|
||||
LINPHONE_PUBLIC LinphonePresenceModel * linphone_core_create_presence_model(LinphoneCore *lc);
|
||||
|
||||
|
|
@ -892,7 +892,7 @@ LINPHONE_PUBLIC LinphonePresenceModel * linphone_core_create_presence_model(Linp
|
|||
* @param[in] lc #LinphoneCore object.
|
||||
* @param[in] acttype The #LinphonePresenceActivityType to set for the activity of the created model.
|
||||
* @param[in] description An additional description of the activity to set for the activity. Can be NULL if no additional description is to be added.
|
||||
* @returns The created #LinphonePresenceModel object.
|
||||
* @return The created #LinphonePresenceModel object.
|
||||
*/
|
||||
LINPHONE_PUBLIC LinphonePresenceModel * linphone_core_create_presence_model_with_activity(LinphoneCore *lc, LinphonePresenceActivityType acttype, const char *description);
|
||||
|
||||
|
|
@ -903,7 +903,7 @@ LINPHONE_PUBLIC LinphonePresenceModel * linphone_core_create_presence_model_with
|
|||
* @param[in] description An additional description of the activity to set for the activity. Can be NULL if no additional description is to be added.
|
||||
* @param[in] note The content of the note to be added to the created model.
|
||||
* @param[in] lang The language of the note to be added to the created model.
|
||||
* @returns The created #LinphonePresenceModel object.
|
||||
* @return The created #LinphonePresenceModel object.
|
||||
*/
|
||||
LINPHONE_PUBLIC LinphonePresenceModel * linphone_core_create_presence_model_with_activity_and_note(LinphoneCore *lc, LinphonePresenceActivityType acttype, const char *description, const char *note, const char *lang);
|
||||
|
||||
|
|
@ -912,7 +912,7 @@ LINPHONE_PUBLIC LinphonePresenceModel * linphone_core_create_presence_model_with
|
|||
* @param[in] lc #LinphoneCore object.
|
||||
* @param[in] content The content of the note to be created.
|
||||
* @param[in] lang The language of the note to be created.
|
||||
* @returns The created #LinphonePresenceNote object.
|
||||
* @return The created #LinphonePresenceNote object.
|
||||
*/
|
||||
LINPHONE_PUBLIC LinphonePresenceNote * linphone_core_create_presence_note(LinphoneCore *lc, const char *content, const char *lang);
|
||||
|
||||
|
|
@ -920,7 +920,7 @@ LINPHONE_PUBLIC LinphonePresenceNote * linphone_core_create_presence_note(Linpho
|
|||
* Create a LinphonePresencePerson with the given id.
|
||||
* @param[in] lc #LinphoneCore object
|
||||
* @param[in] id The id of the person to be created.
|
||||
* @returns The created #LinphonePresencePerson object.
|
||||
* @return The created #LinphonePresencePerson object.
|
||||
*/
|
||||
LINPHONE_PUBLIC LinphonePresencePerson * linphone_core_create_presence_person(LinphoneCore *lc, const char *id);
|
||||
|
||||
|
|
@ -930,7 +930,7 @@ LINPHONE_PUBLIC LinphonePresencePerson * linphone_core_create_presence_person(Li
|
|||
* @param[in] id The id of the service to be created.
|
||||
* @param[in] basic_status The basic status of the service to be created.
|
||||
* @param[in] contact A string containing a contact information corresponding to the service to be created.
|
||||
* @returns The created #LinphonePresenceService object.
|
||||
* @return The created #LinphonePresenceService object.
|
||||
*/
|
||||
LINPHONE_PUBLIC LinphonePresenceService * linphone_core_create_presence_service(LinphoneCore *lc, const char *id, LinphonePresenceBasicStatus basic_status, const char *contact);
|
||||
|
||||
|
|
|
|||
|
|
@ -1449,7 +1449,7 @@ static void linphone_core_migrate_proxy_config(LinphoneCore *lc, LinphoneTranspo
|
|||
* Existing proxy configuration are added a transport parameter so that they continue using the unique transport that was set previously.
|
||||
* This function must be used just after creating the core, before any call to linphone_core_iterate()
|
||||
* @param lc the linphone core
|
||||
* @returns 1 if migration was done, 0 if not done because unnecessary or already done, -1 in case of error.
|
||||
* @return 1 if migration was done, 0 if not done because unnecessary or already done, -1 in case of error.
|
||||
* @ingroup initializing
|
||||
**/
|
||||
int linphone_core_migrate_to_multi_transport(LinphoneCore *lc){
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
Subproject commit 182c23b1e5ec28539da1e7ebaed3a2a3a7649674
|
||||
Subproject commit 0450c04a38ce2c78430208d90e41dbe23163b950
|
||||
2
oRTP
2
oRTP
|
|
@ -1 +1 @@
|
|||
Subproject commit 54179e2e08bc6281e954ce3cd2a7c3a06cac8508
|
||||
Subproject commit d806b0e0ae878e70c4c1acb20b7f7116a6e6400b
|
||||
Loading…
Add table
Reference in a new issue