client_common.c: Trivial cosmetic cleanups.
authorAndre Noll <maan@systemlinux.org>
Sat, 22 Dec 2007 13:21:43 +0000 (14:21 +0100)
committerAndre Noll <maan@systemlinux.org>
Sat, 22 Dec 2007 13:21:43 +0000 (14:21 +0100)
client_common.c

index b9d61c5..78f9cb3 100644 (file)
@@ -4,7 +4,7 @@
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file client_common.c common functions of para_client and para_audiod */
+/** \file client_common.c Common functions of para_client and para_audiod. */
 
 #include <sys/types.h>
 #include <dirent.h>
 #include "client.h"
 
 /*
- * rc4 encrypt data before sending
+ * Rc4-encrypt data before sending.
  *
- * \param len the number of bytes to encrypt
- * \param indata pointer to the input data of length \a len to be encrypted
- * \param outdata pointer that holds the encrypted data after return
- * \param private_data pointer to the private client data containing
- * the rc4 key
- * */
+ * \param len The number of bytes to encrypt.
+ * \param indata Pointer to the input data of length \a len to be encrypted.
+ * \param outdata Result-pointer that holds the encrypted data.
+ * \param private_data Contains the rc4 key.
+ */
 static void rc4_send(unsigned long len, const unsigned char *indata,
                unsigned char *outdata, void *private_data)
 {
@@ -39,14 +38,10 @@ static void rc4_send(unsigned long len, const unsigned char *indata,
 }
 
 /*
- * rc4 decrypt received data
+ * Rc4-decrypt received data.
  *
- * \param len the number of bytes to decrypt
- * \param indata pointer to the input data of length \a len
- * \param outdata pointer that holds the decrypted data after return
- * \param private_data pointer to the private client data containing
- * the rc4 key
- * */
+ * Parameters are identical to those of rc4_send.
+ */
 static void rc4_recv(unsigned long len, const unsigned char *indata,
                unsigned char *outdata, void *private_data)
 {
@@ -55,12 +50,12 @@ static void rc4_recv(unsigned long len, const unsigned char *indata,
 }
 
 /**
- * close the connection to para_server and free all resources
+ * Close the connection to para_server and free all resources.
  *
- * \param pcd pointer to the client data
+ * \param pcd Pointer to the client data.
  *
  * \sa client_open.
- * */
+ */
 void client_close(struct private_client_data *pcd)
 {
        if (!pcd)
@@ -83,7 +78,7 @@ static int client_connect(struct private_client_data *pcd)
 
        pcd->fd = -1;
        ret = makesock(AF_UNSPEC, IPPROTO_TCP, 0, pcd->conf.hostname_arg,
-                                                 pcd->conf.server_port_arg);
+               pcd->conf.server_port_arg);
        if (ret < 0)
                return ret;
        pcd->fd = ret;
@@ -104,18 +99,18 @@ err_out:
 }
 
 /**
- * open connection to para_server
+ * Open connection to para_server.
  *
- * \param argc usual argument count
- * \param argv usual argument vector
- * \param pcd_ptr points to dynamically allocated and initialized private client data
- * upon successful return
+ * \param argc Usual argument count.
+ * \param argv Usual argument vector.
+ * \param pcd_ptr Points to dynamically allocated and initialized private client data
+ * upon successful return.
  *
  * Check the command line options given by \a argc and argv, set default values
  * for user name and rsa key file, read further option from the config file.
  * Finally, establish a connection to para_server.
  *
- * \return Positive on success, negative on errors.
+ * \return Standard.
  */
 int client_open(int argc, char *argv[], struct private_client_data **pcd_ptr)
 {
@@ -175,10 +170,10 @@ out:
 }
 
 /**
- * the preselect hook for server commands
+ * The preselect hook for server commands.
  *
- * \param s pointer to the scheduler
- * \param t pointer to the task struct for this command
+ * \param s Pointer to the scheduler.
+ * \param t Pointer to the task struct for this command.
  *
  * The task pointer must contain a pointer to the initialized client data
  * structure as it is returned by client_open().
@@ -186,7 +181,7 @@ out:
  * This function checks the state of the connection and adds the file descriptor
  * of the connection to the read or write fd set of \a s accordingly.
  *
- * \sa register_task() client_open(), struct sched, struct task
+ * \sa register_task() client_open(), struct sched, struct task.
  */
 void client_pre_select(struct sched *s, struct task *t)
 {
@@ -248,17 +243,17 @@ static ssize_t client_recv_buffer(struct private_client_data *pcd)
 }
 
 /**
- * the post select hook for client commands
+ * The post select hook for client commands.
  *
- * \param s pointer to the scheduler
- * \param t pointer to the task struct for this command
+ * \param s Pointer to the scheduler.
+ * \param t Pointer to the task struct for this command.
  *
  * Depending on the current state of the connection and the status of the read
  * and write fd sets of \a s, this function performs the necessary steps to
- * authenticate the connection, to send the command given by \a
- * t->private_data and to receive para_server's output, if any.
+ * authenticate the connection, to send the command given by \a t->private_data
+ * and to receive para_server's output, if any.
  *
- * \sa struct sched, struct task
+ * \sa struct sched, struct task.
  */
 void client_post_select(struct sched *s, struct task *t)
 {