Update libtox to 0.2.15

1 files changed, 60 insertions, 61 deletions

diff --git a/protocols/Tox/libtox/src/toxcore/group.h b/protocols/Tox/libtox/src/toxcore/group.h
index eb8db55f10..a2e51cd443 100644
--- a/protocols/Tox/libtox/src/toxcore/group.h
+++ b/protocols/Tox/libtox/src/toxcore/group.h
@@ -3,7 +3,7 @@
  * Copyright © 2014 Tox project.
  */
 
-/*
+/**
  * Slightly better groupchats implementation.
  */
 #ifndef C_TOXCORE_TOXCORE_GROUP_H
@@ -66,13 +66,13 @@ typedef enum Groupchat_Connection_Type {
     GROUPCHAT_CONNECTION_ONLINE,
 } Groupchat_Connection_Type;
 
-/* Connection is to one of the closest DESIRED_CLOSEST peers */
+/** Connection is to one of the closest DESIRED_CLOSEST peers */
 #define GROUPCHAT_CONNECTION_REASON_CLOSEST     (1 << 0)
 
-/* Connection is to a peer we are introducing to the conference */
+/** Connection is to a peer we are introducing to the conference */
 #define GROUPCHAT_CONNECTION_REASON_INTRODUCING (1 << 1)
 
