net.c: Cosmetics.
authorAndre Noll <maan@systemlinux.org>
Sun, 25 Nov 2007 11:25:37 +0000 (12:25 +0100)
committerAndre Noll <maan@systemlinux.org>
Sun, 25 Nov 2007 11:25:37 +0000 (12:25 +0100)
net.c

diff --git a/net.c b/net.c
index 733f738..56edb8e 100644 (file)
--- a/net.c
+++ b/net.c
@@ -4,7 +4,7 @@
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file net.c networking-related helper functions */
+/** \file net.c Networking-related helper functions. */
 
 #include "para.h"
 #include "error.h"
@@ -30,12 +30,12 @@ static struct crypt_data *crypt_data_array;
 static unsigned cda_size = 0;
 
 /**
- * activate encryption for one file descriptor
+ * Activate encryption for one file descriptor.
  *
- * \param fd the file descriptor
- * \param recv_f the function used for decrypting received data
- * \param send_f the function used for encrypting before sending
- * \param private_data user data supplied by the caller
+ * \param fd The file descriptor.
+ * \param recv_f The function used for decrypting received data.
+ * \param send_f The function used for encrypting before sending.
+ * \param private_data User data supplied by the caller.
  */
 void enable_crypt(int fd, crypt_function *recv_f, crypt_function *send_f,
        void *private_data)
@@ -54,9 +54,9 @@ void enable_crypt(int fd, crypt_function *recv_f, crypt_function *send_f,
 }
 
 /**
- * deactivate encryption for a given fd
+ * Deactivate encryption for a given fd.
  *
- * \param fd the file descriptor
+ * \param fd The file descriptor.
  *
  * This must be called if and only if \p fd was activated via enable_crypt().
  */
@@ -71,11 +71,11 @@ void disable_crypt(int fd)
 
 
 /**
- * initialize a struct sockaddr_in
+ * Initialize a struct sockaddr_in.
  *
- * \param addr A pointer to the struct to be initialized
- * \param port The port number to use
- * \param he The address to use
+ * \param addr A pointer to the struct to be initialized.
+ * \param port The port number to use.
+ * \param he The address to use.
  *
  * If \a he is null (server mode), \a addr->sin_addr is initialized with \p
  * INADDR_ANY.  Otherwise, the address given by \a he is copied to addr.
@@ -189,11 +189,11 @@ __printf_2_3 int send_va_buffer(int fd, const char *fmt, ...)
 }
 
 /**
- * receive and decrypt.
+ * Receive and decrypt.
  *
- * \param fd the file descriptor
- * \param buf the buffer to write the decrypted data to
- * \param size the size of \a buf
+ * \param fd The file descriptor.
+ * \param buf The buffer to write the decrypted data to.
+ * \param size The size of \a buf.
  *
  * Receive at most \a size bytes from file descriptor \a fd. If encryption is
  * available, decrypt the received buffer.
@@ -227,16 +227,16 @@ __must_check int recv_bin_buffer(int fd, char *buf, size_t size)
 }
 
 /**
- * receive, decrypt and write terminating NULL byte
+ * Receive, decrypt and write terminating NULL byte.
  *
- * \param fd the file descriptor
- * \param buf the buffer to write the decrypted data to
- * \param size the size of \a buf
+ * \param fd The file descriptor.
+ * \param buf The buffer to write the decrypted data to.
+ * \param size The size of \a buf.
  *
  * Read and decrypt at most \a size - 1 bytes from file descriptor \a fd and
  * write a NULL byte at the end of the received data.
  *
- * \return: The return value of the underlying call to \a recv_bin_buffer().
+ * \return The return value of the underlying call to \a recv_bin_buffer().
  *
  * \sa recv_bin_buffer()
  */
@@ -403,7 +403,7 @@ int recv_cred_buffer(int fd, char *buf, size_t size)
  * \param buf the buffer to be sent
  *
  * \return On success, this call returns the number of characters sent.  On
- * error, \p -E_SENDMSG ist returned.
+ * error, \p -E_SENDMSG is returned.
  *
  * \sa  okir's Black Hats Manual
  * \sa sendmsg(2)