add documentation of struct signal_task

and clean up documentation of struct stat_client as well.

diff --git a/audiod.c b/audiod.c
index e35c2ec700342c439ac53ec460c2ab34c4ca718d..66ef9c6ac3fb113f9d4e4720bf1002ace82aa46f 100644 (file)
--- a/audiod.c
+++ b/audiod.c
@@ -92,9 +92,15 @@ struct command_task {
        struct task task;
 };
 
        struct task task;
 };
 

+/**
+ * task for signal handling
+ */

 struct signal_task {
 struct signal_task {

+       /** the signal pipe */

        int fd;
        int fd;

+       /** the number of the most recent signal */

        int signum;
        int signum;

+       /** the associated task structure */

        struct task task;
 };
 
        struct task task;
 };
 

diff --git a/stat.c b/stat.c
index 39aab43ebd256a6de2e20015e4519ed98b77c761..33fdb8c1d0fec0596482820f447fb57c3754b003 100644 (file)
--- a/stat.c
+++ b/stat.c
@@ -31,25 +31,20 @@
 #define MAX_STAT_CLIENTS 50
 
 /**
 #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 {
  *
  * 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;
 };
 
 static struct list_head client_list;