From f79dd1c9369f49acbed2ce96132c91335679e239 Mon Sep 17 00:00:00 2001 From: Ronan Abhamon Date: Mon, 14 May 2018 14:21:53 +0200 Subject: [PATCH] feat(enums): add doc on L_ENUM_VALUES_CHAT_MESSAGE_STATE and L_ENUM_VALUES_CHAT_MESSAGE_DIRECTION --- include/linphone/enums/call-enums.h | 4 ++-- include/linphone/enums/chat-message-enums.h | 20 ++++++++++---------- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/include/linphone/enums/call-enums.h b/include/linphone/enums/call-enums.h index b26b49830..ff38c00f7 100644 --- a/include/linphone/enums/call-enums.h +++ b/include/linphone/enums/call-enums.h @@ -23,7 +23,7 @@ // ============================================================================= #define L_ENUM_VALUES_CALL_SESSION_STATE(F) \ - F(Idle /**< Idle */) \ + F(Idle /**< Initial state */) \ F(IncomingReceived /**< Incoming call received */) \ F(OutgoingInit /**< Outgoing call initialized */) \ F(OutgoingProgress /**< Outgoing call in progress */) \ @@ -38,7 +38,7 @@ F(Error /**< Error */) \ F(End /**< Call end */) \ F(PausedByRemote /**< Paused by remote */) \ - F(UpdatedByRemote /**< The call's parameters are updated used for example when video is asked by remote */) \ + F(UpdatedByRemote /**< The call's parameters are updated for example when video is asked by remote */) \ F(IncomingEarlyMedia /**< We are proposing early media to an incoming call */) \ F(Updating /**< We have initiated a call update */) \ F(Released /**< The call object is now released */) \ diff --git a/include/linphone/enums/chat-message-enums.h b/include/linphone/enums/chat-message-enums.h index 2cb254208..e1ca3e963 100644 --- a/include/linphone/enums/chat-message-enums.h +++ b/include/linphone/enums/chat-message-enums.h @@ -23,17 +23,17 @@ // ============================================================================= #define L_ENUM_VALUES_CHAT_MESSAGE_STATE(F) \ - F(Idle) \ - F(InProgress) \ - F(Delivered) \ - F(NotDelivered) \ - F(FileTransferError) \ - F(FileTransferDone) \ - F(DeliveredToUser) \ - F(Displayed) + F(Idle /**< Initial state */) \ + F(InProgress /**< Delivery in progress */) \ + F(Delivered /**< Message successfully delivered an acknowledged by the server */) \ + F(NotDelivered /**< Message was not delivered */) \ + F(FileTransferError /**< Message was received (and acknowledged) but cannot get file from server */) \ + F(FileTransferDone /**< File transfer has been completed successfully */) \ + F(DeliveredToUser /**< Message successfully delivered an acknowledged by the remote user */) \ + F(Displayed /**< Message successfully displayed to the remote user */) #define L_ENUM_VALUES_CHAT_MESSAGE_DIRECTION(F) \ - F(Incoming) \ - F(Outgoing) + F(Incoming /**< Incoming message */) \ + F(Outgoing /**< Outgoing message */) #endif // ifndef _L_CHAT_MESSAGE_ENUMS_H_