recv: Improve documentation of generic_recv_pre_select().
authorAndre Noll <maan@systemlinux.org>
Tue, 20 Sep 2011 20:27:18 +0000 (22:27 +0200)
committerAndre Noll <maan@systemlinux.org>
Tue, 20 Sep 2011 20:27:18 +0000 (22:27 +0200)
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.

recv_common.c

index f38184b..53a105d 100644 (file)
@@ -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)
 {