From: Andre Noll <maan@systemlinux.org>
Date: Sun, 17 Feb 2008 13:14:10 +0000 (+0100)
Subject: Add documentation of struct sender status.
X-Git-Tag: v0.3.1~12
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=850873ce2feac4bf3736d92e8fa008ebde79affe;ds=sidebyside

Add documentation of struct sender status.
---

diff --git a/send.h b/send.h
index 8ec5e7ba..6550c701 100644
--- a/send.h
+++ b/send.h
@@ -104,16 +104,22 @@ struct sender_client {
 	void *private_data;
 };
 
+/** Describes the current status of one paraslash sender. */
 struct sender_status {
+	/* The file descriptor of the socket this sender is listening on. */
 	int listen_fd;
+	/** The TCP/DCCP port used by this sender. */
 	int port;
+	/** The current number of simultaneous connections. */
 	int num_clients;
+	/** The maximal number of simultaneous connections. */
 	int max_clients;
+	/** Whether the access control list is a whitelist. */
 	int default_deny;
-	/** The list of connected clients. */
-	struct list_head client_list;
 	/** The whitelist/blacklist. */
 	struct list_head acl;
+	/** The list of connected clients. */
+	struct list_head client_list;
 };
 
 void shutdown_client(struct sender_client *sc, struct sender_status *ss);