From: Andre Noll <maan@systemlinux.org>
Date: Sat, 17 Nov 2007 17:09:52 +0000 (+0100)
Subject: stat.c: Cosmetics.
X-Git-Tag: v0.3.0~113^2~11
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=d013a58cb2f7ed1a36b666a7ca1f9406a92d04bd;p=paraslash.git

stat.c: Cosmetics.
---

diff --git a/stat.c b/stat.c
index 59ac4235..89a1f49b 100644
--- a/stat.c
+++ b/stat.c
@@ -5,8 +5,8 @@
  */
 
 /**
- *  \file stat.c functions used for sending/receiving the status of para_server
- *  and para_audiod
+ *  \file stat.c Functions used for sending/receiving the status of para_server
+ *  and para_audiod.
  */
 
 
@@ -20,11 +20,11 @@
 #include "string.h"
 #include "fd.h"
 
-/** the maximal number of simultaneous connections */
+/** The maximal number of simultaneous connections. */
 #define MAX_STAT_CLIENTS 50
 
 /**
- * describes a status client of para_audiod
+ * Describes a status client of para_audiod.
  *
  * There's one such structure per audiod client that sent the 'stat' command.
  *
@@ -32,11 +32,11 @@
  * keeps a list of connected status clients.
  */
 struct stat_client {
-	/** the stat client's file descriptor */
+	/** The stat client's file descriptor. */
 	int fd;
-	/** bitmask of those status items the client is interested in */
+	/** Bitmask of those status items the client is interested in. */
 	long unsigned item_mask;
-	/** its entry in the list of stat clients */
+	/** Its entry in the list of stat clients. */
 	struct list_head node;
 };
 
@@ -57,10 +57,10 @@ static void dump_stat_client_list(void)
 		PARA_INFO_LOG("stat client on fd %d\n", sc->fd);
 }
 /**
- * add a status client to the list
+ * Add a status client to the list.
  *
- * \param fd the file descriptor of the client
- * \param mask bitfield of status items for this client
+ * \param fd The file descriptor of the client.
+ * \param mask Bitfield of status items for this client.
  *
  * Only those status items having the bit set in \a mask will be
  * sent to the client.
@@ -91,10 +91,10 @@ int stat_client_add(int fd, long unsigned mask)
 	return 1;
 }
 /**
- * write a message to all connected status clients
+ * Write a message to all connected status clients.
  *
- * \param msg a \p NULL terminated buffer
- * \param itemnum The number of the status item of \a msg
+ * \param msg A \p NULL terminated buffer.
+ * \param itemnum The number of the status item of \a msg.
  *
  * On write errors, remove the status client from the client list and close its
  * file descriptor.
@@ -115,12 +115,11 @@ void stat_client_write(const char *msg, int itemnum)
 			continue;
 		FD_ZERO(&wfds);
 		FD_SET(fd, &wfds);
-//		PARA_DEBUG_LOG("%s: p=%lx\n", __func__, (long)p);
 		ret = para_select(fd + 1, NULL, &wfds, &tv);
 		if (ret > 0) {
 			ret = write(fd, msg, len);
 			PARA_DEBUG_LOG("dumped %s to fd %d, ret = %d\n", msg, fd, ret);
-			if (ret == len )
+			if (ret == len)
 				continue;
 		}
 		/* write error or fd not ready for writing */
@@ -135,9 +134,9 @@ void stat_client_write(const char *msg, int itemnum)
 }
 
 /**
- * check if string is a known status item.
+ * Check if string is a known status item.
  *
- * \param item buffer containing the text to check
+ * \param item Buffer containing the text to check.
  *
  * \return If \a item is a valid status item, the number of that status item is
  * returned. Otherwise, this function returns \p -E_UNKNOWN_STAT_ITEM.
@@ -157,9 +156,9 @@ int stat_item_valid(const char *item)
 }
 
 /**
- * check if line starts with known status item.
+ * Check if line starts with known status item.
  *
- * \param line buffer containing the line
+ * \param line Buffer containing the line.
  *
  * \return If the beginning of \a line matches any paraslash status item and is
  * followed by a colon, the number of that status item is returned. Otherwise,