Commit cb9add11 authored by Simon Morlat's avatar Simon Morlat

improve documentation

parent a532eb55
...@@ -34,6 +34,13 @@ ...@@ -34,6 +34,13 @@
/** /**
* @defgroup call_control Placing and receiving calls * @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".
*
**/ **/
/** /**
......
...@@ -185,6 +185,7 @@ void linphone_call_params_destroy(LinphoneCallParams *cp); ...@@ -185,6 +185,7 @@ void linphone_call_params_destroy(LinphoneCallParams *cp);
/** /**
* Enum describing failure reasons. * Enum describing failure reasons.
* @ingroup initializing
**/ **/
enum _LinphoneReason{ enum _LinphoneReason{
LinphoneReasonNone, LinphoneReasonNone,
...@@ -203,8 +204,13 @@ const char *linphone_reason_to_string(LinphoneReason err); ...@@ -203,8 +204,13 @@ const char *linphone_reason_to_string(LinphoneReason err);
struct _LinphoneCall; struct _LinphoneCall;
typedef struct _LinphoneCall 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{ typedef enum _LinphoneCallState{
LinphoneCallIdle, LinphoneCallIdle, /**<Initial call state */
LinphoneCallIncomingReceived, /**<This is a new incoming call */ LinphoneCallIncomingReceived, /**<This is a new incoming call */
LinphoneCallOutgoingInit, /**<An outgoing call is started */ LinphoneCallOutgoingInit, /**<An outgoing call is started */
LinphoneCallOutgoingProgress, /**<An outgoing call is in progress */ LinphoneCallOutgoingProgress, /**<An outgoing call is in progress */
...@@ -302,11 +308,11 @@ typedef struct _LinphoneProxyConfig LinphoneProxyConfig; ...@@ -302,11 +308,11 @@ typedef struct _LinphoneProxyConfig LinphoneProxyConfig;
* LinphoneRegistrationState describes proxy registration states. * LinphoneRegistrationState describes proxy registration states.
**/ **/
typedef enum _LinphoneRegistrationState{ typedef enum _LinphoneRegistrationState{
LinphoneRegistrationNone, LinphoneRegistrationNone, /**<Initial state for registrations */
LinphoneRegistrationProgress, LinphoneRegistrationProgress, /**<Registration is in progress */
LinphoneRegistrationOk, LinphoneRegistrationOk, /**< Registration is successful */
LinphoneRegistrationCleared, LinphoneRegistrationCleared, /**< Unregistration succeeded */
LinphoneRegistrationFailed LinphoneRegistrationFailed /**<Registration failed */
}LinphoneRegistrationState; }LinphoneRegistrationState;
/** /**
...@@ -485,6 +491,17 @@ void * linphone_chat_room_get_user_data(LinphoneChatRoom *cr); ...@@ -485,6 +491,17 @@ void * linphone_chat_room_get_user_data(LinphoneChatRoom *cr);
/** /**
* @} * @}
*/ */
/**
* @addtogroup initializing
* @{
**/
/**
* LinphoneGlobalState describes the global state of the LinphoneCore object.
* It is notified via the LinphoneCoreVTable::global_state_changed
**/
typedef enum _LinphoneGlobalState{ typedef enum _LinphoneGlobalState{
LinphoneGlobalOff, LinphoneGlobalOff,
LinphoneGlobalStartup, LinphoneGlobalStartup,
...@@ -494,11 +511,6 @@ typedef enum _LinphoneGlobalState{ ...@@ -494,11 +511,6 @@ typedef enum _LinphoneGlobalState{
const char *linphone_global_state_to_string(LinphoneGlobalState gs); const char *linphone_global_state_to_string(LinphoneGlobalState gs);
/**
* @addtogroup initializing
* @{
**/
/**Call state notification callback prototype*/ /**Call state notification callback prototype*/
typedef void (*LinphoneGlobalStateCb)(struct _LinphoneCore *lc, LinphoneGlobalState gstate, const char *message); typedef void (*LinphoneGlobalStateCb)(struct _LinphoneCore *lc, LinphoneGlobalState gstate, const char *message);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment