Commit 2f6854ca authored by Ghislain MARY's avatar Ghislain MARY

Add documentation for enums that were not documented.

parent 933513b7
......@@ -1144,14 +1144,14 @@ bool_t linphone_call_params_video_enabled(const LinphoneCallParams *cp){
/**
* Returns kind of media encryption selected for the call.
**/
enum LinphoneMediaEncryption linphone_call_params_get_media_encryption(const LinphoneCallParams *cp) {
LinphoneMediaEncryption linphone_call_params_get_media_encryption(const LinphoneCallParams *cp) {
return cp->media_encryption;
}
/**
* Set requested media encryption for a call.
**/
void linphone_call_params_set_media_encryption(LinphoneCallParams *cp, enum LinphoneMediaEncryption e) {
void linphone_call_params_set_media_encryption(LinphoneCallParams *cp, LinphoneMediaEncryption e) {
cp->media_encryption = e;
}
......
......@@ -6085,7 +6085,7 @@ bool_t linphone_core_media_encryption_supported(const LinphoneCore *lc, Linphone
return FALSE;
}
int linphone_core_set_media_encryption(LinphoneCore *lc, enum LinphoneMediaEncryption menc) {
int linphone_core_set_media_encryption(LinphoneCore *lc, LinphoneMediaEncryption menc) {
const char *type="none";
int ret=0;
if (menc == LinphoneMediaEncryptionSRTP){
......
......@@ -242,17 +242,19 @@ typedef struct _LinphoneCallLog LinphoneCallLog;
/**
* Enum describing type of media encryption types.
* @ingroup media_parameters
**/
enum LinphoneMediaEncryption {
LinphoneMediaEncryptionNone,
LinphoneMediaEncryptionSRTP,
LinphoneMediaEncryptionZRTP
enum _LinphoneMediaEncryption {
LinphoneMediaEncryptionNone, /**< No media encryption is used */
LinphoneMediaEncryptionSRTP, /**< Use SRTP media encryption */
LinphoneMediaEncryptionZRTP /**< Use ZRTP media encryption */
};
/**
* Enum describing type of media encryption types.
* @ingroup media_parameters
**/
typedef enum LinphoneMediaEncryption LinphoneMediaEncryption;
typedef enum _LinphoneMediaEncryption LinphoneMediaEncryption;
/*public: */
LINPHONE_PUBLIC LinphoneAddress *linphone_call_log_get_from(LinphoneCallLog *cl);
......@@ -845,14 +847,14 @@ typedef struct _LinphoneChatMessage LinphoneChatMessage;
typedef struct _LinphoneChatRoom LinphoneChatRoom;
/**
*LinphoneChatMessageState is used to notify if messages have been succesfully delivered or not.
* LinphoneChatMessageState is used to notify if messages have been succesfully delivered or not.
*/
typedef enum _LinphoneChatMessageStates {
LinphoneChatMessageStateIdle, /**<initial state*/
LinphoneChatMessageStateInProgress, /**<delivery in progress**/
LinphoneChatMessageStateDelivered, /**<message succesffully delivered an acknoleged by remote end point*/
LinphoneChatMessageStateNotDelivered /**<message was not delivered*/
}LinphoneChatMessageState;
typedef enum _LinphoneChatMessageState {
LinphoneChatMessageStateIdle, /**< Initial state */
LinphoneChatMessageStateInProgress, /**< Delivery in progress */
LinphoneChatMessageStateDelivered, /**< Message succesffully delivered an acknoleged by remote end point */
LinphoneChatMessageStateNotDelivered /**< Message was not delivered */
} LinphoneChatMessageState;
/**
* Call back used to notify message delivery status
......@@ -1108,13 +1110,16 @@ typedef struct _LCCallbackObj
}LCCallbackObj;
typedef enum _LinphoneFirewallPolicy{
LinphonePolicyNoFirewall,
LinphonePolicyUseNatAddress,
LinphonePolicyUseStun,
LinphonePolicyUseIce,
LinphonePolicyUseUpnp,
/**
* Policy to use to pass through firewalls.
* @ingroup network_parameters
**/
typedef enum _LinphoneFirewallPolicy {
LinphonePolicyNoFirewall, /**< Do not use any mechanism to pass through firewalls */
LinphonePolicyUseNatAddress, /**< Use the specified public adress */
LinphonePolicyUseStun, /**< Use a STUN server to get the public address */
LinphonePolicyUseIce, /**< Use the ICE protocol */
LinphonePolicyUseUpnp, /**< Use the uPnP protocol */
} LinphoneFirewallPolicy;
typedef enum _LinphoneWaitingState{
......@@ -1822,7 +1827,7 @@ LINPHONE_PUBLIC bool_t linphone_core_media_encryption_supported(const LinphoneCo
* @returns 0 if successful, any other value otherwise.
* @ingroup media_parameters
*/
LINPHONE_PUBLIC int linphone_core_set_media_encryption(LinphoneCore *lc, enum LinphoneMediaEncryption menc);
LINPHONE_PUBLIC int linphone_core_set_media_encryption(LinphoneCore *lc, LinphoneMediaEncryption menc);
/**
* Get the media encryption policy being used for RTP packets.
......
......@@ -31,11 +31,10 @@ extern "C" {
* @{
*/
/**
* @ingroup buddy_list
* Enum controlling behavior for incoming subscription request.
* <br> Use by linphone_friend_set_inc_subscribe_policy()
*/
typedef enum {
typedef enum _LinphoneSubscribePolicy {
/**
* Does not automatically accept an incoming subscription request.
* This policy implies that a decision has to be taken for each incoming subscription request notified by callback LinphoneCoreVTable.new_subscription_request
......@@ -50,7 +49,7 @@ typedef enum {
* Automatically accepts a subscription request.
*/
LinphoneSPAccept
}LinphoneSubscribePolicy;
} LinphoneSubscribePolicy;
/**
* Enum describing remote friend status
......
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