command_util: Generate properly documented command header files.

[paraslash.git] / recv.h

diff --git a/recv.h b/recv.h
index f8b1529236b143f95dfa4882acbb2c29e7eeb88f..dc49ef956e69779f518ad235c6c25e76b1761498 100644 (file)
--- a/recv.h
+++ b/recv.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2008 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2009 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -29,7 +29,7 @@ struct receiver_node {
 /**
  * Describes one supported paraslash receiver.
  *
- * \sa http_recv.c, ortp_recv.c
+ * \sa http_recv.c, udp_recv.c
  */
 struct receiver {
        /**
@@ -41,7 +41,7 @@ struct receiver {
         *
         * It must fill in all other function pointers and is assumed to succeed.
         *
-        * \sa http_recv_init ortp_recv_init.
+        * \sa http_recv_init udp_recv_init.
         */
        void (*init)(struct receiver *r);
        /**
@@ -105,6 +105,7 @@ struct receiver {
         */
        void (*post_select)(struct sched *s, struct task *t);
 
+       /** The two help texts of this receiver. */
        struct ggo_help help;
 };
 
@@ -114,13 +115,8 @@ extern void http_recv_init(struct receiver *r);
 #define HTTP_RECEIVER {.name = "http", .init = http_recv_init},
 extern void dccp_recv_init(struct receiver *r);
 #define DCCP_RECEIVER {.name = "dccp", .init = dccp_recv_init},
-
-#ifdef HAVE_ORTP
-extern void ortp_recv_init(struct receiver *r);
-#define ORTP_RECEIVER {.name = "ortp", .init = ortp_recv_init},
-#else
-#define ORTP_RECEIVER
-#endif
+extern void udp_recv_init(struct receiver *r);
+#define UDP_RECEIVER {.name = "udp", .init = udp_recv_init},
 
 extern struct receiver receivers[];
 /** \endcond */
@@ -129,9 +125,12 @@ extern struct receiver receivers[];
 #define DEFINE_RECEIVER_ARRAY struct receiver receivers[] = { \
        HTTP_RECEIVER \
        DCCP_RECEIVER \
-       ORTP_RECEIVER \
+       UDP_RECEIVER \
        {.name = NULL}};
 
+/** Iterate over all available receivers. */
 #define FOR_EACH_RECEIVER(i) for (i = 0; receivers[i].name; i++)
 
+void recv_init(void);
 void *check_receiver_arg(char *ra, int *receiver_num);
+void print_receiver_helps(int detailed);