diff --git a/coreapi/help/doxygen.dox b/coreapi/help/doxygen.dox index 8707785b2..32ed3da1a 100644 --- a/coreapi/help/doxygen.dox +++ b/coreapi/help/doxygen.dox @@ -34,6 +34,13 @@ /** * @defgroup call_control Placing and receiving calls + * + * The #LinphoneCall object represents an incoming or outgoing call managed by the #LinphoneCore. + * Outgoing calls can be created using linphone_core_invite() or linphone_core_invite_address(), while incoming calls are notified to the application + * through the LinphoneCoreVTable::call_state_changed callback. + * + * See the basic call \ref basic_call_tutorials "tutorial". + * **/ /** diff --git a/coreapi/linphonecore.h b/coreapi/linphonecore.h index 04be47483..2170459e5 100644 --- a/coreapi/linphonecore.h +++ b/coreapi/linphonecore.h @@ -185,6 +185,7 @@ void linphone_call_params_destroy(LinphoneCallParams *cp); /** * Enum describing failure reasons. + * @ingroup initializing **/ enum _LinphoneReason{ LinphoneReasonNone, @@ -203,8 +204,13 @@ const char *linphone_reason_to_string(LinphoneReason err); struct _LinphoneCall; typedef struct _LinphoneCall LinphoneCall; +/** + * LinphoneCallState enum represents the different state a call can reach into. + * The application is notified of state changes through the LinphoneCoreVTable::call_state_changed callback. + * @ingroup call_control +**/ typedef enum _LinphoneCallState{ - LinphoneCallIdle, + LinphoneCallIdle, /**