1 files changed, 58 insertions, 49 deletions

diff --git a/toxcore/DHT.h b/toxcore/DHT.h
index 6295581b..e4ba2154 100644
--- a/toxcore/DHT.h
+++ b/toxcore/DHT.h
@@ -31,21 +31,21 @@ extern "C" {
 #endif
 
 
-/* size of the client_id in bytes */
+/* Size of the client_id in bytes. */
 #define CLIENT_ID_SIZE crypto_box_PUBLICKEYBYTES
 
-/* maximum number of clients stored per friend. */
+/* Maximum number of clients stored per friend. */
 #define MAX_FRIEND_CLIENTS 8
 
 /* A list of the clients mathematically closest to ours. */
 #define LCLIENT_LIST 32
 
-/* The list of ip ports along with the ping_id of what we sent them and a timestamp */
-#define LPING_ARRAY 256 //NOTE Deprecated (doesn't do anything)
+/* The list of ip ports along with the ping_id of what we sent them and a timestamp. */
+#define LPING_ARRAY 256 // NOTE: Deprecated (doesn't do anything).
 
 #define LSEND_NODES_ARRAY LPING_ARRAY/2
 
-/*Maximum newly announced nodes to ping per TIME_TOPING seconds*/
+/* Maximum newly announced nodes to ping per TIME_TOPING seconds. */
 #define MAX_TOPING 16
 
 typedef struct {
@@ -54,7 +54,7 @@ typedef struct {
     uint64_t    timestamp;
     uint64_t    last_pinged;
 
-    /* Returned by this node. Either our friend or us */
+    /* Returned by this node. Either our friend or us. */
     IP_Port     ret_ip_port;
     uint64_t    ret_timestamp;
 } Client_data;
@@ -65,10 +65,10 @@ typedef struct {
     uint8_t     client_id[CLIENT_ID_SIZE];
     Client_data client_list[MAX_FRIEND_CLIENTS];
 
-    /* time at which the last get_nodes request was sent. */
+    /* Time at which the last get_nodes request was sent. */
     uint64_t    lastgetnode;
 
-    /* Symetric NAT hole punching stuff */
+    /* Symetric NAT hole punching stuff. */
 
     /* 1 if currently hole punching, otherwise 0 */
     uint8_t     hole_punching;
@@ -106,82 +106,91 @@ typedef struct {
 
 Client_data *DHT_get_close_list(DHT *dht);
 
-/* Add a new friend to the friends list
-    client_id must be CLIENT_ID_SIZE bytes long.
-    returns 0 if success
-    returns 1 if failure (friends list is full) */
+/* Add a new friend to the friends list.
+ *  client_id must be CLIENT_ID_SIZE bytes long.
+ *  returns 0 if success.
+ *  returns 1 if failure (friends list is full).
+ */
 int DHT_addfriend(DHT *dht, uint8_t *client_id);
 
-/* Delete a friend from the friends list
-    client_id must be CLIENT_ID_SIZE bytes long.
-    returns 0 if success
-    returns 1 if failure (client_id not in friends list) */
+/* Delete a friend from the friends list.
+ *  client_id must be CLIENT_ID_SIZE bytes long.
+ *  returns 0 if success.
+ *  returns 1 if failure (client_id not in friends list).
+ */
 int DHT_delfriend(DHT *dht, uint8_t *client_id);
 
-/* Get ip of friend
-    client_id must be CLIENT_ID_SIZE bytes long.
-    ip must be 4 bytes long.
-    port must be 2 bytes long.
-    returns ip if success
-    returns ip of 0 if failure (This means the friend is either offline or we have not found him yet.)
-    returns ip of 1 if friend is not in list. */
+/* Get ip of friend.
+ *  client_id must be CLIENT_ID_SIZE bytes long.
+ *  ip must be 4 bytes long.
+ *  port must be 2 bytes long.
+ *  returns ip if success.
+ *  returns ip of 0 if failure (This means the friend is either offline or we have not found him yet).
+ *  returns ip of 1 if friend is not in list. 
+ */
 IP_Port DHT_getfriendip(DHT *dht, uint8_t *client_id);
 
-/* Run this function at least a couple times per second (It's the main loop) */
+/* Run this function at least a couple times per second (It's the main loop). */
 void do_DHT(DHT *dht);
 
-/* Use this function to bootstrap the client
-    Sends a get nodes request to the given node with ip port and public_key */
+/* Use this function to bootstrap the client.
+ *  Sends a get nodes request to the given node with ip port and public_key.
+ */
 void DHT_bootstrap(DHT *dht, IP_Port ip_port, uint8_t *public_key);
 
-/* Add nodes to the toping list
-   all nodes in this list are pinged every TIME_TOPING seconds
-   and are then removed from the list.
-   if the list is full the nodes farthest from our client_id are replaced
-   the purpose of this list is to enable quick integration of new nodes into the
-   network while preventing amplification attacks.
-   return 0 if node was added
-   return -1 if node was not added */
+/* Add nodes to the toping list.
+ * All nodes in this list are pinged every TIME_TOPING seconds
+ * and are then removed from the list.
+ * If the list is full the nodes farthest from our client_id are replaced.
+ * The purpose of this list is to enable quick integration of new nodes into the
+ * network while preventing amplification attacks.
+ * return 0 if node was added.
+ * return -1 if node was not added.
+ */
 int add_toping(DHT *dht, uint8_t *client_id, IP_Port ip_port);
 
 /* ROUTING FUNCTIONS */
 
-/* send the given packet to node with client_id
-    returns -1 if failure */
+/* Send the given packet to node with client_id.
+    returns -1 if failure. */
 int route_packet(DHT *dht, uint8_t *client_id, uint8_t *packet, uint32_t length);
 
-/* Send the following packet to everyone who tells us they are connected to friend_id
-    returns the number of nodes it sent the packet to */
+/* Send the following packet to everyone who tells us they are connected to friend_id.
+ *  returns the number of nodes it sent the packet to.
+ */
 int route_tofriend(DHT *dht, uint8_t *friend_id, uint8_t *packet, uint32_t length);
 
 /* NAT PUNCHING FUNCTIONS */
 
-/* Puts all the different ips returned by the nodes for a friend_id into array ip_portlist
-    ip_portlist must be at least MAX_FRIEND_CLIENTS big
-    returns the number of ips returned
-    returns -1 if no such friend*/
+/* Puts all the different ips returned by the nodes for a friend_id into array ip_portlist.
+ *  ip_portlist must be at least MAX_FRIEND_CLIENTS big.
+ *  returns the number of ips returned.
+ *  returns -1 if no such friend.
+ */
 int friend_ips(DHT *dht, IP_Port *ip_portlist, uint8_t *friend_id);
 
 /* SAVE/LOAD functions */
 
-/* get the size of the DHT (for saving) */
+/* Get the size of the DHT (for saving). */
 uint32_t DHT_size(DHT *dht);
 
-/* save the DHT in data where data is an array of size DHT_size() */
+/* Save the DHT in data where data is an array of size DHT_size(). */
 void DHT_save(DHT *dht, uint8_t *data);
 
-/* init DHT */
+/* Initialize DHT. */
 DHT *new_DHT(Net_Crypto *c);
 
 void kill_DHT(DHT *dht);
 
-/* load the DHT from data of size size;
-    return -1 if failure
-    return 0 if success */
+/* Load the DHT from data of size size.
+ *  return -1 if failure.
+ *  return 0 if success.
+ */
 int DHT_load(DHT *dht, uint8_t *data, uint32_t size);
 
 /* returns 0 if we are not connected to the DHT
-    returns 1 if we are */
+ * returns 1 if we are
+ */
 int DHT_isconnected(DHT *dht);
 
 void addto_lists(DHT *dht, IP_Port ip_port, uint8_t *client_id);