diff options
author | irungentoo <irungentoo@gmail.com> | 2015-03-23 19:05:05 -0400 |
---|---|---|
committer | irungentoo <irungentoo@gmail.com> | 2015-03-23 19:05:05 -0400 |
commit | 6454552de866017a0ae2515c84fa518a300e43e2 (patch) | |
tree | f70d84cd109a0762185639039cfa628bdd18c88e /toxcore/tox.h | |
parent | 12c7c9130f77055c73f8a6b2b47bc4e831eec540 (diff) |
tox.h comment fix.
Diffstat (limited to 'toxcore/tox.h')
-rw-r--r-- | toxcore/tox.h | 11 |
1 files changed, 4 insertions, 7 deletions
diff --git a/toxcore/tox.h b/toxcore/tox.h index e674fc65..5e68e049 100644 --- a/toxcore/tox.h +++ b/toxcore/tox.h | |||
@@ -1305,19 +1305,16 @@ uint32_t tox_friend_send_message(Tox *tox, uint32_t friend_number, TOX_MESSAGE_T | |||
1305 | * The function type for the `read_receipt` callback. | 1305 | * The function type for the `read_receipt` callback. |
1306 | * | 1306 | * |
1307 | * @param friend_number The friend number of the friend who received the message. | 1307 | * @param friend_number The friend number of the friend who received the message. |
1308 | * @param message_id The message ID as returned from tox_send_message or | 1308 | * @param message_id The message ID as returned from tox_friend_send_message |
1309 | * tox_send_action corresponding to the message sent. | 1309 | * corresponding to the message sent. |
1310 | */ | 1310 | */ |
1311 | typedef void tox_friend_read_receipt_cb(Tox *tox, uint32_t friend_number, uint32_t message_id, void *user_data); | 1311 | typedef void tox_friend_read_receipt_cb(Tox *tox, uint32_t friend_number, uint32_t message_id, void *user_data); |
1312 | 1312 | ||
1313 | /** | 1313 | /** |
1314 | * Set the callback for the `read_receipt` event. Pass NULL to unset. | 1314 | * Set the callback for the `read_receipt` event. Pass NULL to unset. |
1315 | * | 1315 | * |
1316 | * This event is triggered when a read receipt is received from a friend. This | 1316 | * This event is triggered when the friend receives the message sent with |
1317 | * normally means that the message has been received by the friend, however a | 1317 | * tox_friend_send_message with the corresponding message ID. |
1318 | * friend can send a read receipt with any message ID in it, so the number | ||
1319 | * received here may not correspond to any message sent through tox_send_message | ||
1320 | * or tox_send_action. In that case, the receipt should be discarded. | ||
1321 | */ | 1318 | */ |
1322 | void tox_callback_friend_read_receipt(Tox *tox, tox_friend_read_receipt_cb *function, void *user_data); | 1319 | void tox_callback_friend_read_receipt(Tox *tox, tox_friend_read_receipt_cb *function, void *user_data); |
1323 | 1320 | ||