net.c: Improve documentation of struct crypt_data.
authorAndre Noll <maan@systemlinux.org>
Sun, 2 Sep 2007 15:12:11 +0000 (17:12 +0200)
committerAndre Noll <maan@systemlinux.org>
Sun, 2 Sep 2007 15:12:11 +0000 (17:12 +0200)
net.c

diff --git a/net.c b/net.c
index a9708fc..bc7d234 100644 (file)
--- a/net.c
+++ b/net.c
 #include "error.h"
 
 
-/** holds information about one encrypted connection */
+/** Information about one encrypted connection. */
 struct crypt_data {
-       /** function used to decrypt received data */
+       /** Function used to decrypt received data. */
        crypt_function *recv;
-       /** function used to encrypt data to be sent */
+       /** Function used to encrypt data to be sent. */
        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;
 };
-/** array holding per fd crypt data per */
+/** Array holding per fd crypt data. */
 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;
 
-
 /**
  * activate encryption for one file descriptor
  *