From 750146f8b052de365ef076262b1388730590c953 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Grisez?= Date: Fri, 27 Oct 2017 15:40:24 +0200 Subject: [PATCH] Fix some Doxygen documentations --- include/linphone/auth_info.h | 1 + include/linphone/core.h | 37 ++++++++++++++++++------------------ include/linphone/types.h | 12 ++++++++---- 3 files changed, 28 insertions(+), 22 deletions(-) diff --git a/include/linphone/auth_info.h b/include/linphone/auth_info.h index 4a00e324d..cb338f73a 100644 --- a/include/linphone/auth_info.h +++ b/include/linphone/auth_info.h @@ -56,6 +56,7 @@ LINPHONE_PUBLIC LinphoneAuthInfo *linphone_auth_info_new(const char *username, c /** * Instantiates a new auth info with values from source. + * * @param[in] source The #LinphoneAuthInfo object to be cloned * @return The newly created #LinphoneAuthInfo object. */ diff --git a/include/linphone/core.h b/include/linphone/core.h index f231eda9e..c6b0ead0f 100644 --- a/include/linphone/core.h +++ b/include/linphone/core.h @@ -1027,9 +1027,11 @@ LINPHONE_PUBLIC void linphone_core_set_user_agent(LinphoneCore *lc, const char * LINPHONE_PUBLIC LinphoneAddress * linphone_core_interpret_url(LinphoneCore *lc, const char *url); /** - * Initiates an outgoing call + * @brief Initiates an outgoing call. + * * The application doesn't own a reference to the returned LinphoneCall object. * Use linphone_call_ref() to safely keep the LinphoneCall pointer valid within your application. + * * @param[in] lc LinphoneCore object * @param[in] url The destination of the call (sip address, or phone number). * @return A LinphoneCall object or NULL in case of failure @@ -1159,11 +1161,11 @@ LINPHONE_PUBLIC LinphoneCall *linphone_core_get_current_call(const LinphoneCore * * Basically the application is notified of incoming calls within the * call_state_changed callback of the #LinphoneCoreVTable structure, where it will receive - * a LinphoneCallIncoming event with the associated LinphoneCall object. + * a #LinphoneCallIncoming event with the associated #LinphoneCall object. * The application can later accept the call using this method. - * @param[in] lc LinphoneCore object - * @param[in] call The LinphoneCall object representing the call to be answered - * @return 0 on success, -1 on failure + * @param[in] lc #LinphoneCore object. + * @param[in] call The #LinphoneCall object representing the call to be answered. + * @return 0 on success, -1 on failure. * @ingroup call_control * @deprecated Use #linphone_call_accept() instead. Deprecated since 2017-02-13. **/ @@ -1174,12 +1176,11 @@ LINPHONE_PUBLIC LINPHONE_DEPRECATED LinphoneStatus linphone_core_accept_call(Lin * * Basically the application is notified of incoming calls within the * call_state_changed callback of the #LinphoneCoreVTable structure, where it will receive - * a LinphoneCallIncoming event with the associated LinphoneCall object. - * The application can later accept the call using - * this method. - * @param[in] lc LinphoneCore object - * @param[in] call The LinphoneCall object representing the call to be answered - * @param[in] params The specific parameters for this call, for example whether video is accepted or not. Use NULL to use default parameters + * a #LinphoneCallIncoming event with the associated #LinphoneCall object. + * The application can later accept the call using this method. + * @param[in] lc #LinphoneCore object. + * @param[in] call The #LinphoneCall object representing the call to be answered. + * @param[in] params The specific parameters for this call, for example whether video is accepted or not. Use NULL to use default parameters. * @return 0 on success, -1 on failure * @ingroup call_control * @deprecated Use #linphone_call_accept_with_params() instead. Deprecated since 2017-02-13. @@ -1337,19 +1338,19 @@ LINPHONE_PUBLIC LINPHONE_DEPRECATED LinphoneStatus linphone_core_defer_call_upda * @brief Accept call modifications initiated by other end. * * This call may be performed in response to a #LinphoneCallUpdatedByRemote state notification. - * When such notification arrives, the application can decide to call linphone_core_defer_update_call() so that it can - * have the time to prompt the user. linphone_call_get_remote_params() can be used to get information about the call parameters + * When such notification arrives, the application can decide to call #linphone_core_defer_call_update() so that it can + * have the time to prompt the user. #linphone_call_get_remote_params() can be used to get information about the call parameters * requested by the other party, such as whether a video stream is requested. * - * When the user accepts or refuse the change, linphone_core_accept_call_update() can be done to answer to the other party. + * When the user accepts or refuse the change, #linphone_core_accept_call_update() can be done to answer to the other party. * If params is NULL, then the same call parameters established before the update request will continue to be used (no change). * If params is not NULL, then the update will be accepted according to the parameters passed. * Typical example is when a user accepts to start video, then params should indicate that video stream should be used - * (see linphone_call_params_enable_video()). - * @param[in] lc LinphoneCore object + * (see #linphone_call_params_enable_video()). + * @param[in] lc #LinphoneCore object * @param[in] call The call for which to accept an update - * @param[in] params A LinphoneCallParams object describing the call parameters to accept - * @return 0 if successful, -1 otherwise (actually when this function call is performed outside ot #LinphoneCallUpdatedByRemote state) + * @param[in] params A #LinphoneCallParams object describing the call parameters to accept + * @return 0 if successful, -1 otherwise (actually when this function call is performed outside of #LinphoneCallUpdatedByRemote state) * @ingroup call_control * @deprecated Use #linphone_call_accept_update() instead. Deprecated since 2017-02-13. **/ diff --git a/include/linphone/types.h b/include/linphone/types.h index 67a72eafa..058ab6231 100644 --- a/include/linphone/types.h +++ b/include/linphone/types.h @@ -207,9 +207,6 @@ typedef enum _LinphoneAudioRoute { /** * Object holding authentication information. * - * @note The object's fields should not be accessed directly. Prefer using - * the accessor methods. - * * In most case, authentication information consists of a username and password. * Sometimes, a userid is required by proxy, and realm can be useful to discriminate * different SIP domains. @@ -225,6 +222,9 @@ typedef enum _LinphoneAudioRoute { * The application can respond to this information request later using * linphone_core_add_auth_info(). This will unblock all pending authentication * transactions and retry them with authentication headers. + * + * @note The object's fields should not be accessed directly. Prefer using + * the accessor methods. * * @ingroup authentication **/ @@ -516,7 +516,7 @@ typedef struct _LinphoneEvent LinphoneEvent; /** * #LinphoneFactory is a singleton object devoted to the creation of all the object - * of Liblinphone that cannot created by #LinphoneCore or #LinphoneCore itself. + * of Liblinphone that cannot be created by #LinphoneCore itself. * @ingroup initializing */ typedef struct _LinphoneFactory LinphoneFactory; @@ -1118,6 +1118,10 @@ typedef enum _LinphoneTransportType { */ typedef struct _LinphoneTunnel LinphoneTunnel; +/** + * @brief Class to store tunnel settings. + * @ingroup tunnel + */ typedef struct _LinphoneTunnelConfig LinphoneTunnelConfig; /**