stat_client_write(): add help text for new 'itemnum' parameter

diff --git a/stat.c b/stat.c
index 9b73fcd9c9ce6e2e4d8e4ef7c0319ab5906cd728..e3773df6403fb72d0c5163efa19c2f0ea43f7392 100644 (file)
--- a/stat.c
+++ b/stat.c
@@ -135,20 +135,22 @@ int stat_client_add(int fd, long unsigned mask)
        return 1;
 }
 /**
- * write a message to all connected stat 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
+ *
+ * On write errors, remove the status client from the client list and close its
+ * file descriptor.
  */
 void stat_client_write(char *msg, int itemnum)
 {
        struct stat_client *sc, *tmp;
-//     char *buf;
        ssize_t len;
        struct timeval tv = {0 , 0};
 
        if (!initialized)
                return;
-//     buf = make_message("%s\n", msg);
        len = strlen(msg);
        list_for_each_entry_safe(sc, tmp, &client_list, node) {
                int fd = sc->fd, ret;
@@ -177,7 +179,6 @@ void stat_client_write(char *msg, int itemnum)
                free(sc);
                dump_stat_client_list();
        }
-//     free(buf);
        PARA_DEBUG_LOG("%d client(s)\n", num_clients);
 }