afs: Document ->lpr of struct afs_callback_arg.

[paraslash.git] / recv_common.c

diff --git a/recv_common.c b/recv_common.c
index 7bb775fe214af8880bc1244743760b59a2188e46..948de4745dda8c62bce88f31ec8362650ae85de0 100644 (file)
--- a/recv_common.c
+++ b/recv_common.c
@@ -1,8 +1,4 @@
-/*
- * Copyright (C) 2006 Andre Noll <maan@tuebingen.mpg.de>
- *
- * Licensed under the GPL v2. For licencing details see COPYING.
- */
+/* Copyright (C) 2006 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
 
 /** \file recv_common.c common functions of para_recv and para_audiod */
 
@@ -21,6 +17,12 @@
 
 /**
  * Call the init function of each paraslash receiver.
+ *
+ * Receivers employ the user_data feature of the lopsub library: Each receiver
+ * of the recv_cmd suite defines a struct receiver as its user data.
+ * recv_init() obtains a pointer to this structure by calling lls_user_data().
+ * If the receiver has an init function (i.e., if ->init is not NULL), ->init()
+ * is called to initialize the receiver.
  */
 void recv_init(void)
 {
@@ -37,7 +39,7 @@ void recv_init(void)
 /**
  * Check if the given string is a valid receiver specifier.
  *
- * \param \ra string of the form receiver_name [options...]
+ * \param ra string of the form receiver_name [options...]
  * \param lprp Filled in on success, undefined else.
  *
  * This function checks whether \a ra starts with the name of a receiver,