add documentation of struct signal_task
authorAndre <maan@p133.(none)>
Thu, 15 Jun 2006 15:16:41 +0000 (17:16 +0200)
committerAndre <maan@p133.(none)>
Thu, 15 Jun 2006 15:16:41 +0000 (17:16 +0200)
and clean up documentation of struct stat_client as well.

audiod.c
stat.c

index e35c2ec..66ef9c6 100644 (file)
--- 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 39aab43..33fdb8c 100644 (file)
--- a/stat.c
+++ b/stat.c
 #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;