From 7050cf4ed059227268e964604ca1c6597c856167 Mon Sep 17 00:00:00 2001
From: Andre <maan@p133.(none)>
Date: Thu, 15 Jun 2006 17:16:41 +0200
Subject: [PATCH] add documentation of struct signal_task

and clean up documentation of struct stat_client as well.
---
 audiod.c |  6 ++++++
 stat.c   | 23 +++++++++--------------
 2 files changed, 15 insertions(+), 14 deletions(-)

diff --git a/audiod.c b/audiod.c
index e35c2ec7..66ef9c6a 100644
--- a/audiod.c
+++ b/audiod.c
@@ -92,9 +92,15 @@ struct command_task {
 	struct task task;
 };
 
+/**
+ * task for signal handling
+ */
 struct signal_task {
+	/** the signal pipe */
 	int fd;
+	/** the number of the most recent signal */
 	int signum;
+	/** the associated task structure */
 	struct task task;
 };
 
diff --git a/stat.c b/stat.c
index 39aab43e..33fdb8c1 100644
--- a/stat.c
+++ b/stat.c
@@ -31,25 +31,20 @@
 #define MAX_STAT_CLIENTS 50
 
 /**
- * The structure associated with a connected client that sent the 'stat' command
-*
+ * describes a status client of para_audiod
+ *
+ * There's one such structure per audiod client that sent the 'stat' command.
  *
  * A status client is identified by its file descriptor.  para_audiod
  * keeps a list of connected status clients.
  */
 struct stat_client {
-/**
- *
- *
- * the stat client's file descriptor
- */
-int fd;
-long unsigned item_mask;
-/**
- *
- * its entry in the list of stat clients
-*/
-struct list_head node;
+	/** the stat client's file descriptor */
+	int fd;
+	/** bitmask of those status items the client is interested in */
+	long unsigned item_mask;
+	/** its entry in the list of stat clients */
+	struct list_head node;
 };
 
 static struct list_head client_list;
-- 
2.39.5