net.c: Improve documentation of struct crypt_data.

[paraslash.git] / net.c

diff --git a/net.c b/net.c
index a9708fcb51bcb88f1bd58aa525f42c1a22f9625d..bc7d234bfa2ec01619d8bc698dfb2841053b0eca 100644 (file)
--- a/net.c
+++ b/net.c
@@ -12,21 +12,23 @@
 #include "error.h"
 
 
 #include "error.h"
 
 

-/** holds information about one encrypted connection */
+/** Information about one encrypted connection. */

 struct crypt_data {
 struct crypt_data {

-       /** function used to decrypt received data */
+       /** Function used to decrypt received data. */

        crypt_function *recv;
        crypt_function *recv;

-       /** function used to encrypt data to be sent */
+       /** Function used to encrypt data to be sent. */

        crypt_function *send;
        crypt_function *send;

-       /** context-dependent data, passed to \a recv() and \a send() */
+       /**
+        * Context-dependent data (crypt keys), passed verbatim to the above
+        * crypt functions.
+        */

        void *private_data;
 };
        void *private_data;
 };

-/** array holding per fd crypt data per */
+/** Array holding per fd crypt data. */

 static struct crypt_data *crypt_data_array;
 static struct crypt_data *crypt_data_array;

-/** current size of the crypt data array */
+/** Current size of the crypt data array. */

 static unsigned cda_size = 0;
 
 static unsigned cda_size = 0;
 

-

 /**
  * activate encryption for one file descriptor
  *
 /**
  * activate encryption for one file descriptor
  *