Minor documentation improvements.

[paraslash.git] / send_common.c

diff --git a/send_common.c b/send_common.c
index c0098b98a833f0cae309aba11a43bec1c2c7d1a6..3d87008850a8ab3c39b3f1711d5aca1b2e2f3a45 100644 (file)
--- a/send_common.c
+++ b/send_common.c
@@ -62,6 +62,8 @@ static int open_sender(unsigned l4type, int port)
  * Close the file descriptor given by \a sc, remove it from the close-on-fork
  * list, destroy the chunk queue of this client, delete the client from the
  * list of connected clients and free the sender_client struct.
  * Close the file descriptor given by \a sc, remove it from the close-on-fork
  * list, destroy the chunk queue of this client, delete the client from the
  * list of connected clients and free the sender_client struct.

+ *
+ * \sa shutdown_clients().

  */
 void shutdown_client(struct sender_client *sc, struct sender_status *ss)
 {
  */
 void shutdown_client(struct sender_client *sc, struct sender_status *ss)
 {


@@ -76,6 +78,14 @@ void shutdown_client(struct sender_client *sc, struct sender_status *ss)
        ss->num_clients--;
 }
 
        ss->num_clients--;
 }
 

+/**
+ * Shut down all clients connected to a paraslash sender.
+ *
+ * \param ss The sender whose clients are to be shut down.
+ *
+ * This just loops over all connected clients and calls shutdown_client()
+ * for each client.
+ */

 void shutdown_clients(struct sender_status *ss)
 {
        struct sender_client *sc, *tmp;
 void shutdown_clients(struct sender_status *ss)
 {
        struct sender_client *sc, *tmp;