-/* Connection is to a peer who is introducing us to the conference */
+/** Connection is to a peer who is introducing us to the conference */
 #define GROUPCHAT_CONNECTION_REASON_INTRODUCER  (1 << 2)
 
 typedef struct Groupchat_Connection {
@@ -136,35 +136,35 @@ typedef struct Group_c {
     group_on_delete_cb *group_on_delete;
 } Group_c;
 
-/* Callback for group invites.
+/** Callback for group invites.
  *
  * data of length is what needs to be passed to join_groupchat().
  */
 typedef void g_conference_invite_cb(Messenger *m, uint32_t friend_number, int type, const uint8_t *cookie,
                                     size_t length, void *user_data);
 
-/* Callback for group connection. */
+/** Callback for group connection. */
 typedef void g_conference_connected_cb(Messenger *m, uint32_t conference_number, void *user_data);
 
-/* Callback for group messages. */
+/** Callback for group messages. */
 typedef void g_conference_message_cb(Messenger *m, uint32_t conference_number, uint32_t peer_number, int type,
                                      const uint8_t *message, size_t length, void *user_data);
 
-/* Callback for peer nickname changes. */
+/** Callback for peer nickname changes. */
 typedef void peer_name_cb(Messenger *m, uint32_t conference_number, uint32_t peer_number, const uint8_t *name,
                           size_t length, void *user_data);
 
-/* Set callback function for peer list changes. */
+/** Set callback function for peer list changes. */
 typedef void peer_list_changed_cb(Messenger *m, uint32_t conference_number, void *user_data);
 
-/* Callback for title changes.
+/** Callback for title changes.
  *
  * If peer_number == -1, then author is unknown (e.g. initial joining the group).
  */
 typedef void title_cb(Messenger *m, uint32_t conference_number, uint32_t peer_number, const uint8_t *title,
                       size_t length, void *user_data);
 
-/* Callback for lossy packets.
+/** Callback for lossy packets.
  *
  * NOTE: Handler must return 0 if packet is to be relayed, -1 if the packet should not be relayed.
  */
@@ -194,32 +194,32 @@ typedef struct Group_Chats {
     Group_Lossy_Handler lossy_packethandlers[256];
 } Group_Chats;
 
-/* Set the callback for group invites. */
+/** Set the callback for group invites. */
 void g_callback_group_invite(Group_Chats *g_c, g_conference_invite_cb *function);
 
-/* Set the callback for group connection. */
+/** Set the callback for group connection. */
 void g_callback_group_connected(Group_Chats *g_c, g_conference_connected_cb *function);
 
-/* Set the callback for group messages. */
+/** Set the callback for group messages. */
 void g_callback_group_message(Group_Chats *g_c, g_conference_message_cb *function);
 
 
-/* Set callback function for title changes. */
+/** Set callback function for title changes. */
 void g_callback_group_title(Group_Chats *g_c, title_cb *function);
 
-/* Set callback function for peer nickname changes.
+/** Set callback function for peer nickname changes.
  *
  * It gets called every time a peer changes their nickname.
  */
 void g_callback_peer_name(Group_Chats *g_c, peer_name_cb *function);
 
-/* Set callback function for peer list changes.
+/** Set callback function for peer list changes.
  *
  * It gets called every time the name list changes(new peer, deleted peer)
  */
 void g_callback_peer_list_changed(Group_Chats *g_c, peer_list_changed_cb *function);
 
-/* Creates a new groupchat and puts it in the chats array.
+/** Creates a new groupchat and puts it in the chats array.
  *
  * type is one of `GROUPCHAT_TYPE_*`
  *
@@ -228,7 +228,7 @@ void g_callback_peer_list_changed(Group_Chats *g_c, peer_list_changed_cb *functi
  */
 int add_groupchat(Group_Chats *g_c, uint8_t type);
 
-/* Delete a groupchat from the chats array, informing the group first as
+/** Delete a groupchat from the chats array, informing the group first as
  * appropriate.
  *
  * return 0 on success.
@@ -236,9 +236,8 @@ int add_groupchat(Group_Chats *g_c, uint8_t type);
  */
 int del_groupchat(Group_Chats *g_c, uint32_t groupnumber, bool leave_permanently);
 
-/* Copy the public key of (frozen, if frozen is true) peernumber who is in
- * groupnumber to pk.
- * pk must be CRYPTO_PUBLIC_KEY_SIZE long.
+/** Copy the public key of (frozen, if frozen is true) peernumber who is in
+ * groupnumber to pk. pk must be CRYPTO_PUBLIC_KEY_SIZE long.
  *
  * return 0 on success
  * return -1 if groupnumber is invalid.
@@ -246,7 +245,7 @@ int del_groupchat(Group_Chats *g_c, uint32_t groupnumber, bool leave_permanently
  */
 int group_peer_pubkey(const Group_Chats *g_c, uint32_t groupnumber, uint32_t peernumber, uint8_t *pk, bool frozen);
 
-/*
+/**
  * Return the size of (frozen, if frozen is true) peernumber's name.
  *
  * return -1 if groupnumber is invalid.
@@ -254,9 +253,8 @@ int group_peer_pubkey(const Group_Chats *g_c, uint32_t groupnumber, uint32_t pee
  */
 int group_peername_size(const Group_Chats *g_c, uint32_t groupnumber, uint32_t peernumber, bool frozen);
 
-/* Copy the name of (frozen, if frozen is true) peernumber who is in
- * groupnumber to name.
- * name must be at least MAX_NAME_LENGTH long.
+/** Copy the name of (frozen, if frozen is true) peernumber who is in
+ * groupnumber to name. name must be at least MAX_NAME_LENGTH long.
  *
  * return length of name if success
  * return -1 if groupnumber is invalid.
@@ -264,7 +262,7 @@ int group_peername_size(const Group_Chats *g_c, uint32_t groupnumber, uint32_t p
  */
 int group_peername(const Group_Chats *g_c, uint32_t groupnumber, uint32_t peernumber, uint8_t *name, bool frozen);
 
-/* Copy last active timestamp of frozen peernumber who is in groupnumber to
+/** Copy last active timestamp of frozen peernumber who is in groupnumber to
  * last_active.
  *
  * return 0 on success.
@@ -274,22 +272,23 @@ int group_peername(const Group_Chats *g_c, uint32_t groupnumber, uint32_t peernu
 int group_frozen_last_active(const Group_Chats *g_c, uint32_t groupnumber, uint32_t peernumber,
                              uint64_t *last_active);
 
-/* Set maximum number of frozen peers.
+/** Set maximum number of frozen peers.
  *
  * return 0 on success.
  * return -1 if groupnumber is invalid.
  */
 int group_set_max_frozen(const Group_Chats *g_c, uint32_t groupnumber, uint32_t maxfrozen);
 
-/* invite friendnumber to groupnumber
+/** invite friendnumber to groupnumber.
  *
  * return 0 on success.
  * return -1 if groupnumber is invalid.
  * return -2 if invite packet failed to send.
+ * return -3 if we are not connected to the group chat.
  */
-int invite_friend(Group_Chats *g_c, uint32_t friendnumber, uint32_t groupnumber);
+int invite_friend(const Group_Chats *g_c, uint32_t friendnumber, uint32_t groupnumber);
 
-/* Join a group (you need to have been invited first.)
+/** Join a group (we need to have been invited first.)
  *
  * expected_type is the groupchat type we expect the chat we are joining to
  * have.
@@ -305,19 +304,19 @@ int invite_friend(Group_Chats *g_c, uint32_t friendnumber, uint32_t groupnumber)
 int join_groupchat(Group_Chats *g_c, uint32_t friendnumber, uint8_t expected_type, const uint8_t *data,
                    uint16_t length);
 
-/* send a group message
+/** send a group message
  * return 0 on success
  * see: send_message_group() for error codes.
  */
 int group_message_send(const Group_Chats *g_c, uint32_t groupnumber, const uint8_t *message, uint16_t length);
 
-/* send a group action
+/** send a group action
  * return 0 on success
  * see: send_message_group() for error codes.
  */
 int group_action_send(const Group_Chats *g_c, uint32_t groupnumber, const uint8_t *action, uint16_t length);
 
-/* set the group's title, limited to MAX_NAME_LENGTH
+/** set the group's title, limited to MAX_NAME_LENGTH
  * return 0 on success
  * return -1 if groupnumber is invalid.
  * return -2 if title is too long or empty.
@@ -326,13 +325,13 @@ int group_action_send(const Group_Chats *g_c, uint32_t groupnumber, const uint8_
 int group_title_send(const Group_Chats *g_c, uint32_t groupnumber, const uint8_t *title, uint8_t title_len);
 
 
-/* return the group's title size.
+/** return the group's title size.
  * return -1 of groupnumber is invalid.
  * return -2 if title is too long or empty.
  */
 int group_title_get_size(const Group_Chats *g_c, uint32_t groupnumber);
 
-/* Get group title from groupnumber and put it in title.
+/** Get group title from groupnumber and put it in title.
  * Title needs to be a valid memory location with a size of at least MAX_NAME_LENGTH (128) bytes.
  *
  * return length of copied title if success.
@@ -341,13 +340,13 @@ int group_title_get_size(const Group_Chats *g_c, uint32_t groupnumber);
  */
 int group_title_get(const Group_Chats *g_c, uint32_t groupnumber, uint8_t *title);
 
-/* Return the number of (frozen, if frozen is true) peers in the group chat on
+/** Return the number of (frozen, if frozen is true) peers in the group chat on
  * success.
  * return -1 if groupnumber is invalid.
  */
 int group_number_peers(const Group_Chats *g_c, uint32_t groupnumber, bool frozen);
 
-/* return 1 if the peernumber corresponds to ours.
+/** return 1 if the peernumber corresponds to ours.
  * return 0 if the peernumber is not ours.
  * return -1 if groupnumber is invalid.
  * return -2 if peernumber is invalid.
@@ -355,37 +354,37 @@ int group_number_peers(const Group_Chats *g_c, uint32_t groupnumber, bool frozen
  */
 int group_peernumber_is_ours(const Group_Chats *g_c, uint32_t groupnumber, uint32_t peernumber);
 
-/* Set handlers for custom lossy packets. */
+/** Set handlers for custom lossy packets. */
 void group_lossy_packet_registerhandler(Group_Chats *g_c, uint8_t byte, lossy_packet_cb *function);
 
-/* High level function to send custom lossy packets.
+/** High level function to send custom lossy packets.
  *
  * return -1 on failure.
  * return 0 on success.
  */
 int send_group_lossy_packet(const Group_Chats *g_c, uint32_t groupnumber, const uint8_t *data, uint16_t length);
 
-/* Return the number of chats in the instance m.
+/** Return the number of chats in the instance m.
  * You should use this to determine how much memory to allocate
  * for copy_chatlist.
  */
 uint32_t count_chatlist(const Group_Chats *g_c);
 
-/* Copy a list of valid chat IDs into the array out_list.
+/** Copy a list of valid chat IDs into the array out_list.
  * If out_list is NULL, returns 0.
  * Otherwise, returns the number of elements copied.
  * If the array was too small, the contents
  * of out_list will be truncated to list_size. */
 uint32_t copy_chatlist(const Group_Chats *g_c, uint32_t *out_list, uint32_t list_size);
 
-/* return the type of groupchat (GROUPCHAT_TYPE_) that groupnumber is.
+/** return the type of groupchat (GROUPCHAT_TYPE_) that groupnumber is.
  *
  * return -1 on failure.
  * return type on success.
  */
 int group_get_type(const Group_Chats *g_c, uint32_t groupnumber);
 
-/* Copies the unique id of `group_chat[groupnumber]` into id.
+/** Copies the unique id of `group_chat[groupnumber]` into `id`.
  *
  * return false on failure.
  * return true on success.
@@ -394,63 +393,63 @@ bool conference_get_id(const Group_Chats *g_c, uint32_t groupnumber, uint8_t *id
 
 int32_t conference_by_id(const Group_Chats *g_c, const uint8_t *id);
 
-/* Send current name (set in messenger) to all online groups.
+/** Send current name (set in messenger) to all online groups.
  */
-void send_name_all_groups(Group_Chats *g_c);
+void send_name_all_groups(const Group_Chats *g_c);
 
-/* Set the object that is tied to the group chat.
+/** Set the object that is tied to the group chat.
  *
  * return 0 on success.
  * return -1 on failure
  */
 int group_set_object(const Group_Chats *g_c, uint32_t groupnumber, void *object);
 
-/* Set the object that is tied to the group peer.
+/** Set the object that is tied to the group peer.
  *
  * return 0 on success.
  * return -1 on failure
  */
 int group_peer_set_object(const Group_Chats *g_c, uint32_t groupnumber, uint32_t peernumber, void *object);
 
-/* Return the object tied to the group chat previously set by group_set_object.
+/** Return the object tied to the group chat previously set by group_set_object.
  *
  * return NULL on failure.
  * return object on success.
  */
 void *group_get_object(const Group_Chats *g_c, uint32_t groupnumber);
 
-/* Return the object tied to the group chat peer previously set by group_peer_set_object.
+/** Return the object tied to the group chat peer previously set by group_peer_set_object.
  *
  * return NULL on failure.
  * return object on success.
  */
 void *group_peer_get_object(const Group_Chats *g_c, uint32_t groupnumber, uint32_t peernumber);
 
-/* Set a function to be called when a new peer joins a group chat.
+/** Set a function to be called when a new peer joins a group chat.
  *
  * return 0 on success.
  * return -1 on failure.
  */
 int callback_groupchat_peer_new(const Group_Chats *g_c, uint32_t groupnumber, peer_on_join_cb *function);
 
-/* Set a function to be called when a peer leaves a group chat.
+/** Set a function to be called when a peer leaves a group chat.
  *
  * return 0 on success.
  * return -1 on failure.
  */
-int callback_groupchat_peer_delete(Group_Chats *g_c, uint32_t groupnumber, peer_on_leave_cb *function);
+int callback_groupchat_peer_delete(const Group_Chats *g_c, uint32_t groupnumber, peer_on_leave_cb *function);
 
-/* Set a function to be called when the group chat is deleted.
+/** Set a function to be called when the group chat is deleted.
  *
  * return 0 on success.
  * return -1 on failure.
  */
-int callback_groupchat_delete(Group_Chats *g_c, uint32_t groupnumber, group_on_delete_cb *function);
+int callback_groupchat_delete(const Group_Chats *g_c, uint32_t groupnumber, group_on_delete_cb *function);
 
-/* Return size of the conferences data (for saving). */
+/** Return size of the conferences data (for saving). */
 uint32_t conferences_size(const Group_Chats *g_c);
 
-/* Save the conferences in data (must be allocated memory of size at least conferences_size()) */
+/** Save the conferences in data (must be allocated memory of size at least conferences_size()) */
 uint8_t *conferences_save(const Group_Chats *g_c, uint8_t *data);
 
 /**
@@ -465,13 +464,13 @@ uint8_t *conferences_save(const Group_Chats *g_c, uint8_t *data);
 bool conferences_load_state_section(Group_Chats *g_c, const uint8_t *data, uint32_t length, uint16_t type,
                                     State_Load_Status *status);
 
-/* Create new groupchat instance. */
-Group_Chats *new_groupchats(Mono_Time *mono_time, Messenger *m);
+/** Create new groupchat instance. */
+Group_Chats *new_groupchats(const Mono_Time *mono_time, Messenger *m);
 
-/* main groupchats loop. */
+/** main groupchats loop. */
 void do_groupchats(Group_Chats *g_c, void *userdata);
 
-/* Free everything related with group chats. */
+/** Free everything related with group chats. */
 void kill_groupchats(Group_Chats *g_c);
 
 #endif