From f9f3a810c074e4c0a36faefa07ad8001b6a23901 Mon Sep 17 00:00:00 2001 From: irungentoo Date: Sun, 6 Jul 2014 13:29:25 -0400 Subject: Typo fix. --- toxcore/tox.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'toxcore/tox.h') diff --git a/toxcore/tox.h b/toxcore/tox.h index 5418b03e..d931b9be 100644 --- a/toxcore/tox.h +++ b/toxcore/tox.h @@ -90,7 +90,7 @@ void tox_get_address(const Tox *tox, uint8_t *address); * data is the data and length is the length. * * return the friend number if success. - * return TOX_FA_TOOLONG if message length is too long. + * return TOX_FAERR_TOOLONG if message length is too long. * return TOX_FAERR_NOMESSAGE if no message (message length must be >= 1 byte). * return TOX_FAERR_OWNKEY if user's own key. * return TOX_FAERR_ALREADYSENT if friend request already sent or already a friend. -- cgit v1.2.3 From 4fa115e6d09057219e317dd49bb7b8a3bd2b45f7 Mon Sep 17 00:00:00 2001 From: Jin^eLD Date: Sun, 13 Jul 2014 20:01:06 +0300 Subject: Fixed documentation comment errors --- toxcore/tox.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'toxcore/tox.h') diff --git a/toxcore/tox.h b/toxcore/tox.h index d931b9be..b44648fc 100644 --- a/toxcore/tox.h +++ b/toxcore/tox.h @@ -294,13 +294,13 @@ void tox_callback_friend_request(Tox *tox, void (*function)(Tox *tox, const uint void *), void *userdata); /* Set the function that will be executed when a message from a friend is received. - * Function format is: function(Tox *tox, int32_t friendnumber, uint8_t * message, uint32_t length, void *userdata) + * Function format is: function(Tox *tox, int32_t friendnumber, uint8_t * message, uint16_t length, void *userdata) */ void tox_callback_friend_message(Tox *tox, void (*function)(Tox *tox, int32_t, const uint8_t *, uint16_t, void *), void *userdata); /* Set the function that will be executed when an action from a friend is received. - * Function format is: function(Tox *tox, int32_t friendnumber, uint8_t * action, uint32_t length, void *userdata) + * Function format is: function(Tox *tox, int32_t friendnumber, uint8_t * action, uint16_t length, void *userdata) */ void tox_callback_friend_action(Tox *tox, void (*function)(Tox *tox, int32_t, const uint8_t *, uint16_t, void *), void *userdata); -- cgit v1.2.3 From 59821d6a5ef5b298a66feaaca337e71e9cecab61 Mon Sep 17 00:00:00 2001 From: irungentoo Date: Mon, 14 Jul 2014 18:36:26 -0400 Subject: Fixed file sending documentation. --- toxcore/tox.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'toxcore/tox.h') diff --git a/toxcore/tox.h b/toxcore/tox.h index b44648fc..14426f31 100644 --- a/toxcore/tox.h +++ b/toxcore/tox.h @@ -495,20 +495,20 @@ uint32_t tox_get_chatlist(const Tox *tox, int *out_list, uint32_t list_size); * tox_file_data_remaining(...) can be used to know how many bytes are left to send/receive. * * If the connection breaks during file sending (The other person goes offline without pausing the sending and then comes back) - * the receiver must send a control packet with receive_send == 0 message_id = TOX_FILECONTROL_RESUME_BROKEN and the data being + * the receiver must send a control packet with send_receive == 1 message_id = TOX_FILECONTROL_RESUME_BROKEN and the data being * a uint64_t (in host byte order) containing the number of bytes received. * - * If the sender receives this packet, he must send a control packet with receive_send == 1 and control_type == TOX_FILECONTROL_ACCEPT + * If the sender receives this packet, he must send a control packet with send_receive == 0 and control_type == TOX_FILECONTROL_ACCEPT * then he must start sending file data from the position (data , uint64_t in host byte order) received in the TOX_FILECONTROL_RESUME_BROKEN packet. * * To pause a file transfer send a control packet with control_type == TOX_FILECONTROL_PAUSE. * To unpause a file transfer send a control packet with control_type == TOX_FILECONTROL_ACCEPT. * * If you receive a control packet with receive_send == 1 and control_type == TOX_FILECONTROL_PAUSE, you must stop sending filenumber until the other - * person sends a control packet with receive_send == 1 and control_type == TOX_FILECONTROL_ACCEPT with the filenumber being a paused filenumber. + * person sends a control packet with send_receive == 0 and control_type == TOX_FILECONTROL_ACCEPT with the filenumber being a paused filenumber. * * If you receive a control packet with receive_send == 0 and control_type == TOX_FILECONTROL_PAUSE, it means the sender of filenumber has paused the - * transfer and will resume it later with a control packet with receive_send == 0 and control_type == TOX_FILECONTROL_ACCEPT for that file number. + * transfer and will resume it later with a control packet with send_receive == 1 and control_type == TOX_FILECONTROL_ACCEPT for that file number. * * More to come... */ -- cgit v1.2.3