recv: Explain user data mechanism.

[paraslash.git] / recv_common.c

diff --git a/recv_common.c b/recv_common.c
index d48b3476f883bd9ca830aa97bc92dc0112433341..1ad84438026ce8f724ddf8d1fba8547a96276fb6 100644 (file)
--- a/recv_common.c
+++ b/recv_common.c
@@ -21,6 +21,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)
 {