1 files changed, 62 insertions, 62 deletions

diff --git a/toxcore/Lossless_UDP.h b/toxcore/Lossless_UDP.h
index 176e86ce..216e95d0 100644
--- a/toxcore/Lossless_UDP.h
+++ b/toxcore/Lossless_UDP.h
@@ -30,22 +30,22 @@
 extern "C" {
 #endif
 
-/* maximum length of the data in the data packets */
+/* Maximum length of the data in the data packets. */
 #define MAX_DATA_SIZE 1024
 
-/* maximum data packets in sent and receive queues. */
+/* Maximum data packets in sent and receive queues. */
 #define MAX_QUEUE_NUM     16
 
-/* maximum number of data packets in the buffer */
+/* Maximum number of data packets in the buffer. */
 #define BUFFER_PACKET_NUM (16-1)
 
-/* timeout per connection is randomly set between CONNEXION_TIMEOUT and 2*CONNEXION_TIMEOUT */
+/* Timeout per connection is randomly set between CONNEXION_TIMEOUT and 2*CONNEXION_TIMEOUT. */
 #define CONNEXION_TIMEOUT 5
 
-/* initial amount of sync/hanshake packets to send per second. */
+/* Initial amount of sync/hanshake packets to send per second. */
 #define SYNC_RATE         2
 
-/* initial send rate of data. */
+/* Initial send rate of data. */
 #define DATA_SYNC_RATE    30
 
 typedef struct {
@@ -57,27 +57,29 @@ typedef struct {
     IP_Port ip_port;
 
     /*
-     * 0 if connection is dead, 1 if attempting handshake,
-     * 2 if handshake is done (we start sending SYNC packets)
-     * 3 if we are sending SYNC packets and can send data
-     * 4 if the connection has timed out.
+     * return 0 if connection is dead.
+     * return 1 if attempting handshake.
+     * return 2 if handshake is done (we start sending SYNC packets).
+     * return 3 if we are sending SYNC packets and can send data.
+     * return 4 if the connection has timed out.
      */
     uint8_t status;
 
     /*
-     * 1 or 2 if connection was initiated by someone else, 0 if not.
-     * 2 if incoming_connection() has not returned it yet, 1 if it has.
+     * return 0 if connection was not initiated by someone else.
+     * return 1 if incoming_connection() has returned.
+     * return 2 if it has not.
      */
     uint8_t inbound;
 
-    uint16_t  SYNC_rate;     /* current SYNC packet send rate packets per second. */
-    uint16_t  data_rate;     /* current data packet send rate packets per second. */
+    uint16_t  SYNC_rate;     /* Current SYNC packet send rate packets per second. */
+    uint16_t  data_rate;     /* Current data packet send rate packets per second. */
 
-    uint64_t  last_SYNC;     /* time our last SYNC packet was sent. */
-    uint64_t  last_sent;     /* time our last data or handshake packet was sent. */
-    uint64_t  last_recvSYNC; /* time we last received a SYNC packet from the other */
-    uint64_t  last_recvdata; /* time we last received a DATA packet from the other */
-    uint64_t  killat;        /* time to kill the connection */
+    uint64_t  last_SYNC;     /* Time our last SYNC packet was sent. */
+    uint64_t  last_sent;     /* Time our last data or handshake packet was sent. */
+    uint64_t  last_recvSYNC; /* Time we last received a SYNC packet from the other. */
+    uint64_t  last_recvdata; /* Time we last received a DATA packet from the other. */
+    uint64_t  killat;        /* Time to kill the connection. */
 
     Data      sendbuffer[MAX_QUEUE_NUM]; /* packet send buffer. */
     Data      recvbuffer[MAX_QUEUE_NUM]; /* packet receive buffer. */
@@ -85,31 +87,31 @@ typedef struct {
     uint32_t  handshake_id1;
     uint32_t  handshake_id2;
 
-    /* number of data packets received (also used as handshake_id1) */
+    /* Number of data packets received (also used as handshake_id1). */
     uint32_t  recv_packetnum;
 
-    /* number of packets received by the other peer */
+    /* Number of packets received by the other peer. */
     uint32_t  orecv_packetnum;
 
-    /* number of data packets sent */
+    /* Number of data packets sent. */
     uint32_t  sent_packetnum;
 
-    /* number of packets sent by the other peer. */
+    /* Number of packets sent by the other peer. */
     uint32_t  osent_packetnum;
 
-    /* number of latest packet written onto the sendbuffer */
+    /* Number of latest packet written onto the sendbuffer. */
     uint32_t  sendbuff_packetnum;
 
-    /* we know all packets before that number were successfully sent */
+    /* We know all packets before that number were successfully sent. */
     uint32_t  successful_sent;
 
-    /* packet number of last packet read with the read_packet function */
+    /* Packet number of last packet read with the read_packet function. */
     uint32_t  successful_read;
 
-    /* list of currently requested packet numbers(by the other person) */
+    /* List of currently requested packet numbers(by the other person). */
     uint32_t  req_packets[BUFFER_PACKET_NUM];
 
-    /* total number of currently requested packets(by the other person) */
+    /* Total number of currently requested packets(by the other person). */
     uint16_t  num_req_paquets;
 
     uint8_t   recv_counter;
@@ -121,96 +123,94 @@ typedef struct {
     Networking_Core *net;
     Connection *connections;
 
-    uint32_t connections_length; /* Length of connections array */
-    uint32_t connections_number; /* Number of connections in connections array */
+    uint32_t connections_length; /* Length of connections array. */
+    uint32_t connections_number; /* Number of connections in connections array. */
 
-    /* table of random numbers used in handshake_id. */
+    /* Table of random numbers used in handshake_id. */
     uint32_t randtable[6][256];
 
 } Lossless_UDP;
 
 /*
- * Initialize a new connection to ip_port
- * Returns an integer corresponding to the connection id.
- * Return -1 if it could not initialize the connection.
- * Return number if there already was an existing connection to that ip_port.
+ * Initialize a new connection to ip_port.
+ * return an integer corresponding to the connection id.
+ * return -1 if it could not initialize the connection.
+ * return number if there already was an existing connection to that ip_port.
  */
 int new_connection(Lossless_UDP *ludp, IP_Port ip_port);
 
 /*
  * Get connection id from IP_Port.
- * Return -1 if there are no connections like we are looking for.
- * Return id if it found it .
+ * return -1 if there are no connections like we are looking for.
+ * return id if it found it .
  */
 int getconnection_id(Lossless_UDP *ludp, IP_Port ip_port);
 
 /*
- * Returns an int corresponding to the next connection in our imcoming connection list
- * Return -1 if there are no new incoming connections in the list.
+ * return an integer corresponding to the next connection in our imcoming connection list.
+ * return -1 if there are no new incoming connections in the list.
  */
 int incoming_connection(Lossless_UDP *ludp);
 
 /*
- * Return -1 if it could not kill the connection.
- * Return 0 if killed successfully
+ * return -1 if it could not kill the connection.
+ * return 0 if killed successfully.
  */
 int kill_connection(Lossless_UDP *ludp, int connection_id);
 
 /*
  * Kill connection in seconds seconds.
- * Return -1 if it can not kill the connection.
- * Return 0 if it will kill it
+ * return -1 if it can not kill the connection.
+ * return 0 if it will kill it.
  */
 int kill_connection_in(Lossless_UDP *ludp, int connection_id, uint32_t seconds);
 
 /*
- * Returns the ip_port of the corresponding connection.
- * Return 0 if there is no such connection.
+ * returns the ip_port of the corresponding connection.
+ * return 0 if there is no such connection.
  */
 IP_Port connection_ip(Lossless_UDP *ludp, int connection_id);
 
 /*
- * Returns the id of the next packet in the queue
- * Return -1 if no packet in queue
+ * returns the id of the next packet in the queue.
+ * return -1 if no packet in queue.
  */
 char id_packet(Lossless_UDP *ludp, int connection_id);
 
 /*
- * Return 0 if there is no received data in the buffer.
- * Return length of received packet if successful
+ * return 0 if there is no received data in the buffer.
+ * return length of received packet if successful.
  */
 int read_packet(Lossless_UDP *ludp, int connection_id, uint8_t *data);
 
 /*
- * Return 0 if data could not be put in packet queue
- * Return 1 if data was put into the queue
+ * return 0 if data could not be put in packet queue.
+ * return 1 if data was put into the queue.
  */
 int write_packet(Lossless_UDP *ludp, int connection_id, uint8_t *data, uint32_t length);
 
-/* Returns the number of packets in the queue waiting to be successfully sent. */
+/* returns the number of packets in the queue waiting to be successfully sent. */
 uint32_t sendqueue(Lossless_UDP *ludp, int connection_id);
 
 /*
- * returns the number of packets in the queue waiting to be successfully
- * read with read_packet(...)
+ * return the number of packets in the queue waiting to be successfully
+ * read with read_packet(...).
  */
 uint32_t recvqueue(Lossless_UDP *ludp, int connection_id);
 
 /* Check if connection is connected:
- * Return 0 no.
- * Return 1 if attempting handshake.
- * Return 2 if handshake is done.
- * Return 3 if fully connected.
- * Return 4 if timed out and wating to be killed.
+ * return 0 not.
+ * return 1 if attempting handshake.
+ * return 2 if handshake is done.
+ * return 3 if fully connected.
+ * return 4 if timed out and wating to be killed.
  */
 int is_connected(Lossless_UDP *ludp, int connection_id);
 
 /* Call this function a couple times per second It's the main loop. */
 void do_lossless_udp(Lossless_UDP *ludp);
 
-/*
- * This function sets up LosslessUDP packet handling.
- */
+/* This function sets up LosslessUDP packet handling. */
 Lossless_UDP *new_lossless_udp(Networking_Core *net);
 
 void kill_lossless_udp(Lossless_UDP *ludp);