From de25f9d0d999b2a911ecc93d19511ff437211d18 Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Sun, 2 Sep 2007 17:12:11 +0200 Subject: [PATCH] net.c: Improve documentation of struct crypt_data. --- net.c | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/net.c b/net.c index a9708fcb..bc7d234b 100644 --- a/net.c +++ b/net.c @@ -12,21 +12,23 @@ #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 * -- 2.39.2