Doxify the sender_subcommand enum.
authorAndre Noll <maan@systemlinux.org>
Sun, 13 Apr 2014 23:19:26 +0000 (23:19 +0000)
committerAndre Noll <maan@systemlinux.org>
Thu, 14 Aug 2014 06:35:41 +0000 (08:35 +0200)
This adds comments to all sender commands and switches to a named enum.

send.h

diff --git a/send.h b/send.h
index 8a69cb7..f577c9a 100644 (file)
--- 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.