summaryrefslogtreecommitdiff
path: root/toxcore/tox.h
diff options
context:
space:
mode:
Diffstat (limited to 'toxcore/tox.h')
-rw-r--r--toxcore/tox.h16
1 files changed, 7 insertions, 9 deletions
diff --git a/toxcore/tox.h b/toxcore/tox.h
index 49710e8a..7b778611 100644
--- a/toxcore/tox.h
+++ b/toxcore/tox.h
@@ -805,8 +805,8 @@ size_t tox_get_savedata_size(const Tox *tox);
805/** 805/**
806 * Store all information associated with the tox instance to a byte array. 806 * Store all information associated with the tox instance to a byte array.
807 * 807 *
808 * @param data A memory region large enough to store the tox instance data. 808 * @param savedata A memory region large enough to store the tox instance
809 * Call tox_get_savedata_size to find the number of bytes required. If this parameter 809 * data. Call tox_get_savedata_size to find the number of bytes required. If this parameter
810 * is NULL, this function has no effect. 810 * is NULL, this function has no effect.
811 */ 811 */
812void tox_get_savedata(const Tox *tox, uint8_t *savedata); 812void tox_get_savedata(const Tox *tox, uint8_t *savedata);
@@ -1090,15 +1090,15 @@ size_t tox_self_get_status_message_size(const Tox *tox);
1090 * Call tox_self_get_status_message_size to find out how much memory to allocate for 1090 * Call tox_self_get_status_message_size to find out how much memory to allocate for
1091 * the result. 1091 * the result.
1092 * 1092 *
1093 * @param status A valid memory location large enough to hold the status message. 1093 * @param status_message A valid memory location large enough to hold the
1094 * If this parameter is NULL, the function has no effect. 1094 * status message. If this parameter is NULL, the function has no effect.
1095 */ 1095 */
1096void tox_self_get_status_message(const Tox *tox, uint8_t *status_message); 1096void tox_self_get_status_message(const Tox *tox, uint8_t *status_message);
1097 1097
1098/** 1098/**
1099 * Set the client's user status. 1099 * Set the client's user status.
1100 * 1100 *
1101 * @param user_status One of the user statuses listed in the enumeration above. 1101 * @param status One of the user statuses listed in the enumeration above.
1102 */ 1102 */
1103void tox_self_set_status(Tox *tox, TOX_USER_STATUS status); 1103void tox_self_set_status(Tox *tox, TOX_USER_STATUS status);
1104 1104
@@ -1299,8 +1299,8 @@ size_t tox_self_get_friend_list_size(const Tox *tox);
1299 * 1299 *
1300 * Call tox_self_get_friend_list_size to determine the number of elements to allocate. 1300 * Call tox_self_get_friend_list_size to determine the number of elements to allocate.
1301 * 1301 *
1302 * @param list A memory region with enough space to hold the friend list. If 1302 * @param friend_list A memory region with enough space to hold the friend
1303 * this parameter is NULL, this function has no effect. 1303 * list. If this parameter is NULL, this function has no effect.
1304 */ 1304 */
1305void tox_self_get_friend_list(const Tox *tox, uint32_t *friend_list); 1305void tox_self_get_friend_list(const Tox *tox, uint32_t *friend_list);
1306 1306
@@ -2698,8 +2698,6 @@ size_t tox_conference_get_chatlist_size(const Tox *tox);
2698/** 2698/**
2699 * Copy a list of valid conference IDs into the array chatlist. Determine how much space 2699 * Copy a list of valid conference IDs into the array chatlist. Determine how much space
2700 * to allocate for the array with the `tox_conference_get_chatlist_size` function. 2700 * to allocate for the array with the `tox_conference_get_chatlist_size` function.
2701 *
2702 * @return The number of elements copied to the array, or 0 if chatlist is set to NULL.
2703 */ 2701 */
2704void tox_conference_get_chatlist(const Tox *tox, uint32_t *chatlist); 2702void tox_conference_get_chatlist(const Tox *tox, uint32_t *chatlist);
2705 2703