doxygen: Add \ref to references.

[paraslash.git] / recv.h

diff --git a/recv.h b/recv.h
index 68978a38c90f2dada11f21d0b55b8a078e4b4bef..f1e2fc4563735a67f149bdc69d1bbf7f526497d6 100644 (file)
--- a/recv.h
+++ b/recv.h
@@ -40,15 +40,13 @@ struct receiver_node {
 /**
  * Describes one supported paraslash receiver.
  *
- * \sa http_recv.c, udp_recv.c
+ * \sa \ref http_recv.c, \ref udp_recv.c.
  */
 struct receiver {
        /**
         * The optional receiver init function.
         *
         * Performs any initialization needed before the receiver can be opened.
-        *
-        * \sa http_recv_init udp_recv_init.
         */
        void (*init)(void);
        /**
@@ -60,7 +58,7 @@ struct receiver {
         * guaranteed to point to valid configuration data (as previously
         * obtained from the config parser).
         *
-        * \sa receiver_node::conf, receiver_node::buf.
+        * \sa struct \ref receiver_node.
         */
        int (*open)(struct receiver_node *rn);
        /**
@@ -69,7 +67,7 @@ struct receiver {
         * It should free all resources associated with given receiver node
         * that were allocated during the corresponding open call.
         *
-        * \sa receiver_node.
+        * \sa \ref receiver_node.
         */
        void (*close)(struct receiver_node *rn);
        /**
@@ -80,7 +78,7 @@ struct receiver {
         * add any file descriptors to the sets of file descriptors given by \a
         * s.
         *
-        * \sa select(2), time.c struct task, struct sched.
+        * \sa select(2), \ref time.c, struct \ref sched.
         */
        void (*pre_select)(struct sched *s, void *context);
        /**
@@ -92,7 +90,7 @@ struct receiver {
         * then use any non-blocking I/O to establish a connection or to
         * receive the audio data.
         *
-        * \sa select(2), struct receiver.
+        * \sa select(2), struct \ref receiver.
         */
        int (*post_select)(struct sched *s, void *context);