recv: Improve documentation of generic_recv_pre_select().

Make it clear that this function returns the state of the given buffer
tree node, i.e. > 0 on success, == 0 if there is nothing to do and <
0 on errors.

diff --git a/recv_common.c b/recv_common.c
index f38184b4484b3db6f263ac76b2c39e42adaa86c9..53a105dfb107e2feab388fbe29729fa210e6306a 100644 (file)
--- a/recv_common.c
+++ b/recv_common.c
@@ -133,7 +133,8 @@ void print_receiver_helps(int detailed)
  * tree node indicates an error/eof condition. No file descriptors are added to
  * the fd sets of \a s.
  *
- * \return Standard.
+ * \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().
  */
 int generic_recv_pre_select(struct sched *s, struct task *t)
 {