From: Andre Noll <maan@systemlinux.org>
Date: Tue, 20 Sep 2011 20:27:18 +0000 (+0200)
Subject: recv: Improve documentation of generic_recv_pre_select().
X-Git-Tag: v0.4.9~25
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=f60bda0c58218b9c5a617e82c2dcdd7c2f203fb5;p=paraslash.git

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 f38184b4..53a105df 100644
--- 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)
 {