Doxify the sender_subcommand enum.

[paraslash.git] / send.h

diff --git a/send.h b/send.h
index 836babd50845088be08a2061fe39cc6ffd7760cb..f577c9a7153980dbbfc9cd84ab744843d92c5084 100644 (file)
--- a/send.h
+++ b/send.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2011 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2014 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -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.
@@ -146,7 +154,7 @@ struct fec_client_parms {
         */
        int (*init_fec)(struct sender_client *sc);
        /** Push out FEC-encoded packets */
-       int (*send_fec)(struct sender_client *sc, char *buf, size_t len);
+       void (*send_fec)(struct sender_client *sc, char *buf, size_t len);
 };
 
 /** Describes the current status of one paraslash sender. */