Skip to content

Commit daeeca3

Browse files
authored
docs: Clarify DC_EVENT_INCOMING_WEBXDC_NOTIFY documentation (#6249)
I found the old documentation rather hard to understand. The new doc string: - uses whole sentences, leaving less space for misinterpretation - explicitly mentions that it can happen that there is no webxdc-info-message - is clearly structured using bullet points.
1 parent 29de7c3 commit daeeca3

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

deltachat-ffi/deltachat.h

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6091,11 +6091,15 @@ void dc_event_unref(dc_event_t* event);
60916091
* A webxdc wants an info message or a changed summary to be notified.
60926092
*
60936093
* @param data1 contact_id ID of the contact sending.
6094-
* @param data2 (int) msg_id + (char*) text_to_notify.
6095-
* msg_id in dc_event_get_data2_int(), referring to webxdc-info-message
6096-
* or webxdc-instance in case of summary change.
6097-
* text_to_notify in dc_event_get_data2_str().
6098-
* string must be passed to dc_str_unref() afterwards.
6094+
* @param data2 (int) msg_id _and_ (char*) text_to_notify.
6095+
* - dc_event_get_data2_int() returns the msg_id,
6096+
* referring to the webxdc-info-message, if there is any.
6097+
* Sometimes no webxdc-info-message is added to the chat
6098+
* and yet a notification is sent; in this case the msg_id
6099+
* of the webxdc instance is returned.
6100+
* - dc_event_get_data2_str() returns text_to_notify,
6101+
* the text that shall be shown in the notification.
6102+
* string must be passed to dc_str_unref() afterwards.
60996103
*/
61006104
#define DC_EVENT_INCOMING_WEBXDC_NOTIFY 2003
61016105

0 commit comments

Comments
 (0)