Commit 62a96e96 authored by François Grisez's avatar François Grisez
Browse files

Improvement of Javadoc and Doxygen docstrings generation

* Fix links to classes, enums and enumerators for every doc engines.
* Document “linphone” namespace in order top-level enums be indexed by Doxygen.
* Make @bctbx_list Doxygen macro to not generate code in HTML documentaiton.
* Fix several invalid reference in the C API documentation.
parent 21825131
......@@ -228,7 +228,7 @@ TAB_SIZE = 8
# "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines.
ALIASES = bctbx_list{1}="A list of \ref \1 objects. \xmlonly <bctbxlist>\1</bctbxlist> \endxmlonly"
ALIASES = bctbx_list{1}="\xmlonly<bctbxlist>\1</bctbxlist>\endxmlonly"
ALIASES += donotwrap="\xmlonly <donotwrap /> \endxmlonly"
ALIASES += maybenil="\xmlonly <maybenil /> \endxmlonly"
ALIASES += notnil="\xmlonly <notnil /> \endxmlonly"
......
......@@ -63,7 +63,7 @@ LINPHONE_PUBLIC void linphone_vcard_context_set_user_data(LinphoneVcardContext *
* Uses belcard to parse the content of a file and returns all the vcards it contains as LinphoneVcards, or NULL if it contains none.
* @param[in] context the vCard context to use (speed up the process by not creating a Belcard parser each time)
* @param[in] file the path to the file to parse
* @return \bctbx_list{LinphoneVcard}
* @return A list of VCards. \bctbx_list{LinphoneVcard}
*/
LINPHONE_PUBLIC bctbx_list_t* linphone_vcard_context_get_vcard_list_from_file(LinphoneVcardContext *context, const char *file);
......@@ -71,7 +71,7 @@ LINPHONE_PUBLIC bctbx_list_t* linphone_vcard_context_get_vcard_list_from_file(Li
* Uses belcard to parse the content of a buffer and returns all the vcards it contains as LinphoneVcards, or NULL if it contains none.
* @param[in] context the vCard context to use (speed up the process by not creating a Belcard parser each time)
* @param[in] buffer the buffer to parse
* @return \bctbx_list{LinphoneVcard}
* @return A list of VCards. \bctbx_list{LinphoneVcard}
*/
LINPHONE_PUBLIC bctbx_list_t* linphone_vcard_context_get_vcard_list_from_buffer(LinphoneVcardContext *context, const char *buffer);
......
......@@ -96,7 +96,7 @@ LINPHONE_PUBLIC void linphone_auth_info_set_algorithm(LinphoneAuthInfo *auth_inf
/**
* Sets the available algorithms list without testing unicity
* @param auth_info The #LinphoneAuthInfo object. @notnil
* @param algorithms \bctbx_list{const char *} The available algorithms list. @maybenil
* @param algorithms The available algorithms list. @bctbx_list{const char *} @maybenil
*/
LINPHONE_PUBLIC void linphone_auth_info_set_available_algorithms(LinphoneAuthInfo *auth_info, const bctbx_list_t *algorithms);
......@@ -196,7 +196,7 @@ LINPHONE_PUBLIC const char *linphone_auth_info_get_algorithm(const LinphoneAuthI
/**
* Gets all available algorithms.
* @param auth_info The #LinphoneAuthInfo object. @notnil
* @return \bctbx_list{const char *} A list of available algorithms. @maybenil
* @return A list of available algorithms. @bctbx_list{const char *} @maybenil
*/
LINPHONE_PUBLIC bctbx_list_t * linphone_auth_info_get_available_algorithms(const LinphoneAuthInfo *auth_info);
......
......@@ -339,7 +339,7 @@ LINPHONE_PUBLIC LinphoneStatus linphone_call_send_dtmfs (LinphoneCall *call, con
* Stop current DTMF sequence sending.
*
* Please note that some DTMF could be already sent,
* depending on when this function call is delayed from #linphone_call_send_dtmfs. This
* depending on when this function call is delayed from #linphone_call_send_dtmfs(). This
* function will be automatically called if call state change to anything but LinphoneCallStreamsRunning.
* @param call The #LinphoneCall object @notnil
**/
......
......@@ -95,7 +95,7 @@ LINPHONE_PUBLIC void linphone_chat_message_cbs_set_file_transfer_recv (LinphoneC
* Get the file transfer send callback.
* @param cbs LinphoneChatMessageCbs object. @notnil
* @return The current file transfer send callback.
* @deprecated 17/08/2020 Use #linphone_chat_message_cbs_get_file_transfer_send_chunk instead.
* @deprecated 17/08/2020 Use #linphone_chat_message_cbs_get_file_transfer_send_chunk() instead.
*/
LINPHONE_PUBLIC LinphoneChatMessageCbsFileTransferSendCb linphone_chat_message_cbs_get_file_transfer_send (const LinphoneChatMessageCbs *cbs);
......@@ -103,7 +103,7 @@ LINPHONE_PUBLIC LinphoneChatMessageCbsFileTransferSendCb linphone_chat_message_c
* Set the file transfer send callback.
* @param cbs LinphoneChatMessageCbs object. @notnil
* @param cb The file transfer send callback to be used.
* @deprecated 17/08/2020 Use #linphone_chat_message_cbs_set_file_transfer_send_chunk instead.
* @deprecated 17/08/2020 Use #linphone_chat_message_cbs_set_file_transfer_send_chunk() instead.
*/
LINPHONE_PUBLIC void linphone_chat_message_cbs_set_file_transfer_send (LinphoneChatMessageCbs *cbs, LinphoneChatMessageCbsFileTransferSendCb cb);
......
......@@ -399,7 +399,7 @@ LINPHONE_PUBLIC void linphone_chat_message_remove_content (LinphoneChatMessage *
/**
* Returns the list of contents in the message.
* @param message #LinphoneChatMessage object. @notnil
* @return \bctbx_list{LinphoneContent} the list of #LinphoneContent. @notnil
* @return The list of #LinphoneContent. @bctbx_list{LinphoneContent} @notnil
*/
LINPHONE_PUBLIC const bctbx_list_t *linphone_chat_message_get_contents(const LinphoneChatMessage *message);
......@@ -415,7 +415,7 @@ LINPHONE_PUBLIC bool_t linphone_chat_message_is_file_transfer_in_progress (const
* @param message #LinphoneChatMessage object. @notnil
* @param state The LinphoneChatMessageState the imdn have reached (only use LinphoneChatMessageStateDelivered,
* LinphoneChatMessageStateDeliveredToUser, LinphoneChatMessageStateDisplayed and LinphoneChatMessageStateNotDelivered)
* @return \bctbx_list{LinphoneParticipantImdnState} @tobefreed @notnil
* @return The list of participants. \bctbx_list{LinphoneParticipantImdnState} @tobefreed @notnil
*/
LINPHONE_PUBLIC bctbx_list_t *linphone_chat_message_get_participants_by_imdn_state (
const LinphoneChatMessage *message,
......
......@@ -93,16 +93,16 @@ LINPHONE_PUBLIC LinphoneChatMessage* linphone_chat_room_create_file_transfer_mes
LINPHONE_PUBLIC LinphoneChatMessage *linphone_chat_room_create_forward_message (LinphoneChatRoom *chat_room, LinphoneChatMessage *message);
/**
* Gets the peer address \link linphone_core_get_chat_room() associated to \endlink this #LinphoneChatRoom
* @param chat_room #LinphoneChatRoom object @notnil
* @return #LinphoneAddress peer address @notnil
* Get the peer address associated to this chat room.
* @param chat_room #LinphoneChatRoom object. @notnil
* @return The peer address. @notnil
*/
LINPHONE_PUBLIC const LinphoneAddress* linphone_chat_room_get_peer_address(LinphoneChatRoom *chat_room);
/**
* Gets the local address \link linphone_core_get_chat_room() associated to \endlink this #LinphoneChatRoom
* @param chat_room #LinphoneChatRoom object @notnil
* @return #LinphoneAddress local address @notnil
* Get the local address associated to this chat room.
* @param chat_room #LinphoneChatRoom object. @notnil
* @return The local address. @notnil
*/
LINPHONE_PUBLIC const LinphoneAddress* linphone_chat_room_get_local_address(LinphoneChatRoom *chat_room);
......@@ -194,7 +194,7 @@ LINPHONE_PUBLIC bool_t linphone_chat_room_is_empty (LinphoneChatRoom *chat_room)
* Gets nb_message most recent messages from chat_room chat room, sorted from oldest to most recent.
* @param chat_room The #LinphoneChatRoom object corresponding to the conversation for which messages should be retrieved @notnil
* @param nb_message Number of message to retrieve. 0 means everything.
* @return \bctbx_list{LinphoneChatMessage} @tobefreed
* @return A list of chat messages. \bctbx_list{LinphoneChatMessage} @tobefreed
*/
LINPHONE_PUBLIC bctbx_list_t *linphone_chat_room_get_history (LinphoneChatRoom *chat_room, int nb_message);
......@@ -202,8 +202,8 @@ LINPHONE_PUBLIC bctbx_list_t *linphone_chat_room_get_history (LinphoneChatRoom *
* Gets the partial list of messages in the given range, sorted from oldest to most recent.
* @param chat_room The #LinphoneChatRoom object corresponding to the conversation for which messages should be retrieved @notnil
* @param begin The first message of the range to be retrieved. History most recent message has index 0.
* @param end The last message of the range to be retrieved. History oldest message has index of history size - 1 (use #linphone_chat_room_get_history_size to retrieve history size)
* @return \bctbx_list{LinphoneChatMessage} @tobefreed
* @param end The last message of the range to be retrieved. History oldest message has index of history size - 1 (use #linphone_chat_room_get_history_size() to retrieve history size)
* @return A list of chat messages. \bctbx_list{LinphoneChatMessage} @tobefreed
*/
LINPHONE_PUBLIC bctbx_list_t *linphone_chat_room_get_history_range (LinphoneChatRoom *chat_room, int begin, int end);
......@@ -211,7 +211,7 @@ LINPHONE_PUBLIC bctbx_list_t *linphone_chat_room_get_history_range (LinphoneChat
* Gets nb_events most recent chat message events from chat_room chat room, sorted from oldest to most recent.
* @param chat_room The #LinphoneChatRoom object corresponding to the conversation for which events should be retrieved @notnil
* @param nb_events Number of events to retrieve. 0 means everything.
* @return \bctbx_list{LinphoneEventLog} @tobefreed
* @return A list \bctbx_list{LinphoneEventLog} @tobefreed
*/
LINPHONE_PUBLIC bctbx_list_t *linphone_chat_room_get_history_message_events (LinphoneChatRoom *chat_room, int nb_events);
......@@ -220,7 +220,7 @@ LINPHONE_PUBLIC bctbx_list_t *linphone_chat_room_get_history_message_events (Lin
* @param chat_room The #LinphoneChatRoom object corresponding to the conversation for which events should be retrieved @notnil
* @param begin The first event of the range to be retrieved. History most recent event has index 0.
* @param end The last event of the range to be retrieved. History oldest event has index of history size - 1
* @return \bctbx_list{LinphoneEventLog} @tobefreed
* @return The list of chat message events. \bctbx_list{LinphoneEventLog} @tobefreed
*/
LINPHONE_PUBLIC bctbx_list_t *linphone_chat_room_get_history_range_message_events (LinphoneChatRoom *chat_room, int begin, int end);
......@@ -228,7 +228,7 @@ LINPHONE_PUBLIC bctbx_list_t *linphone_chat_room_get_history_range_message_event
* Gets nb_events most recent events from chat_room chat room, sorted from oldest to most recent.
* @param chat_room The #LinphoneChatRoom object corresponding to the conversation for which events should be retrieved @notnil
* @param nb_events Number of events to retrieve. 0 means everything.
* @return \bctbx_list{LinphoneEventLog} @tobefreed
* @return The list of the most recent events. \bctbx_list{LinphoneEventLog} @tobefreed
*/
LINPHONE_PUBLIC bctbx_list_t *linphone_chat_room_get_history_events (LinphoneChatRoom *chat_room, int nb_events);
......@@ -237,7 +237,7 @@ LINPHONE_PUBLIC bctbx_list_t *linphone_chat_room_get_history_events (LinphoneCha
* @param chat_room The #LinphoneChatRoom object corresponding to the conversation for which events should be retrieved @notnil
* @param begin The first event of the range to be retrieved. History most recent event has index 0.
* @param end The last event of the range to be retrieved. History oldest event has index of history size - 1
* @return \bctbx_list{LinphoneEventLog} @tobefreed
* @return The list of the found events. \bctbx_list{LinphoneEventLog} @tobefreed
*/
LINPHONE_PUBLIC bctbx_list_t *linphone_chat_room_get_history_range_events (LinphoneChatRoom *chat_room, int begin, int end);
......@@ -368,7 +368,7 @@ LINPHONE_PUBLIC void linphone_chat_room_add_participant (LinphoneChatRoom *chat_
* Add several participants to a chat room at once. This may fail if this type of chat room does not handle participants.
* Use linphone_chat_room_can_handle_participants() to know if this chat room handles participants.
* @param chat_room A #LinphoneChatRoom object @notnil
* @param addresses \bctbx_list{LinphoneAddress} @notnil
* @param addresses The participants to add. \bctbx_list{LinphoneAddress} @notnil
* @return TRUE if everything is OK, FALSE otherwise
*/
LINPHONE_PUBLIC bool_t linphone_chat_room_add_participants (LinphoneChatRoom *chat_room, const bctbx_list_t *addresses);
......@@ -461,7 +461,7 @@ LINPHONE_PUBLIC void linphone_chat_room_remove_participant (LinphoneChatRoom *ch
/**
* Remove several participants of a chat room at once.
* @param chat_room A #LinphoneChatRoom object @notnil
* @param participants \bctbx_list{LinphoneParticipant} @notnil
* @param participants The participants to remove. \bctbx_list{LinphoneParticipant} @notnil
*/
LINPHONE_PUBLIC void linphone_chat_room_remove_participants (LinphoneChatRoom *chat_room, const bctbx_list_t *participants);
......@@ -483,7 +483,7 @@ LINPHONE_PUBLIC void linphone_chat_room_set_subject (LinphoneChatRoom *chat_room
/**
* Gets the list of participants that are currently composing
* @param chat_room A #LinphoneChatRoom object @notnil
* @return \bctbx_list{LinphoneAddress} list of addresses that are in the is_composing state
* @return List of addresses that are in the is_composing state. \bctbx_list{LinphoneAddress}
*/
LINPHONE_PUBLIC const bctbx_list_t * linphone_chat_room_get_composing_addresses(LinphoneChatRoom *chat_room);
......@@ -501,7 +501,7 @@ LINPHONE_PUBLIC void linphone_chat_room_set_conference_address (LinphoneChatRoom
* This function is meaningful only for server implementation of chatroom, and shall not by used by client applications.
* @param chat_room A #LinphoneChatRoom object @notnil
* @param participant_address The participant address @notnil
* @param device_identities \bctbx_list{LinphoneParticipantDeviceIdentity} list of the participant devices to be used by the group chat room @notnil
* @param device_identities List of the participant devices to be used by the group chat room \bctbx_list{LinphoneParticipantDeviceIdentity} @notnil
*/
LINPHONE_PUBLIC void linphone_chat_room_set_participant_devices(LinphoneChatRoom *chat_room, const LinphoneAddress *participant_address, const bctbx_list_t *device_identities);
......
......@@ -97,7 +97,7 @@ LINPHONE_PUBLIC int linphone_dial_plan_lookup_ccc_from_e164(const char* e164);
/**
* Returns a list of all known dial plans
* @return \bctbx_list{LinphoneDialPlan} of all known dial plans @notnil
* @return The list of all known dial plans. \bctbx_list{LinphoneDialPlan} @notnil
**/
LINPHONE_PUBLIC bctbx_list_t * linphone_dial_plan_get_all_list(void);
......
......@@ -287,7 +287,7 @@ LINPHONE_PUBLIC LinphoneVideoDefinition * linphone_factory_create_video_definiti
/**
* Get the list of standard video definitions supported by Linphone.
* @param factory #LinphoneFactory singleton object @notnil
* @return \bctbx_list{LinphoneVideoDefinition} @maybenil
* @return A list of video definitions. \bctbx_list{LinphoneVideoDefinition} @maybenil
*/
LINPHONE_PUBLIC const bctbx_list_t * linphone_factory_get_supported_video_definitions(const LinphoneFactory *factory);
......@@ -407,7 +407,7 @@ LINPHONE_PUBLIC LinphoneVideoActivationPolicy *linphone_factory_create_video_act
/**
* Returns a bctbx_list_t of all DialPlans
* @param factory the #LinphoneFactory object @notnil
* @return \bctbx_list{LinphoneDialPlan} a list of #LinphoneDialPlan @notnil
* @return A list of #LinphoneDialPlan \bctbx_list{LinphoneDialPlan} @notnil
*/
LINPHONE_PUBLIC const bctbx_list_t * linphone_factory_get_dial_plans(const LinphoneFactory *factory);
......
......@@ -92,7 +92,7 @@ LINPHONE_PUBLIC LinphoneChatRoomSecurityLevel linphone_participant_get_security_
/**
* Gets the list of devices from a chat room's participant.
* @param participant A #LinphoneParticipant object @notnil
* @return \bctbx_list{LinphoneParticipantDevice} @notnil
* @return List of devices. \bctbx_list{LinphoneParticipantDevice} @notnil
*/
LINPHONE_PUBLIC bctbx_list_t *linphone_participant_get_devices (const LinphoneParticipant *participant);
......
......@@ -359,10 +359,10 @@ LINPHONE_PUBLIC void linphone_call_params_unref(LinphoneCallParams *call_params)
/**
* Use to enable multicast rtp for audio stream.
* * If enabled, outgoing calls put a multicast address from #linphone_core_get_video_multicast_addr into audio cline. In case of outgoing call audio stream is sent to this multicast address.
* * If enabled, outgoing calls put a multicast address from #linphone_core_get_video_multicast_addr() into audio cline. In case of outgoing call audio stream is sent to this multicast address.
* <br> For incoming calls behavior is unchanged.
* @param params #LinphoneCallParams @notnil
* @param yesno if yes, subsequent calls will propose multicast ip set by #linphone_core_set_audio_multicast_addr
* @param yesno if yes, subsequent calls will propose multicast ip set by #linphone_core_set_audio_multicast_addr()
* @ingroup media_parameters
**/
LINPHONE_PUBLIC void linphone_call_params_enable_audio_multicast(LinphoneCallParams *params, bool_t yesno);
......@@ -370,17 +370,17 @@ LINPHONE_PUBLIC void linphone_call_params_enable_audio_multicast(LinphoneCallPar
/**
* Use to get multicast state of audio stream.
* @param params #LinphoneCallParams @notnil
* @return true if subsequent calls will propose multicast ip set by #linphone_core_set_audio_multicast_addr
* @return true if subsequent calls will propose multicast ip set by #linphone_core_set_audio_multicast_addr()
* @ingroup media_parameters
**/
LINPHONE_PUBLIC bool_t linphone_call_params_audio_multicast_enabled(const LinphoneCallParams *params);
/**
* Use to enable multicast rtp for video stream.
* If enabled, outgoing calls put a multicast address from #linphone_core_get_video_multicast_addr into video cline. In case of outgoing call video stream is sent to this multicast address.
* If enabled, outgoing calls put a multicast address from #linphone_core_get_video_multicast_addr() into video cline. In case of outgoing call video stream is sent to this multicast address.
* <br> For incoming calls behavior is unchanged.
* @param params #LinphoneCallParams @notnil
* @param yesno if yes, subsequent outgoing calls will propose multicast ip set by #linphone_core_set_video_multicast_addr
* @param yesno if yes, subsequent outgoing calls will propose multicast ip set by #linphone_core_set_video_multicast_addr()
* @ingroup media_parameters
**/
LINPHONE_PUBLIC void linphone_call_params_enable_video_multicast(LinphoneCallParams *params, bool_t yesno);
......@@ -388,7 +388,7 @@ LINPHONE_PUBLIC void linphone_call_params_enable_video_multicast(LinphoneCallPar
/**
* Use to get multicast state of video stream.
* @param params #LinphoneCallParams @notnil
* @return true if subsequent calls will propose multicast ip set by #linphone_core_set_video_multicast_addr
* @return true if subsequent calls will propose multicast ip set by #linphone_core_set_video_multicast_addr()
* @ingroup media_parameters
**/
LINPHONE_PUBLIC bool_t linphone_call_params_video_multicast_enabled(const LinphoneCallParams *params);
......@@ -483,7 +483,7 @@ LINPHONE_PUBLIC void linphone_call_params_clear_custom_sdp_media_attributes(Linp
/**
* Gets a list of #LinphoneContent set if exists
* @param params The #LinphoneCallParams to get the custom Content from. @notnil
* @return \bctbx_list{LinphoneContent} A list of #LinphoneContent set if exists, NULL otherwise. @maybenil
* @return A list of #LinphoneContent set if exists, NULL otherwise. \bctbx_list{LinphoneContent} @maybenil
* @ingroup media_parameters
**/
LINPHONE_PUBLIC bctbx_list_t* linphone_call_params_get_custom_contents (const LinphoneCallParams *params);
......
......@@ -103,7 +103,7 @@ typedef void (*LinphoneCoreCbsRegistrationStateChangedCb)(LinphoneCore *core, Li
typedef LinphoneCoreCbsRegistrationStateChangedCb LinphoneCoreRegistrationStateChangedCb;
/**
* Report status change for a friend previously \link linphone_core_add_friend() added \endlink to #LinphoneCore.
* Report status change for a friend previously added to the #LinphoneCore with linphone_core_add_friend().
* @param core #LinphoneCore object @notnil
* @param linphone_friend Updated #LinphoneFriend @notnil
*/
......@@ -130,10 +130,11 @@ typedef LinphoneCoreCbsNotifyPresenceReceivedForUriOrTelCb LinphoneCoreNotifyPre
/**
* Reports that a new subscription request has been received and wait for a decision.
* Status on this subscription request is notified by \link linphone_friend_set_inc_subscribe_policy() changing policy \endlink for this friend
* @note A subscription request is notified by this function only if the #LinphoneSubscribePolicy for the
* given #LinphoneFriend has been set to #LinphoneSPWait. See linphone_friend_set_inc_subscribe_policy().
* @param core #LinphoneCore object @notnil
* @param linphone_friend #LinphoneFriend corresponding to the subscriber @notnil
* @param url of the subscriber @notnil
* @param linphone_friend The #LinphoneFriend aimed by the subscription. @notnil
* @param url URI of the subscriber @notnil
*/
typedef void (*LinphoneCoreCbsNewSubscriptionRequestedCb)(LinphoneCore *core, LinphoneFriend *linphone_friend, const char *url);
......@@ -170,9 +171,9 @@ typedef void (*LinphoneCoreCbsCallLogUpdatedCb)(LinphoneCore *core, LinphoneCall
typedef LinphoneCoreCbsCallLogUpdatedCb LinphoneCoreCallLogUpdatedCb;
/**
* Chat message callback prototype
* Chat message callback prototype.
* @param core #LinphoneCore object @notnil
* @param chat_room #LinphoneChatRoom involved in this conversation. Can be be created by the framework in case \link #LinphoneAddress the from \endlink is not present in any chat room. @notnil
* @param chat_room #LinphoneChatRoom involved in this conversation. Can be created by the framework in case the From-URI is not present in any chat room. @notnil
* @param message #LinphoneChatMessage incoming message @notnil
*/
typedef void (*LinphoneCoreCbsMessageReceivedCb)(LinphoneCore *core, LinphoneChatRoom *chat_room, LinphoneChatMessage *message);
......@@ -182,7 +183,7 @@ typedef void (*LinphoneCoreCbsMessageReceivedCb)(LinphoneCore *core, LinphoneCha
* The message will be in state InProgress.
* In case of resend this callback won't be called.
* @param core #LinphoneCore object @notnil
* @param chat_room #LinphoneChatRoom involved in this conversation. Can be be created by the framework in case \link #LinphoneAddress the from \endlink is not present in any chat room. @notnil
* @param chat_room #LinphoneChatRoom involved in this conversation. Can be be created by the framework in case the From-URI is not present in any chat room. @notnil
* @param message #LinphoneChatMessage outgoing message @notnil
*/
typedef void (*LinphoneCoreCbsMessageSentCb)(LinphoneCore *core, LinphoneChatRoom *chat_room, LinphoneChatMessage *message);
......@@ -202,7 +203,7 @@ typedef void (*LinphoneCoreCbsChatRoomReadCb)(LinphoneCore *core, LinphoneChatRo
/**
* Chat message not decrypted callback prototype
* @param core #LinphoneCore object @notnil
* @param chat_room #LinphoneChatRoom involved in this conversation. Can be be created by the framework in case \link #LinphoneAddress the from \endlink is not present in any chat room. @notnil
* @param chat_room #LinphoneChatRoom involved in this conversation. Can be be created by the framework in case the from-URI is not present in any chat room. @notnil
* @param message #LinphoneChatMessage incoming message @notnil
*/
typedef void (*LinphoneCoreCbsMessageReceivedUnableDecryptCb)(LinphoneCore *core, LinphoneChatRoom *chat_room, LinphoneChatMessage *message);
......@@ -340,7 +341,7 @@ typedef void (*LinphoneCoreCbsConfiguringStatusCb)(LinphoneCore *core, LinphoneC
typedef LinphoneCoreCbsConfiguringStatusCb LinphoneCoreConfiguringStatusCb;
/**
* Callback prototype for reporting network change either automatically detected or notified by #linphone_core_set_network_reachable.
* Callback prototype for reporting network change either automatically detected or notified by #linphone_core_set_network_reachable().
* @param core the #LinphoneCore @notnil
* @param reachable true if network is reachable.
*/
......@@ -730,7 +731,7 @@ typedef void (*LinphonePlayerCbsEofReachedCb)(LinphonePlayer *player);
/**
* Callback prototype
* @param core #LinphoneCore object @notnil
* @param chat_room #LinphoneChatRoom involved in this conversation. Can be be created by the framework in case \link #LinphoneAddress the from \endlink is not present in any chat room. @notnil
* @param chat_room #LinphoneChatRoom involved in this conversation. Can be be created by the framework in case the From-URI is not present in any chat room. @notnil
* @param from #LinphoneAddress from @notnil
* @param message incoming message @notnil
* @deprecated 30/03/2017 use #LinphoneCoreMessageReceivedCb instead.
......
......@@ -41,9 +41,9 @@ extern "C" {
*/
/**
* Returns an list of chat rooms
* Returns a list of chat rooms
* @param core #LinphoneCore object @notnil
* @return \bctbx_list{LinphoneChatRoom} @maybenil
* @return List of chat rooms. \bctbx_list{LinphoneChatRoom} @maybenil
**/
LINPHONE_PUBLIC const bctbx_list_t* linphone_core_get_chat_rooms(LinphoneCore *core);
......
......@@ -137,7 +137,7 @@ LINPHONE_PUBLIC void linphone_conference_unref(LinphoneConference *conf);
* The returned bctbx_list_t contains URIs of all participant. That list must be
* freed after use and each URI must be unref with linphone_address_unref()
* @param conf A #LinphoneConference @notnil
* @return \bctbx_list{LinphoneAddress} @maybenil
* @return The list of the participants' address. \bctbx_list{LinphoneAddress} @maybenil
* @deprecated 10/07/2020 Use linphone_conference_get_participant_list() instead.
*/
LINPHONE_PUBLIC bctbx_list_t *linphone_conference_get_participants(const LinphoneConference *conf);
......@@ -145,7 +145,7 @@ LINPHONE_PUBLIC bctbx_list_t *linphone_conference_get_participants(const Linphon
/**
* Get list of all participants of one conference
* @param conf A #LinphoneConference @notnil
* @return \bctbx_list{LinphoneParticipant} @maybenil
* @return A list of participants. \bctbx_list{LinphoneParticipant} @maybenil
*/
LINPHONE_PUBLIC bctbx_list_t *linphone_conference_get_participant_list(const LinphoneConference *conf);
......@@ -186,7 +186,7 @@ LINPHONE_PUBLIC LinphoneParticipant * linphone_conference_find_participant(Linph
/**
* Invite participants to the conference, by supplying a list of #LinphoneAddress
* @param conf The #LinphoneConference object. @notnil
* @param addresses \bctbx_list{LinphoneAddress} @notnil
* @param addresses A list of SIP addresses to invite. @bctbx_list{LinphoneAddress} @notnil
* @param params #LinphoneCallParams to use for inviting the participants. @maybenil
**/
LINPHONE_PUBLIC LinphoneStatus linphone_conference_invite_participants(LinphoneConference *conf, const bctbx_list_t *addresses, const LinphoneCallParams *params);
......
This diff is collapsed.
......@@ -119,7 +119,7 @@ LINPHONE_PUBLIC bool_t linphone_core_is_echo_canceller_calibration_required(Linp
/**
* @ingroup IOS
* @param core The #LinphoneCore object. @notnil
* Special function to warm up dtmf feeback stream. #linphone_core_stop_dtmf_stream must() be called before entering FG mode
* Special function to warm up dtmf feeback stream. #linphone_core_stop_dtmf_stream() must be called before entering FG mode
*/
LINPHONE_PUBLIC void linphone_core_start_dtmf_stream(LinphoneCore* core);
......
......@@ -58,7 +58,7 @@ LINPHONE_PUBLIC void linphone_friend_add_address(LinphoneFriend *linphone_friend
/**
* Returns a list of #LinphoneAddress for this friend
* @param linphone_friend #LinphoneFriend object @notnil
* @return \bctbx_list{LinphoneAddress} @maybenil
* @return A list of #LinphoneAddress. \bctbx_list{LinphoneAddress} @maybenil
*/
LINPHONE_PUBLIC const bctbx_list_t* linphone_friend_get_addresses(const LinphoneFriend *linphone_friend);
......@@ -79,7 +79,7 @@ LINPHONE_PUBLIC void linphone_friend_add_phone_number(LinphoneFriend *linphone_f
/**
* Returns a list of phone numbers for this friend
* @param linphone_friend #LinphoneFriend object @notnil
* @return \bctbx_list{const char *} @maybenil
* @return A list of phone numbers as string. \bctbx_list{const char *} @maybenil
*/
LINPHONE_PUBLIC bctbx_list_t* linphone_friend_get_phone_numbers(const LinphoneFriend *linphone_friend);
......@@ -150,7 +150,7 @@ LINPHONE_PUBLIC LinphoneSubscribePolicy linphone_friend_get_inc_subscribe_policy
*
* Because friend configuration must be consistent, applications MUST
* call linphone_friend_edit() before doing any attempts to modify
* friend configuration (such as \link linphone_friend_set_address() address \endlink or \link linphone_friend_set_inc_subscribe_policy() subscription policy\endlink and so on).
* friend configuration (such as linphone_friend_set_address() or linphone_friend_set_inc_subscribe_policy()).
* Once the modifications are done, then the application must call
* linphone_friend_done() to commit the changes.
* @param linphone_friend #LinphoneFriend object @notnil
......@@ -296,7 +296,8 @@ LINPHONE_PUBLIC bool_t linphone_friend_create_vcard(LinphoneFriend *linphone_fri
/**
* Contructor same as linphone_friend_new() + linphone_friend_set_address()
* @param vcard a #LinphoneVcard object @notnil
* @return a new #LinphoneFriend with \link linphone_friend_get_vcard() vCard initialized \endlink @maybenil
* @return a new #LinphoneFriend which has its vCard attribute initialized from the given vCard.
* This can be get by linphone_friend_get_vcard(). @maybenil
*/
LINPHONE_PUBLIC LinphoneFriend *linphone_friend_new_from_vcard(LinphoneVcard *vcard);
......@@ -361,7 +362,7 @@ LINPHONE_PUBLIC void linphone_friend_remove(LinphoneFriend *linphone_friend);
/**
* Contructor
* @return a new empty #LinphoneFriend
* @deprecated 03/02/2016 use #linphone_core_create_friend instead
* @deprecated 03/02/2016 use #linphone_core_create_friend() instead
* @donotwrap
*/
LINPHONE_PUBLIC LINPHONE_DEPRECATED LinphoneFriend * linphone_friend_new(void);
......@@ -369,8 +370,8 @@ LINPHONE_PUBLIC LINPHONE_DEPRECATED LinphoneFriend * linphone_friend_new(void);
/**
* Contructor same as linphone_friend_new() + linphone_friend_set_address()
* @param addr a buddy address, must be a sip uri like sip:joe@sip.linphone.org
* @return a new #LinphoneFriend with \link linphone_friend_get_address() address initialized \endlink
* @deprecated 03/02/2016 use #linphone_core_create_friend_with_address instead
* @return a new #LinphoneFriend with an initialized address.
* @deprecated 03/02/2016 use #linphone_core_create_friend_with_address() instead
* @donotwrap
*/
LINPHONE_PUBLIC LINPHONE_DEPRECATED LinphoneFriend *linphone_friend_new_with_address(const char *addr);
......
......@@ -133,7 +133,7 @@ LINPHONE_PUBLIC LinphoneFriendListStatus linphone_friend_list_remove_friend(Linp
/**
* Retrieves the list of #LinphoneFriend from this LinphoneFriendList.
* @param friend_list #LinphoneFriendList object @notnil
* @return \bctbx_list{LinphoneFriend} a list of #LinphoneFriend @maybenil
* @return A list of #LinphoneFriend \bctbx_list{LinphoneFriend} @maybenil
*/
LINPHONE_PUBLIC const bctbx_list_t * linphone_friend_list_get_friends(const LinphoneFriendList *friend_list);
......@@ -157,7 +157,7 @@ LINPHONE_PUBLIC LinphoneFriend * linphone_friend_list_find_friend_by_phone_numbe
* Find all friends in the friend list using a LinphoneAddress.
* @param friend_list #LinphoneFriendList object. @notnil
* @param address #LinphoneAddress object of the friends we want to search for. @notnil
* @return \bctbx_list{LinphoneFriend} as a list of #LinphoneFriend if found, NULL otherwise. @maybenil
* @return A list of #LinphoneFriend if found, NULL otherwise. \bctbx_list{LinphoneFriend} @maybenil
**/
LINPHONE_PUBLIC bctbx_list_t * linphone_friend_list_find_friends_by_address(const LinphoneFriendList *friend_list, const LinphoneAddress *address);
......@@ -173,7 +173,7 @@ LINPHONE_PUBLIC LinphoneFriend * linphone_friend_list_find_friend_by_uri(const L
* Find all friends in the friend list using an URI string.
* @param friend_list #LinphoneFriendList object. @notnil
* @param uri A string containing the URI of the friends we want to search for. @notnil
* @return \bctbx_list{LinphoneFriend} as a list of #LinphoneFriend if found, NULL otherwise. @maybenil
* @return A list of #LinphoneFriend if found, NULL otherwise. \bctbx_list{LinphoneFriend} @maybenil
**/
LINPHONE_PUBLIC bctbx_list_t * linphone_friend_list_find_friends_by_uri(const LinphoneFriendList *friend_list, const char *uri);
......
......@@ -57,7 +57,7 @@ extern "C" {
* The caller of this constructor owns a reference. linphone_config_unref() must be called when this object is no longer needed.
* @ingroup misc
* @param filename the filename of the config file to read to fill the instantiated #LinphoneConfig @maybenil
* @see linphone_config_new_with_factory
* @see linphone_config_new_with_factory()
* @return a #LinphoneConfig object @maybenil
*/
LINPHONE_PUBLIC LinphoneConfig * linphone_config_new(const char *filename);
......@@ -67,8 +67,8 @@ LINPHONE_PUBLIC LinphoneConfig * linphone_config_new(const char *filename);
* The caller of this constructor owns a reference. linphone_config_unref() must be called when this object is no longer needed.
* @ingroup misc
* @param buffer the buffer from which the #LinphoneConfig will be retrieved. We expect the buffer to be null-terminated. @notnil
* @see linphone_config_new_with_factory
* @see linphone_config_new
* @see linphone_config_new_with_factory()
* @see linphone_config_new()
* @return a #LinphoneConfig object @notnil
*/
LINPHONE_PUBLIC LinphoneConfig * linphone_config_new_from_buffer(const char *buffer);
......@@ -79,7 +79,7 @@ LINPHONE_PUBLIC LinphoneConfig * linphone_config_new_from_buffer(const char *buf
* @ingroup misc
* @param config_filename the filename of the user config file to read to fill the instantiated #LinphoneConfig @maybenil
* @param factory_config_filename the filename of the factory config file to read to fill the instantiated #LinphoneConfig @maybenil
* @see linphone_config_new
* @see linphone_config_new()
* @return a #LinphoneConfig object @maybenil
*
* The user config file is read first to fill the #LinphoneConfig and then the factory config file is read.
......@@ -99,7 +99,7 @@ LINPHONE_PUBLIC LinphoneConfig * linphone_config_new_with_factory(const char *co
* @param app_group_id used to compute the path of the config file in the file system shared by the shared Cores @notnil
* @param config_filename the filename of the user config file to read to fill the instantiated #LinphoneConfig @maybenil
* @param factory_config_filename the filename of the factory config file to read to fill the instantiated #LinphoneConfig @maybenil
* @see linphone_config_new
* @see linphone_config_new()
* @return a #LinphoneConfig object @maybenil
*
* The user config file is read first to fill the #LinphoneConfig and then the factory config file is read.
......@@ -151,8 +151,8 @@ LINPHONE_PUBLIC const char *linphone_config_get_string(const LinphoneConfig *con
* @param config A #LinphoneConfig object @notnil
* @param section The section from which to retrieve a configuration item @notnil
* @param key The name of the configuration item to retrieve @notnil
* @param default_list \bctbx_list{const char *} @maybenil
* @return \bctbx_list{const char *} @maybenil
* @param default_list The list to return when the key doesn't exist. \bctbx_list{const char *} @maybenil
* @return A list of strings. \bctbx_list{const char *} @maybenil
*/
LINPHONE_PUBLIC bctbx_list_t * linphone_config_get_string_list(const LinphoneConfig *config, const char *section, const char *key, bctbx_list_t *default_list);
......@@ -233,7 +233,7 @@ LINPHONE_PUBLIC void linphone_config_set_string(LinphoneConfig *config,const cha
* @param config A #LinphoneConfig object @notnil
* @param section The name of the section to put the configuration item into @notnil
* @param key The name of the configuration item to set @notnil
* @param value \bctbx_list{const char *} The value to set. @maybenil
* @param value The value to set. \bctbx_list{const char *} @maybenil
*/
LINPHONE_PUBLIC void linphone_config_set_string_list(LinphoneConfig *config, const char *section, const char *key, const bctbx_list_t *value);
......@@ -340,7 +340,7 @@ LINPHONE_PUBLIC void linphone_config_clean_entry(LinphoneConfig *config, const c
/**
* Returns the list of sections' names in the LinphoneConfig.
* @param config The #LinphoneConfig object @notnil
* @return \bctbx_list{char *} a null terminated static array of strings @maybenil
* @return A list of strings. \bctbx_list{char *} @maybenil
**/
LINPHONE_PUBLIC const bctbx_list_t * linphone_config_get_sections_names_list(LinphoneConfig *config);
......@@ -348,7 +348,7 @@ LINPHONE_PUBLIC const bctbx_list_t * linphone_config_get_sections_names_list(Lin
* Returns the list of keys' names for a section in the LinphoneConfig.
* @param config The #LinphoneConfig object @notnil
* @param section The section name @notnil
* @return \bctbx_list{char *} a null terminated static array of strings @maybenil
* @return A list of strings. \bctbx_list{char *} @maybenil
**/
LINPHONE_PUBLIC const bctbx_list_t * linphone_config_get_keys_names_list(LinphoneConfig *config, const char *section );
......
......@@ -43,8 +43,7 @@ extern "C" {
* @param activity The #LinphonePresenceActivityType to set for the created presence model.
* @param description An additional description of the activity (mainly useful for the 'other' activity). Set it to NULL to not add a description. @maybenil
* @return The created #LinphonePresenceModel, or NULL if an error occured. @maybenil
* @see linphone_presence_model_new
* @see linphone_presence_model_new_with_activity_and_note
* @see linphone_presence_model_new(), linphone_presence_model_new_with_activity_and_note()
*
* The created presence model has the activity specified in the parameters.
*/
......@@ -57,8 +56,7 @@ LINPHONE_PUBLIC LinphonePresenceModel * linphone_presence_model_new_with_activit
* @param note An additional note giving additional information about the contact presence. @notnil
* @param lang The language the note is written in. It can be set to NULL in order to not specify the language of the note. @maybenil
* @return The created #LinphonePresenceModel, or NULL if an error occured. @maybenil
* @see linphone_presence_model_new_with_activity
* @see linphone_presence_model_new_with_activity_and_note
* @see linphone_presence_model_new_with_activity(), linphone_presence_model_new_with_activity_and_note()
*
* The created presence model has the activity and the note specified in the parameters.
*/
......@@ -209,8 +207,7 @@ LINPHONE_PUBLIC LinphoneConsolidatedPresence linphone_presence_model_get_consoli
/**
* Creates a default presence model.
* @return The created presence model, NULL on error. @maybenil
* @see linphone_presence_model_new_with_activity
* @see linphone_presence_model_new_with_activity_and_note
* @see linphone_presence_model_new_with_activity(), linphone_presence_model_new_with_activity_and_note()
*
* The created presence model is considered 'offline'.
*/
......@@ -372,7 +369,7 @@ LINPHONE_PUBLIC bctbx_list_t * linphone_presence_service_get_service_description
/**
* Sets the service descriptions of a presence service.
* @param service The #LinphonePresenceService object for which to set the contact. @notnil
* @param descriptions \bctbx_list{char *} The service descriptions. @maybenil
* @param descriptions The service descriptions. @bctbx_list{char *} @maybenil
* @return 0 if successful, a value < 0 in case of error.
*/
LINPHONE_PUBLIC LinphoneStatus linphone_presence_service_set_service_descriptions(LinphonePresenceService *service, bctbx_list_t *descriptions);
......
......@@ -157,7 +157,7 @@ LINPHONE_PUBLIC int linphone_proxy_config_get_publish_expires(const LinphoneProx
/**
* Sets whether liblinphone should replace "+" by international calling prefix in dialed numbers (passed to
* #linphone_core_invite ).
* #linphone_core_invite() ).
* @param proxy_config #LinphoneProxyConfig object. @notnil
* @param enable TRUE to replace + by the international prefix, FALSE otherwise.
**/
......@@ -253,7 +253,7 @@ LINPHONE_PUBLIC void linphone_proxy_config_set_realm(LinphoneProxyConfig *proxy_
/**