From: Andre Noll <maan@systemlinux.org>
Date: Sun, 13 Apr 2014 23:19:26 +0000 (+0000)
Subject: Doxify the sender_subcommand enum.
X-Git-Tag: v0.5.4~50^2~2
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=ece0cc264ef6551c2064489757c0efbe6d60aa97

Doxify the sender_subcommand enum.

This adds comments to all sender commands and switches to a named enum.
---

diff --git a/send.h b/send.h
index 8a69cb71..f577c9a7 100644
--- a/send.h
+++ b/send.h
@@ -7,7 +7,15 @@
 /** \file send.h Sender-related defines and structures. */
 
 /** The sender subcommands. */
-enum {SENDER_ADD, SENDER_DELETE, SENDER_ALLOW, SENDER_DENY, SENDER_ON, SENDER_OFF, NUM_SENDER_CMDS};
+enum sender_subcommand {
+	SENDER_ADD, /**< Add a target (udp only). */
+	SENDER_DELETE, /**< Delete a target (udp only). */
+	SENDER_ALLOW, /**< Allow connections from given IP address(es). */
+	SENDER_DENY, /**< Deny connections from given IP address(es). */
+	SENDER_ON, /**< Activate the sender. */
+	SENDER_OFF, /**< Deactivate the sender. */
+	NUM_SENDER_CMDS /**< Used as array size in struct \ref sender. */
+};
 
 /**
  * Describes one supported sender of para_server.