Consolidate receiver/filter/writer {pre,post}_select() docs.

[paraslash.git] / recv_common.c

diff --git a/recv_common.c b/recv_common.c
index 31fd81f1ec52c3d0b6204e8b3663a7d36e14fbb3..169a49675044d6c63b2b872ee8ba1a94aff9c55d 100644 (file)
--- a/recv_common.c
+++ b/recv_common.c
@@ -98,17 +98,17 @@ void print_receiver_helps(bool detailed)
 }
 
 /**
- * Simple pre-select hook, used by all receivers.
+ * Request a minimal timeout in case of buffer tree errors.
  *
- * \param s Scheduler info.
- * \param rn The receiver node.
+ * \param s The scheduler instance.
+ * \param rn The buffer tree node is derived from this.
  *
- * This requests a minimal delay from the scheduler if the status of the buffer
- * tree node indicates an error/eof condition. No file descriptors are added to
- * the fd sets of \a s.
+ * If the buffer tree node of the given receiver node is in error or EOF state,
+ * a minimal I/O timeout is requested from the scheduler. Otherwise, the
+ * function does nothing. No file descriptors are asked to be monitored.
  *
- * \return The status of the btr node of the receiver node, i.e. the return
- * value of the underlying call to \ref btr_node_status().
+ * \return The status of of the receiver node's buffer tree node. That is, the
+ * return value of the underlying call to \ref btr_node_status().
  */
 int generic_recv_pre_select(struct sched *s, struct receiver_node *rn)
 {