Mirrors/chatmail-core
1
0
Fork 0
mirror of https://github.com/chatmail/core.git synced 2026-05-08 09:26:29 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1761 from deltachat/fix-ffi-docs2

Browse Source 
add missing links and @memberof declarations in ffi-docs
This commit is contained in:
Jikstra
2020-07-26 23:09:04 +02:00
committed by GitHub
parent 0202ed7ca8 9912dd45b9
commit 85970a146a
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
deltachat-ffi/deltachat.h
View File

@@ -854,7 +854,7 @@ uint32_t dc_send_text_msg (dc_context_t* context, uint32_t ch
* *
* - delta-clients can get all information needed from * - delta-clients can get all information needed from
* the message object, using eg. * the message object, using eg.
* dc_msg_get_videochat_url() and check dc_msg_get_viewtype() for DC_MSG_VIDEOCHAT_INVITATION * dc_msg_get_videochat_url() and check dc_msg_get_viewtype() for #DC_MSG_VIDEOCHAT_INVITATION
* *
* dc_send_videochat_invitation() is blocking and may take a while, * dc_send_videochat_invitation() is blocking and may take a while,
* so the UIs will typically call the function from within a thread. * so the UIs will typically call the function from within a thread.
@@ -863,9 +863,10 @@ uint32_t dc_send_text_msg (dc_context_t* context, uint32_t ch
* *
* As for other messages sent, this function * As for other messages sent, this function
* sends the event #DC_EVENT_MSGS_CHANGED on succcess, the message has a delivery state, and so on. * sends the event #DC_EVENT_MSGS_CHANGED on succcess, the message has a delivery state, and so on.
* The recipient will get noticed by the call as usual by DC_EVENT_INCOMING_MSG or DC_EVENT_MSGS_CHANGED, * The recipient will get noticed by the call as usual by #DC_EVENT_INCOMING_MSG or #DC_EVENT_MSGS_CHANGED,
* However, UIs might some things differently, eg. play a different sound. * However, UIs might some things differently, eg. play a different sound.
* *
* @memberof dc_context_t
* @param context The context object. * @param context The context object.
* @param chat_id The chat to start a videochat for. * @param chat_id The chat to start a videochat for.
* @return The id if the message sent out * @return The id if the message sent out
@@ -3281,6 +3282,7 @@ char* dc_msg_get_setupcodebegin (const dc_msg_t* msg);
* Videochat invitations are sent out using dc_send_videochat_invitation() * Videochat invitations are sent out using dc_send_videochat_invitation()
* and dc_msg_get_viewtype() returns #DC_MSG_VIDEOCHAT_INVITATION for such invitations. * and dc_msg_get_viewtype() returns #DC_MSG_VIDEOCHAT_INVITATION for such invitations.
* *
* @memberof dc_msg_t
* @param msg The message object. * @param msg The message object.
* @return If the message contains a videochat invitation, * @return If the message contains a videochat invitation,
* the url of the invitation is returned. * the url of the invitation is returned.
@@ -3302,6 +3304,7 @@ char* dc_msg_get_videochat_url (const dc_msg_t* msg);
* The videochat-url can be retrieved using dc_msg_get_videochat_url(). * The videochat-url can be retrieved using dc_msg_get_videochat_url().
* To check if a message is a videochat invitation at all, check the message type for #DC_MSG_VIDEOCHAT_INVITATION. * To check if a message is a videochat invitation at all, check the message type for #DC_MSG_VIDEOCHAT_INVITATION.
* *
* @memberof dc_msg_t
* @param msg The message object. * @param msg The message object.
* @return Type of the videochat as of DC_VIDEOCHATTYPE_BASICWEBRTC or DC_VIDEOCHATTYPE_UNKNOWN. * @return Type of the videochat as of DC_VIDEOCHATTYPE_BASICWEBRTC or DC_VIDEOCHATTYPE_UNKNOWN.
* *