feat(enums): add doc on L_ENUM_VALUES_CHAT_ROOM_STATE and L_ENUM_VALUES_CHAT_ROOM_CAPABILITIES

This commit is contained in:
Ronan Abhamon 2018-05-14 14:44:23 +02:00
parent b73f0793c7
commit ee8953c0f4
3 changed files with 18 additions and 20 deletions

View file

@ -196,8 +196,8 @@ typedef struct _LinphoneSearchResult LinphoneSearchResult;
//
// L_DECLARE_C_ENUM(ChatMessageDirection, L_ENUM_VALUES_CHAT_MESSAGE_DIRECTION);
//
// 3. Do not forget to replace each single quote or other special char to an escaped sequence like '''.
// Otherwise you get this error at compilation:
// 3. Do not forget to replace each single quote (with ') or other special char like
// to an escaped sequence. Otherwise you get this error at compilation:
//
// [ 99%] Building CXX object wrappers/cpp/CMakeFiles/linphone++.dir/src/linphone++.cc.o
// c++: error: WORK/desktop/Build/linphone/wrappers/cpp/src/linphone++.cc: No such file or directory
@ -205,8 +205,6 @@ typedef struct _LinphoneSearchResult LinphoneSearchResult;
// compilation terminated.
// -----------------------------------------------------------------------------
// -----------------------------------------------------------------------------
// -----------------------------------------------------------------------------
// Call.
// -----------------------------------------------------------------------------

View file

@ -25,7 +25,7 @@
#define L_ENUM_VALUES_CHAT_MESSAGE_STATE(F) \
F(Idle /**< Initial state */) \
F(InProgress /**< Delivery in progress */) \
F(Delivered /**< Message successfully delivered an acknowledged by the server */) \
F(Delivered /**< Message successfully delivered and 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 */) \

View file

@ -23,22 +23,22 @@
// =============================================================================
#define L_ENUM_VALUES_CHAT_ROOM_STATE(F) \
F(None) \
F(Instantiated) \
F(CreationPending) \
F(Created) \
F(CreationFailed) \
F(TerminationPending) \
F(Terminated) \
F(TerminationFailed) \
F(Deleted)
F(None /**< Initial state */) \
F(Instantiated /**< Chat room is now instantiated on local */) \
F(CreationPending /**< One creation request was sent to the server */) \
F(Created /**< Chat room was created on the server */) \
F(CreationFailed /**< Chat room creation failed */) \
F(TerminationPending /**< Wait for chat room termination */) \
F(Terminated /**< Chat room exists on server but not in local */) \
F(TerminationFailed /**< The chat room termination failed */) \
F(Deleted /**< Chat room was deleted on the server */)
#define L_ENUM_VALUES_CHAT_ROOM_CAPABILITIES(F) \
F(Basic, 1 << 0) \
F(RealTimeText, 1 << 1) \
F(Conference, 1 << 2) \
F(Proxy, 1 << 3) \
F(Migratable, 1 << 4) \
F(OneToOne, 1 << 5)
F(Basic /**< No server. It&apos;s a direct communication */, 1 << 0) \
F(RealTimeText /**< Supports RTT */, 1 << 1) \
F(Conference /**< Use server (supports group chat) */, 1 << 2) \
F(Proxy /**< Special proxy chat room flag */, 1 << 3) \
F(Migratable /**< Chat room migratable from Basic to Conference */, 1 << 4) \
F(OneToOne /**< A communication between two participants (can be Basic or Conference) */, 1 << 5)
#endif // ifndef _L_CHAT_ROOM_ENUMS_H_